zeppelin/docs/manual/dynamicform.md

layout	title	description	group
page	Dynamic Form in Apache Zeppelin	Apache Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form.	manual

{% include JB/setup %}

Dynamic Form

Apache 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, Spark SQL 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)...}

Checkbox form

For multi-selection, you can create a checkbox form using ${checkbox:formName=defaultValue1|defaultValue2...,option1|option2...}. The variable will be substituted by a comma-separated string based on the selected items. For example:

Besides, you can specify the delimiter using ${checkbox(delimiter):formName=...}:

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

{% highlight scala %} %spark println("Hello "+z.input("name")) {% endhighlight %}

</div>
<div data-lang="python" markdown="1">

{% highlight python %} %pyspark print("Hello "+z.input("name")) {% endhighlight %}

</div>

Text input form with default value

{% highlight scala %} %spark println("Hello "+z.input("name", "sun")) {% endhighlight %}

</div>
<div data-lang="python" markdown="1">

{% highlight python %} %pyspark print("Hello "+z.input("name", "sun")) {% endhighlight %}

</div>

Select form

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

</div>
<div data-lang="python" markdown="1">

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

</div>

Checkbox form

{% highlight scala %} %spark val options = Seq(("apple","Apple"), ("banana","Banana"), ("orange","Orange")) println("Hello "+z.checkbox("fruit", options).mkString(" and ")) {% endhighlight %}

</div>
<div data-lang="python" markdown="1">

{% highlight python %} %pyspark options = [("apple","Apple"), ("banana","Banana"), ("orange","Orange")] print("Hello "+ " and ".join(z.checkbox("fruit", options, ["apple"]))) {% endhighlight %}

</div>