|
@@ -10,9 +10,39 @@
|
|
{
|
|
{
|
|
"name": "value",
|
|
"name": "value",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(Scenario)",
|
|
|
|
|
|
+ "type": "dynamic(Union[Scenario, list[Scenario]])",
|
|
"doc": "Bound to the selected <code>Scenario^</code>, or None if there is none."
|
|
"doc": "Bound to the selected <code>Scenario^</code>, or None if there is none."
|
|
},
|
|
},
|
|
|
|
+ {
|
|
|
|
+ "name": "scenarios",
|
|
|
|
+ "type": "dynamic(list[Union[Scenario,Cycle]])",
|
|
|
|
+ "default_value": "None",
|
|
|
|
+ "doc": "The list of <code>Cycle^</code> or <code>Scenario^</code> objects to show.<br/>If this is None, all Cycles and Scenarios are listed."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "multiple",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "False",
|
|
|
|
+ "doc": "If True, the user can select multiple scenarios, therefore the <i>value</i> property can hold a list of <code>Scenario^</code> objects."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "filter",
|
|
|
|
+ "type": "Union[bool,str,taipy.gui_core.filters.ScenarioFilter,list[Union[str,taipy.gui_core.filters.ScenarioFilter]]]",
|
|
|
|
+ "default_value": "\"*\"",
|
|
|
|
+ "doc": "One or multiple <code>Scenario^</code> property names to filter on.<br/>If False, do not allow filter."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "show_search",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "True",
|
|
|
|
+ "doc": "If False, prevents users from searching for scenarios by label."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "sort",
|
|
|
|
+ "type": "Union[bool,str,taipy.gui_core.filters.ScenarioFilter,list[Union[str,taipy.gui_core.filters.ScenarioFilter]]]",
|
|
|
|
+ "default_value": "\"*\"",
|
|
|
|
+ "doc": "A list of <code>Scenario^</code> property names to sort on.<br/>If False, do not allow sort."
|
|
|
|
+ },
|
|
{
|
|
{
|
|
"name": "show_add_button",
|
|
"name": "show_add_button",
|
|
"type": "bool",
|
|
"type": "bool",
|
|
@@ -31,6 +61,12 @@
|
|
"default_value": "True",
|
|
"default_value": "True",
|
|
"doc": "If False, the primary scenarios are not identified with specific visual hint."
|
|
"doc": "If False, the primary scenarios are not identified with specific visual hint."
|
|
},
|
|
},
|
|
|
|
+ {
|
|
|
|
+ "name": "show_pins",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "False",
|
|
|
|
+ "doc": "If True, a pin is shown on each item of the selector and allows to restrict the number of displayed items."
|
|
|
|
+ },
|
|
{
|
|
{
|
|
"name": "on_change",
|
|
"name": "on_change",
|
|
"type": "Union[str, Callable]",
|
|
"type": "Union[str, Callable]",
|
|
@@ -51,21 +87,15 @@
|
|
]
|
|
]
|
|
},
|
|
},
|
|
{
|
|
{
|
|
- "name": "height",
|
|
|
|
- "type": "str",
|
|
|
|
- "default_value": "\"50vh\"",
|
|
|
|
- "doc": "The maximum height, in CSS units, of the control."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "show_pins",
|
|
|
|
|
|
+ "name": "show_dialog",
|
|
"type": "bool",
|
|
"type": "bool",
|
|
- "default_value": "False",
|
|
|
|
- "doc": "If True, a pin is shown on each item of the selector and allows to restrict the number of displayed items."
|
|
|
|
|
|
+ "default_value": "True",
|
|
|
|
+ "doc": "If True, a dialog is shown when the user click on the 'Add scenario' button."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
"name": "on_creation",
|
|
"name": "on_creation",
|
|
"type": "Union[str, Callable]",
|
|
"type": "Union[str, Callable]",
|
|
- "doc": "A function or the name of a function that is triggered when a scenario is about to be created.<br/><br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (str): the identifier of this scenario selector.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>config (str): the name of the selected scenario configuration.</li>\n<li>date (datetime): the creation date for the new scenario.</li>\n<li>label (str): the user-specified label.</li>\n<li>properties (dic): a dictionary containing all the user-defined custom properties.</li>\n</ul>\n</li>\n<li>The callback function can return a scenario, a string containing an error message (a scenario will not be created), or None (then a new scenario is created with the user parameters).</li>\n</ul>",
|
|
|
|
|
|
+ "doc": "A function or the name of a function that is triggered when a scenario is about to be created.<br/><br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (str): the identifier of this scenario selector.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>config (str): the name of the selected scenario configuration.</li>\n<li>date (datetime): the creation date for the new scenario.</li>\n<li>label (str): the user-specified label.</li>\n<li>properties (dict): a dictionary containing all the user-defined custom properties.</li>\n</ul>\n</li>\n<li>The callback function can return a scenario, a string containing an error message (a scenario will not be created), or None (then a new scenario is created with the user parameters).</li>\n</ul>",
|
|
"signature": [
|
|
"signature": [
|
|
[
|
|
[
|
|
"state",
|
|
"state",
|
|
@@ -82,39 +112,10 @@
|
|
]
|
|
]
|
|
},
|
|
},
|
|
{
|
|
{
|
|
- "name": "show_dialog",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "True",
|
|
|
|
- "doc": "If True, a dialog is shown when the user click on the 'Add scenario' button."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "scenarios",
|
|
|
|
- "type": "dynamic(list[Scenario|Cycle])",
|
|
|
|
- "doc": "TODO: The list of <code>Scenario^</code>/<code>Cycle^</code> to show. Shows all Cycle/Scenario if value is None."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "multiple",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "False",
|
|
|
|
- "doc": "TODO: If True, the user can select multiple scenarios."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "filter",
|
|
|
|
- "type": "bool|str|taipy.gui_core.filters.ScenarioFilter|list[str|taipy.gui_core.filters.ScenarioFilter]",
|
|
|
|
- "default_value": "\"*\"",
|
|
|
|
- "doc": "TODO: a list of <code>Scenario^</code> attributes to filter on. If False, do not allow filter."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "show_search",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "True",
|
|
|
|
- "doc": "TODO: If True, allows the user to search locally on label."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "sort",
|
|
|
|
- "type": "bool|str|taipy.gui_core.filters.ScenarioFilter|list[str|taipy.gui_core.filters.ScenarioFilter]",
|
|
|
|
- "default_value": "\"*\"",
|
|
|
|
- "doc": "TODO: a list of <code>Scenario^</code> attributes to sort on. If False, do not allow sort."
|
|
|
|
|
|
+ "name": "height",
|
|
|
|
+ "type": "str",
|
|
|
|
+ "default_value": "\"50vh\"",
|
|
|
|
+ "doc": "The maximum height, in CSS units, of the control."
|
|
}
|
|
}
|
|
]
|
|
]
|
|
}
|
|
}
|
|
@@ -129,7 +130,7 @@
|
|
{
|
|
{
|
|
"name": "scenario",
|
|
"name": "scenario",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(Scenario|list[Scenario])",
|
|
|
|
|
|
+ "type": "dynamic(Union[Scenario,list[Scenario]])",
|
|
"doc": "The scenario to display and edit.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
"doc": "The scenario to display and edit.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
@@ -236,7 +237,7 @@
|
|
{
|
|
{
|
|
"name": "scenario",
|
|
"name": "scenario",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(Scenario|list[Scenario])",
|
|
|
|
|
|
+ "type": "dynamic(Union[Scenario,list[Scenario]])",
|
|
"doc": "The <code>Scenario^</code> whose diagram is displayed.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
"doc": "The <code>Scenario^</code> whose diagram is displayed.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
@@ -266,7 +267,7 @@
|
|
{
|
|
{
|
|
"name": "on_action",
|
|
"name": "on_action",
|
|
"type": "Union[str, Callable]",
|
|
"type": "Union[str, Callable]",
|
|
- "doc": "A function or the name of a function that is triggered when a a node is selected.<br/><br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>entity (DataNode | Task): the entity (DataNode or Task) that was selected.</li>\n</ul>",
|
|
|
|
|
|
+ "doc": "A function or the name of a function that is triggered when a a node is selected.<br/><br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>entity (DataNode or Task): the entity that was selected.</li>\n</ul>",
|
|
"signature": [
|
|
"signature": [
|
|
[
|
|
[
|
|
"state",
|
|
"state",
|
|
@@ -274,7 +275,7 @@
|
|
],
|
|
],
|
|
[
|
|
[
|
|
"entity",
|
|
"entity",
|
|
- "Task | DataNode"
|
|
|
|
|
|
+ "Union[Task,DataNode]"
|
|
]
|
|
]
|
|
]
|
|
]
|
|
}
|
|
}
|
|
@@ -291,8 +292,48 @@
|
|
{
|
|
{
|
|
"name": "value",
|
|
"name": "value",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(DataNode|list[DataNode])",
|
|
|
|
- "doc": "Bound to the selected <code>DataNode^</code>(s), or None if there is none."
|
|
|
|
|
|
+ "type": "dynamic(Union[DataNode,list[DataNode]])",
|
|
|
|
+ "doc": "Bound to the selected <code>DataNode^</code> or <code>DataNode^</code>s, or None if there is none."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "scenario",
|
|
|
|
+ "type": "dynamic(Union[Scenario,list[Scenario]])",
|
|
|
|
+ "doc": "If set, the selector will only show the data nodes owned by this scenario or any scenario in the list."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "datanodes",
|
|
|
|
+ "type": "dynamic(list[Union[DataNode,Scenario,Cycle]])",
|
|
|
|
+ "doc": "The list of <code>DataNode^</code>s, <code>Scenario^</code>s, or <code>Cycle^</code>s to show.<br/>All all DataNodes, Scenarios, and Cycles are shown if this is None."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "multiple",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "False",
|
|
|
|
+ "doc": "If True, the user can select multiple data nodes, therefore the <i>value</i> property can hold a list of <code>DataNode^</code> objects."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "filter",
|
|
|
|
+ "type": "Union[bool,str,taipy.gui_core.filters.DataNodeFilter,list[Union[str,taipy.gui_core.filters.DataNodeFilter]]]",
|
|
|
|
+ "default_value": "\"*\"",
|
|
|
|
+ "doc": "A list of <code>DataNode^</code> property names to filter on.<br/>If False, users cannot filter data nodes."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "sort",
|
|
|
|
+ "type": "Union[bool,str,taipy.gui_core.filters.DataNodeFilter,list[Union[str,taipy.gui_core.filters.DataNodeFilter]]]",
|
|
|
|
+ "default_value": "\"*\"",
|
|
|
|
+ "doc": "A list of <code>DataNode^</code> property names to sort on.<br/>If False, do not allow sort."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "show_search",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "True",
|
|
|
|
+ "doc": "If False, prevents users from searching for data nodes by label."
|
|
|
|
+ },
|
|
|
|
+ {
|
|
|
|
+ "name": "show_pins",
|
|
|
|
+ "type": "bool",
|
|
|
|
+ "default_value": "True",
|
|
|
|
+ "doc": "If True, a pin is shown on each item of the selector and allows to restrict the number of displayed items."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
"name": "display_cycles",
|
|
"name": "display_cycles",
|
|
@@ -330,46 +371,6 @@
|
|
"type": "str",
|
|
"type": "str",
|
|
"default_value": "\"50vh\"",
|
|
"default_value": "\"50vh\"",
|
|
"doc": "The maximum height, in CSS units, of the control."
|
|
"doc": "The maximum height, in CSS units, of the control."
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "show_pins",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "True",
|
|
|
|
- "doc": "If True, a pin is shown on each item of the selector and allows to restrict the number of displayed items."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "scenario",
|
|
|
|
- "type": "dynamic(Scenario|list[Scenario])",
|
|
|
|
- "doc": "TODO: If the <code>Scenario^</code> is set, the selector will only show datanodes owned by this scenario."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "datanodes",
|
|
|
|
- "type": "dynamic(list[DataNode|Scenario|Cycle])",
|
|
|
|
- "doc": "TODO: The list of <code>DataNode^</code>/<code>Scenario^</code>/<code>Cycle^</code> to show. Shows all Cycle/Scenario/DataNode if value is None."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "multiple",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "False",
|
|
|
|
- "doc": "TODO: If True, the user can select multiple datanodes."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "filter",
|
|
|
|
- "type": "bool|str|taipy.gui_core.filters.DataNodeFilter|list[str|taipy.gui_core.filters.DataNodeFilter]",
|
|
|
|
- "default_value": "\"*\"",
|
|
|
|
- "doc": "TODO: a list of <code>DataNode^</code> attributes to filter on. If False, do not allow filter."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "show_search",
|
|
|
|
- "type": "bool",
|
|
|
|
- "default_value": "True",
|
|
|
|
- "doc": "TODO: If True, allows the user to search locally on label."
|
|
|
|
- },
|
|
|
|
- {
|
|
|
|
- "name": "sort",
|
|
|
|
- "type": "bool|str|taipy.gui_core.filters.DataNodeFilter|list[str|taipy.gui_core.filters.DataNodeFilter]",
|
|
|
|
- "default_value": "\"*\"",
|
|
|
|
- "doc": "TODO: a list of <code>DataNode^</code> attributes to sort on. If False, do not allow sort."
|
|
|
|
}
|
|
}
|
|
]
|
|
]
|
|
}
|
|
}
|
|
@@ -384,7 +385,7 @@
|
|
{
|
|
{
|
|
"name": "data_node",
|
|
"name": "data_node",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(DataNode|list[DataNode])",
|
|
|
|
|
|
+ "type": "dynamic(Union[DataNode,list[DataNode]])",
|
|
"doc": "The data node to display and edit.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
"doc": "The data node to display and edit.<br/>If the value is a list, it must have a single element otherwise nothing is shown."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
@@ -439,7 +440,7 @@
|
|
"name": "show_owner_label",
|
|
"name": "show_owner_label",
|
|
"type": "bool",
|
|
"type": "bool",
|
|
"default_value": "False",
|
|
"default_value": "False",
|
|
- "doc": "If True, the data node owner label is added to the datanode label at the top of the block."
|
|
|
|
|
|
+ "doc": "If True, the data node owner label is added to the data node label at the top of the block."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
"name": "show_custom_properties",
|
|
"name": "show_custom_properties",
|
|
@@ -482,7 +483,7 @@
|
|
{
|
|
{
|
|
"name": "value",
|
|
"name": "value",
|
|
"default_property": true,
|
|
"default_property": true,
|
|
- "type": "dynamic(Job|list[Job])",
|
|
|
|
|
|
+ "type": "dynamic(Union[Job,list[Job]])",
|
|
"doc": "Bound to the selected <code>Job^</code>(s), or None if there is none."
|
|
"doc": "Bound to the selected <code>Job^</code>(s), or None if there is none."
|
|
},
|
|
},
|
|
{
|
|
{
|
|
@@ -555,7 +556,7 @@
|
|
{
|
|
{
|
|
"name": "on_details",
|
|
"name": "on_details",
|
|
"type": "Union[str, Callable, bool]",
|
|
"type": "Union[str, Callable, bool]",
|
|
- "doc": "The name of a function that is triggered when the details icon is pressed.<br/>The parameters of that function are all optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (str): the id of the control.</li>\n<li>payload (<code>dict</code>): a dictionary that contains the Job Id in the value for key <i>args<i>.</li>\n</ul></br>If False, the icon is not shown.",
|
|
|
|
|
|
+ "doc": "The name of a function that is triggered when the details icon is pressed.<br/>The parameters of that function are all optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (str): the id of the control.</li>\n<li>payload (<code>dict</code>): a dictionary that contains the Job Id in the value for key <i>args</i>.</li>\n</ul></br>If False, the icon is not shown.",
|
|
"signature": [
|
|
"signature": [
|
|
[
|
|
[
|
|
"state",
|
|
"state",
|