|
|
@@ -44,14 +44,14 @@
|
|
|
{
|
|
|
"name": "label",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(str|Icon)",
|
|
|
+ "type": "dynamic(Union[str,Icon])",
|
|
|
"default_value": "\"\"",
|
|
|
"doc": "The label displayed in the button."
|
|
|
},
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of a function that is triggered when the button 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 (optional[str]): the identifier of the button.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
+ "doc": "The name of a function that is triggered when the button 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 identifier of the button it it has one.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -142,24 +142,24 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "step",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"default_value": "1",
|
|
|
"doc": "The amount by which the value is incremented or decremented when the user clicks one of the arrow buttons."
|
|
|
},
|
|
|
{
|
|
|
"name": "step_multiplier",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"default_value": "10",
|
|
|
"doc": "A factor that multiplies <i>step</i> when the user presses the Shift key while clicking one of the arrow buttons."
|
|
|
},
|
|
|
{
|
|
|
"name": "min",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"doc": "The minimum value to accept for this input."
|
|
|
},
|
|
|
{
|
|
|
"name": "max",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"doc": "The maximum value to accept for this input."
|
|
|
}
|
|
|
]
|
|
|
@@ -176,26 +176,26 @@
|
|
|
{
|
|
|
"name": "value",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(int|float|int[]|float[]|str|str[])",
|
|
|
+ "type": "dynamic(Union[int,float,str,list[int],list[float],list[str]])",
|
|
|
"doc": "The value that is set for this slider.<br/>If this slider is based on a <i>lov</i> then this property can be set to the lov element.<br/>This value can also hold an array of numbers to indicate that the slider reflects a range (within the [<i>min</i>,<i>max</i>] domain) defined by several knobs that the user can set independently.<br/>If this slider is based on a <i>lov</i> then this property can be set to an array of lov elements. The slider is then represented with several knobs, one for each lov value."
|
|
|
},
|
|
|
{
|
|
|
"name": "min",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "0",
|
|
|
"doc": "The minimum value.<br/>This is ignored when <i>lov</i> is defined."
|
|
|
},
|
|
|
{
|
|
|
"name": "max",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "100",
|
|
|
"doc": "The maximum value.<br/>This is ignored when <i>lov</i> is defined."
|
|
|
},
|
|
|
{
|
|
|
"name": "step",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "1",
|
|
|
- "doc": "The step value: the gap between two consecutive values the slider set. It is a good practice to have (<i>max</i>-<i>min</i>) being divisible by <i>step</i>.<br/>This property is ignored when <i>lov</i> is defined."
|
|
|
+ "doc": "The step value, which is the gap between two consecutive values the slider set. It is a good practice to have (<i>max</i>-<i>min</i>) being divisible by <i>step</i>.<br/>This property is ignored when <i>lov</i> is defined."
|
|
|
},
|
|
|
{
|
|
|
"name": "text_anchor",
|
|
|
@@ -205,7 +205,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "labels",
|
|
|
- "type": "bool|dict",
|
|
|
+ "type": "Union[bool,dict[str,str]]",
|
|
|
"doc": "The labels for specific points of the slider.<br/>If set to True, this slider uses the labels of the <i>lov</i> if there are any.<br/>If set to a dictionary, the slider uses the dictionary keys as a <i>lov</i> key or index, and the associated value as the label."
|
|
|
},
|
|
|
{
|
|
|
@@ -501,7 +501,7 @@
|
|
|
{
|
|
|
"name": "on_range_change",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The callback function that is invoked when the visible part of the x axis changes.<br/>The function receives three parameters:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the chart control.</li>\n<li>payload (dict[str, any]): the full details on this callback's invocation, as emitted by <a href=\"https://plotly.com/javascript/plotlyjs-events/#update-data\">Plotly</a>.</li>\n</ul>",
|
|
|
+ "doc": "The callback function that is invoked when the visible part of the x axis changes.<br/>The function receives three parameters:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (str): the identifier of the chart control if it has one.</li>\n<li>payload (dict[str, any]): the full details on this callback's invocation, as emitted by <a href=\"https://plotly.com/javascript/plotlyjs-events/#update-data\">Plotly</a>.</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -519,7 +519,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "columns",
|
|
|
- "type": "str|list[str]|dict[str, dict[str, str]]",
|
|
|
+ "type": "Union[str,list[str],dict[str,dict[str,str]]]",
|
|
|
"default_value": "<i>All columns</i>",
|
|
|
"doc": "The list of column names\n<ul>\n<li>str: ;-separated list of column names</li>\n<li>list[str]: list of names</li>\n<li>dict: {\"column_name\": {format: \"format\", index: 1}} if index is specified, it represents the display order of the columns.\nIf not, the list order defines the index</li>\n</ul>"
|
|
|
},
|
|
|
@@ -535,7 +535,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "selected",
|
|
|
- "type": "indexed(dynamic(list[int]|str))",
|
|
|
+ "type": "indexed(dynamic(Union[list[int],str]))",
|
|
|
"doc": "The list of the selected point indices ."
|
|
|
},
|
|
|
{
|
|
|
@@ -555,7 +555,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "line",
|
|
|
- "type": "indexed(str|dict[str, any])",
|
|
|
+ "type": "indexed(Union[str,dict[str,any]])",
|
|
|
"doc": "The configuration of the line used for the indicated trace.<br/>See <a href=\"https://plotly.com/javascript/reference/scatter/#scatter-line\">line</a> for details.<br/>If the value is a string, it must be a dash type or pattern (see <a href=\"https://plotly.com/python/reference/scatter/#scatter-line-dash\">dash style of lines</a> for details)."
|
|
|
},
|
|
|
{
|
|
|
@@ -600,13 +600,13 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "width",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"default_value": "\"100%\"",
|
|
|
"doc": "The width of this chart, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"doc": "The height of this chart, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
@@ -689,18 +689,18 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "selected",
|
|
|
- "type": "dynamic(list[int]|str)",
|
|
|
+ "type": "dynamic(Union[list[int],str])",
|
|
|
"doc": "The list of the indices of the rows to be displayed as selected."
|
|
|
},
|
|
|
{
|
|
|
"name": "page_size_options",
|
|
|
- "type": "list[int]|str",
|
|
|
- "default_value": "[50, 100, 500]",
|
|
|
+ "type": "Union[list[int],str]",
|
|
|
+ "default_value": "(50, 100, 500)",
|
|
|
"doc": "The list of available page sizes that users can choose from."
|
|
|
},
|
|
|
{
|
|
|
"name": "columns",
|
|
|
- "type": "str|list[str]|dict[str, dict[str, str|int]]",
|
|
|
+ "type": "Union[str,list[str],dict[str,dict[str,Union[str,int]]]]",
|
|
|
"default_value": "<i>shows all columns when empty</i>",
|
|
|
"doc": "The list of the column names to display.\n<ul>\n<li>str: Semicolon (';')-separated list of column names.</li>\n<li>list[str]: The list of column names.</li>\n<li>dict: A dictionary with entries matching: {\"col name\": {format: \"format\", index: 1}}.<br/>\nif <i>index</i> is specified, it represents the display order of the columns.\nIf <i>index</i> is not specified, the list order defines the index.<br/>\nIf <i>format</i> is specified, it is used for numbers or dates.</li>\n</ul>"
|
|
|
},
|
|
|
@@ -885,12 +885,12 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "lov[<i>column_name</i>]",
|
|
|
- "type": "list[str]|str",
|
|
|
+ "type": "Union[list[str],str]",
|
|
|
"doc": "The list of values of the indicated column."
|
|
|
},
|
|
|
{
|
|
|
"name": "downloadable",
|
|
|
- "type": "boolean",
|
|
|
+ "type": "bool",
|
|
|
"doc": "If True, a clickable icon is shown so the user can download the data as CSV."
|
|
|
},
|
|
|
{
|
|
|
@@ -954,13 +954,13 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "width",
|
|
|
- "type": "str|int",
|
|
|
+ "type": "Union[str,int]",
|
|
|
"default_value": "\"360px\"",
|
|
|
"doc": "The width of this selector, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|int",
|
|
|
+ "type": "Union[str,int]",
|
|
|
"doc": "The height of this selector, in CSS units."
|
|
|
}
|
|
|
]
|
|
|
@@ -977,7 +977,7 @@
|
|
|
{
|
|
|
"name": "content",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(path|file|URL|ReadableBuffer|None)",
|
|
|
+ "type": "dynamic(Union[path,file,URL,ReadableBuffer,None])",
|
|
|
"doc": "The content to transfer.<br/>If this is a string, a URL, or a file, then the content is read from this source.<br/>If a readable buffer is provided (such as an array of bytes...), and to prevent the bandwidth from being consumed too much, the way the data is transferred depends on the <i>data_url_max_size</i> parameter of the application configuration (which is set to 50kB by default):\n<ul>\n<li>If the buffer size is smaller than this setting, then the raw content is generated as a data URL, encoded using base64 (i.e. <code>\"data:<mimetype>;base64,<data>\"</code>).</li>\n<li>If the buffer size exceeds this setting, then it is transferred through a temporary file.</li>\n</ul>If this property is set to None, that indicates that dynamic content is generated. Please take a look at the examples below for details on dynamic generation."
|
|
|
},
|
|
|
{
|
|
|
@@ -988,7 +988,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of a function that is triggered when the download is terminated (or on user action if <i>content</i> is None).<br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the button.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has two keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: A list of two elements: <i>args[0]</i> reflects the <i>name</i> property and <i>args[1]</i> holds the file URL.</li>\n</ul>\n</li>\n</ul>",
|
|
|
+ "doc": "The name of a function that is triggered when the download is terminated (or on user action if <i>content</i> is None).<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 the button if it has one.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has two keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: A list of two elements: <i>args[0]</i> reflects the <i>name</i> property and <i>args[1]</i> holds the file URL.</li>\n</ul>\n</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1052,7 +1052,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of the function that will be triggered.<br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the button.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
+ "doc": "The name of the function that will be triggered.<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 the button if it has one.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1106,7 +1106,7 @@
|
|
|
{
|
|
|
"name": "content",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(path|URL|file|ReadableBuffer)",
|
|
|
+ "type": "dynamic(Union[path,URL,file,ReadableBuffer])",
|
|
|
"doc": "The image source.<br/>If a buffer is provided (string, array of bytes...), and in order to prevent the bandwidth to be consumed too much, the way the image data is transferred depends on the <i>data_url_max_size</i> parameter of the application configuration (which is set to 50kB by default):\n<ul>\n<li>If the size of the buffer is smaller than this setting, then the raw content is generated as a\n data URL, encoded using base64 (i.e. <code>\"data:<mimetype>;base64,<data>\"</code>).</li>\n<li>If the size of the buffer is greater than this setting, then it is transferred through a temporary\n file.</li>\n</ul>"
|
|
|
},
|
|
|
{
|
|
|
@@ -1117,7 +1117,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of a function that is triggered when the user clicks on the image.<br/>All the parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the button.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
+ "doc": "The name of a function that is triggered when the user clicks on the image.<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 the button if it has one.</li>\n<li>payload (dict): a dictionary that contains the key \"action\" set to the name of the action that triggered this callback.</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1135,13 +1135,13 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "width",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"default_value": "\"300px\"",
|
|
|
"doc": "The width of this image control, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"doc": "The height of this image control, in CSS units."
|
|
|
}
|
|
|
]
|
|
|
@@ -1157,52 +1157,51 @@
|
|
|
{
|
|
|
"name": "value",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(int|float)",
|
|
|
- "doc": "The value to display."
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
+ "doc": "The value to represent."
|
|
|
},
|
|
|
{
|
|
|
"name": "type",
|
|
|
"default_value": "\"circular\"",
|
|
|
"type": "str",
|
|
|
- "doc": "The type of the gauge.<br/>Possible values are:\n<ul>\n<li>\"none\"</li>\n<li>\"circular\"</li>\n<li>\"linear\"</li></ul>."
|
|
|
- },
|
|
|
- {
|
|
|
- "name": "title",
|
|
|
- "default_value": "None",
|
|
|
- "type": "str",
|
|
|
- "doc": "The title of the metric."
|
|
|
+ "doc": "The type of the gauge.<br/>Possible values are:\n<ul>\n<li>\"none\"</li>\n<li>\"circular\"</li>\n<li>\"linear\"</li></ul>Setting this value to \"none\" remove the gauge."
|
|
|
},
|
|
|
{
|
|
|
"name": "min",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "0",
|
|
|
- "doc": "The minimum value of this metric control."
|
|
|
+ "doc": "The minimum value of this metric control's gauge."
|
|
|
},
|
|
|
{
|
|
|
"name": "max",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "100",
|
|
|
- "doc": "The maximum value of this metric control."
|
|
|
+ "doc": "The maximum value of this metric control's gauge."
|
|
|
},
|
|
|
{
|
|
|
"name": "delta",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"doc": "The delta value to display."
|
|
|
},
|
|
|
{
|
|
|
"name": "delta_color",
|
|
|
"type": "str",
|
|
|
- "doc": "The color that is used to display the value of the <i>delta</i> property. If negative_delta_color is set, then this property applies for positive values of delta only. If this property is set to \"invert\", then delta values are represented with the color used for negative values if delta is positive. The value for delta is also represented with the color used for positive values if delta is negative."
|
|
|
+ "doc": "The color that is used to display the value of the <i>delta</i> property.<br/>If <i>negative_delta_color</i> is set, then this property applies for positive values of <i>delta</i> only.<br/>If this property is set to \"invert\", then values for <i>delta</i> are represented with the color used for negative values if delta is positive and <i>delta</i> is represented with the color used for positive values if it is negative."
|
|
|
+ },
|
|
|
+ {
|
|
|
+ "name": "title",
|
|
|
+ "default_value": "None",
|
|
|
+ "type": "str",
|
|
|
+ "doc": "The title of the metric."
|
|
|
},
|
|
|
{
|
|
|
"name": "negative_delta_color",
|
|
|
"type": "str",
|
|
|
- "doc": "If set, this represents the color to be used when the value of <i>delta</i> is negative (or positive if <i>delta_color</i> is set to \"invert\")"
|
|
|
-
|
|
|
+ "doc": "If set, this represents the color to be used when the value of <i>delta</i> is negative (or positive if <i>delta_color</i> is set to \"invert\")."
|
|
|
},
|
|
|
{
|
|
|
"name": "threshold",
|
|
|
- "type": "dynamic(int|float)",
|
|
|
+ "type": "dynamic(Union[int,float])",
|
|
|
"doc": "The threshold value to display."
|
|
|
},
|
|
|
{
|
|
|
@@ -1221,23 +1220,33 @@
|
|
|
"type": "str",
|
|
|
"doc": "The format to use when displaying the delta value.<br/>This uses the <code>printf</code> syntax."
|
|
|
},
|
|
|
+ {
|
|
|
+ "name": "bar_color",
|
|
|
+ "type": "str",
|
|
|
+ "doc": "The color of the bar in the gauge."
|
|
|
+ },
|
|
|
{
|
|
|
"name": "color_map",
|
|
|
"type": "dict",
|
|
|
- "doc": "TODO The color_map is used to display different colors for different ranges of the metric. The color_map's keys represent the starting point of each range, which is a number, while the values represent the corresponding color for that range. If the value associated with a key is set to None, it implies that the corresponding range is not assigned any color."
|
|
|
+ "doc": "Indicates what colors should be used for different ranges of the metric. The <i>color_map</i>'s keys represent the lower bound of each range, which is a number, while the values represent the color for that range.<br/>If the value associated with a key is set to None, the corresponding range is not assigned any color."
|
|
|
},
|
|
|
{
|
|
|
"name": "width",
|
|
|
- "type": "str|number",
|
|
|
+ "type": "Union[str,number]",
|
|
|
"default_value": "None",
|
|
|
"doc": "The width of the metric control, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|number",
|
|
|
+ "type": "Union[str,number]",
|
|
|
"default_value": "None",
|
|
|
"doc": "The height of the metric control, in CSS units."
|
|
|
},
|
|
|
+ {
|
|
|
+ "name": "layout",
|
|
|
+ "type": "dynamic(dict[str, any])",
|
|
|
+ "doc": "The <i>plotly.js</i> compatible <a href=\"https://plotly.com/javascript/reference/layout/\">layout object</a>."
|
|
|
+ },
|
|
|
{
|
|
|
"name": "template",
|
|
|
"type": "dict",
|
|
|
@@ -1308,13 +1317,13 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "min",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "0",
|
|
|
"doc": "The minimum value of the range."
|
|
|
},
|
|
|
{
|
|
|
"name": "max",
|
|
|
- "type": "int|float",
|
|
|
+ "type": "Union[int,float]",
|
|
|
"default_value": "100",
|
|
|
"doc": "The maximum value of the range."
|
|
|
},
|
|
|
@@ -1358,14 +1367,14 @@
|
|
|
{
|
|
|
"name": "lov",
|
|
|
"default_property": true,
|
|
|
- "type": "dynamic(str|list[str|Icon|any])",
|
|
|
+ "type": "dynamic(Union[str,list[Union[str,Icon,any]]])",
|
|
|
"doc": "The list of menu option values."
|
|
|
},
|
|
|
{
|
|
|
"name": "adapter",
|
|
|
"type": "Function",
|
|
|
"default_value": "`\"lambda x: str(x)\"`",
|
|
|
- "doc": "The function that transforms an element of <i>lov</i> into a <i>tuple(id:str, label:str|Icon)</i>."
|
|
|
+ "doc": "The function that transforms an element of <i>lov</i> into a <i>tuple(id:str, label:Union[str,Icon])</i>."
|
|
|
},
|
|
|
{
|
|
|
"name": "type",
|
|
|
@@ -1380,7 +1389,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "inactive_ids",
|
|
|
- "type": "dynamic(str|list[str])",
|
|
|
+ "type": "dynamic(Union[str,list[str]])",
|
|
|
"doc": "Semicolon (';')-separated list or a list of menu items identifiers that are disabled."
|
|
|
},
|
|
|
{
|
|
|
@@ -1398,7 +1407,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of the function that is triggered when a menu option 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>id (str): the identifier of the button.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: List where the first element contains the id of the selected option.</li>\n</ul>\n</li>\n</ul>",
|
|
|
+ "doc": "The name of the function that is triggered when a menu option 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>id (str): the identifier of the button if it has one.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: List where the first element contains the id of the selected option.</li>\n</ul>\n</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1444,7 +1453,7 @@
|
|
|
{
|
|
|
"name": "value",
|
|
|
"default_property": true,
|
|
|
- "type": "tuple|dict|list[dict]|list[tuple]",
|
|
|
+ "type": "Union[tuple,dict,list[dict],list[tuple]]",
|
|
|
"doc": "The different status items to represent. See below."
|
|
|
},
|
|
|
{
|
|
|
@@ -1473,7 +1482,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of the function that is triggered when the dialog button is pressed.<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 the button.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: a list with three elements:\n<ul><li>The first element is the username</li><li>The second element is the password</li><li>The third element is the current page name</li></ul></li></li>\n</ul>\n</li>\n</ul><br/>When the button is pressed, and if this property is not set, Taipy will try to find a callback function called <i>on_login()</i> and invoke it with the parameters listed above.",
|
|
|
+ "doc": "The name of the function that is triggered when the dialog button is pressed.<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 the button if it has one.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: a list with three elements:\n<ul><li>The first element is the username</li><li>The second element is the password</li><li>The third element is the current page name</li></ul></li></li>\n</ul>\n</li>\n</ul><br/>When the button is pressed, and if this property is not set, Taipy will try to find a callback function called <i>on_login()</i> and invoke it with the parameters listed above.",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1514,7 +1523,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "users",
|
|
|
- "type": "dynamic(list[str|Icon])",
|
|
|
+ "type": "dynamic(list[Union[str,Icon]])",
|
|
|
"doc": "The list of users. See the <a href=\"../../binding/#list-of-values\">section on List of Values</a> for details."
|
|
|
},
|
|
|
{
|
|
|
@@ -1556,7 +1565,7 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"doc": "The maximum height of this chat control, in CSS units."
|
|
|
}
|
|
|
]
|
|
|
@@ -1571,7 +1580,7 @@
|
|
|
"properties": [
|
|
|
{
|
|
|
"name": "expanded",
|
|
|
- "type": "dynamic(bool|str[])",
|
|
|
+ "type": "dynamic(Union[bool,list[str]])",
|
|
|
"default_value": "True",
|
|
|
"doc": "If Boolean and False, only one node can be expanded at one given level. Otherwise this should be set to an array of the node identifiers that need to be expanded."
|
|
|
},
|
|
|
@@ -1678,7 +1687,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "Name of a function triggered when a button 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 identifier of the dialog.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>This dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: a list where the first element contains the index of the selected label.</li>\n</ul>\n</li>\n</ul>",
|
|
|
+ "doc": "Name of a function triggered when a button 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 identifier of the dialog if it has one.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>This dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args: a list where the first element contains the index of the selected label.</li>\n</ul>\n</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1702,17 +1711,17 @@
|
|
|
},
|
|
|
{
|
|
|
"name": "labels",
|
|
|
- "type": " str|list[str]",
|
|
|
+ "type": "Union[str,list[str]]",
|
|
|
"doc": "A list of labels to show in a row of buttons at the bottom of the dialog. The index of the button in the list is reported as args in the <tt>on_action</tt> callback (that index is -1 for the <i>close</i> icon)."
|
|
|
},
|
|
|
{
|
|
|
"name": "width",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"doc": "The width of this dialog, in CSS units."
|
|
|
},
|
|
|
{
|
|
|
"name": "height",
|
|
|
- "type": "str|int|float",
|
|
|
+ "type": "Union[str,int,float]",
|
|
|
"doc": "The height of this dialog, in CSS units."
|
|
|
}
|
|
|
]
|
|
|
@@ -1767,7 +1776,7 @@
|
|
|
{
|
|
|
"name": "on_close",
|
|
|
"type": "Callback",
|
|
|
- "doc": "The name of a function that is triggered when this pane is closed (if the user clicks outside of it or presses the Esc key).<br/>All parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the button.</li>\n</ul><br/>If this property is not set, no function is called when this pane is closed.",
|
|
|
+ "doc": "The name of a function that is triggered when this pane is closed (if the user clicks outside of it or presses the Esc key).<br/>All parameters of that function are optional:\n<ul>\n<li>state (<code>State^</code>): the state instance.</li>\n<li>id (optional[str]): the identifier of the close button if it has one.</li>\n</ul><br/>If this property is not set, no function is called when this pane is closed.",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1843,7 +1852,7 @@
|
|
|
"name": "adapter",
|
|
|
"type": "Function",
|
|
|
"default_value": "`lambda x: str(x)`",
|
|
|
- "doc": "The function that transforms an element of <i>lov</i> into a <i>tuple(id:str, label:str|Icon)</i>."
|
|
|
+ "doc": "The function that transforms an element of <i>lov</i> into a <i>tuple(id:str, label:Union[str,Icon])</i>."
|
|
|
},
|
|
|
{
|
|
|
"name": "type",
|
|
|
@@ -1892,7 +1901,7 @@
|
|
|
"properties": [
|
|
|
{
|
|
|
"name": "partial",
|
|
|
- "type": "Partial",
|
|
|
+ "type": "taipy.gui.Partial",
|
|
|
"doc": "A Partial object that holds the content of the block.<br/>This should not be defined if <i>page</i> is set."
|
|
|
},
|
|
|
{
|
|
|
@@ -1933,7 +1942,7 @@
|
|
|
{
|
|
|
"name": "on_action",
|
|
|
"type": "Callback",
|
|
|
- "doc": "Name of a function that is triggered when a specific key 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 identifier of the input.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args (list):\n<ul><li>key name</li><li>variable name</li><li>current value</li></ul>\n</li>\n</ul>\n</li>\n</ul>",
|
|
|
+ "doc": "Name of a function that is triggered when a specific key 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 identifier of the control if it has one.</li>\n<li>payload (dict): the details on this callback's invocation.<br/>\nThis dictionary has the following keys:\n<ul>\n<li>action: the name of the action that triggered this callback.</li>\n<li>args (list):\n<ul><li>key name</li><li>variable name</li><li>current value</li></ul>\n</li>\n</ul>\n</li>\n</ul>",
|
|
|
"signature": [
|
|
|
[
|
|
|
"state",
|
|
|
@@ -1965,25 +1974,21 @@
|
|
|
{
|
|
|
"name": "id",
|
|
|
"type": "str",
|
|
|
- "default_value": "None",
|
|
|
"doc": "The identifier that is assigned to the rendered HTML component."
|
|
|
},
|
|
|
{
|
|
|
"name": "properties",
|
|
|
"type": "dict[str, any]",
|
|
|
- "default_value": "None",
|
|
|
"doc": "Bound to a dictionary that contains additional properties for this element."
|
|
|
},
|
|
|
{
|
|
|
"name": "class_name",
|
|
|
"type": "dynamic(str)",
|
|
|
- "default_value": "None",
|
|
|
"doc": "The list of CSS class names that are associated with the generated HTML Element.<br/>These class names are added to the default <code>taipy-<element_type></code> class name."
|
|
|
},
|
|
|
{
|
|
|
"name": "hover_text",
|
|
|
"type": "dynamic(str)",
|
|
|
- "default_value": "None",
|
|
|
"doc": "The information that is displayed when the user hovers over this element."
|
|
|
}
|
|
|
]
|
João André