Dynamic Form

Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form. Custom language backend can select which type of form creation it wants to use.

Using form Templates

This mode creates form using simple template language. It's simple and easy to use. For example Markdown, Shell, SparkSql language backend uses it.

Text input form

To create text input form, use ${formName} templates.

for example

Also you can provide default value, using ${formName=defaultValue}.

Select form

To create select form, use ${formName=defaultValue,option1|option2...}

for example

Also you can separate option's display name and value, using ${formName=defaultValue,option1(DisplayName)|option2(DisplayName)...}

Creates Programmatically

Some language backend uses programmatic way to create form. For example ZeppelinContext provides form creation API

Here're some examples.

Text input form

You can do this in Scala

%spark
println("Hello "+z.input("name"))

Or Python

%pyspark
print("Hello "+z.input("name"))

Text input form with default value

Scala

%spark
println("Hello "+z.input("name", "sun"))

Python

%pyspark
print("Hello "+z.input("name", "sun"))

Select form

Scala

%spark
println("Hello "+z.select("day", Seq(("1","mon"),
                                    ("2","tue"),
                                    ("3","wed"),
                                    ("4","thurs"),
                                    ("5","fri"),
                                    ("6","sat"),
                                    ("7","sun"))))

Python

%pyspark
print("Hello "+z.select("day", [("1","mon"),
                                ("2","tue"),
                                ("3","wed"),
                                ("4","thurs"),
                                ("5","fri"),
                                ("6","sat"),
                                ("7","sun")]))