mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
change dynamicform.md for applying docs.js
This commit is contained in:
parent
e23445584f
commit
2bf04c5f8c
1 changed files with 136 additions and 0 deletions
136
docs/manual/dynamicform.md
Normal file
136
docs/manual/dynamicform.md
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Dynamic Form"
|
||||
description: ""
|
||||
group: manual
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
## 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
|
||||
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input.png" />
|
||||
|
||||
|
||||
Also you can provide default value, using _${formName=defaultValue}_.
|
||||
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_default.png" />
|
||||
|
||||
|
||||
#### Select form
|
||||
|
||||
To create select form, use _${formName=defaultValue,option1|option2...}_
|
||||
|
||||
for example
|
||||
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select.png" />
|
||||
|
||||
Also you can separate option's display name and value, using _${formName=defaultValue,option1(DisplayName)|option2(DisplayName)...}_
|
||||
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select_displayname.png" />
|
||||
|
||||
### Creates Programmatically
|
||||
|
||||
Some language backend uses programmatic way to create form. For example [ZeppelinContext](../interpreter/spark.html#zeppelincontext) provides form creation API
|
||||
|
||||
Here're some examples.
|
||||
|
||||
####Text input form
|
||||
<div class="codetabs">
|
||||
<div data-lang="scala" markdown="1">
|
||||
|
||||
{% 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>
|
||||
</div>
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_prog.png" />
|
||||
|
||||
####Text input form with default value
|
||||
<div class="codetabs">
|
||||
<div data-lang="scala" markdown="1">
|
||||
|
||||
{% 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>
|
||||
</div>
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_default_prog.png" />
|
||||
|
||||
####Select form
|
||||
<div class="codetabs">
|
||||
<div data-lang="scala" markdown="1">
|
||||
|
||||
{% 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>
|
||||
</div>
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select_prog.png" />
|
||||
Loading…
Reference in a new issue