From 740b1974e10779ff67b7b1138dfca903eea155e9 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Fri, 7 Mar 2025 13:49:42 +0100 Subject: [PATCH] Schema update --- vizro-core/schemas/0.1.35.dev0.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/vizro-core/schemas/0.1.35.dev0.json b/vizro-core/schemas/0.1.35.dev0.json index 0a7d52d41..b7a8ff758 100644 --- a/vizro-core/schemas/0.1.35.dev0.json +++ b/vizro-core/schemas/0.1.35.dev0.json @@ -139,7 +139,7 @@ }, "Button": { "additionalProperties": false, - "description": "Component provided to `Page` to trigger any defined `action` in `Page`.\n\nArgs:\n type (Literal[\"button\"]): Defaults to `\"button\"`.\n text (str): Text to be displayed on button. Defaults to `\"Click me!\"`.\n href (str): URL (relative or absolute) to navigate to. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Button` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/button/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Component provided to `Page` to trigger any defined `action` in `Page`.\n\nArgs:\n type (Literal[\"button\"]): Defaults to `\"button\"`.\n text (str): Text to be displayed on button. Defaults to `\"Click me!\"`.\n href (str): URL (relative or absolute) to navigate to. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Button` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/button/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -179,7 +179,7 @@ }, "Card": { "additionalProperties": false, - "description": "Creates a card utilizing markdown as title and text component.\n\nArgs:\n type (Literal[\"card\"]): Defaults to `\"card\"`.\n text (str): Markdown string to create card title/text that should adhere to the CommonMark Spec.\n href (str): URL (relative or absolute) to navigate to. If not provided the Card serves as a text card\n only. Defaults to `\"\"`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Card` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/card/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Creates a card utilizing markdown as title and text component.\n\nArgs:\n type (Literal[\"card\"]): Defaults to `\"card\"`.\n text (str): Markdown string to create card title/text that should adhere to the CommonMark Spec.\n href (str): URL (relative or absolute) to navigate to. If not provided the Card serves as a text card\n only. Defaults to `\"\"`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Card` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/card/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -211,7 +211,7 @@ }, "Checklist": { "additionalProperties": false, - "description": "Categorical multi-option selector `Checklist`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"checklist\"]): Defaults to `\"checklist\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[MultiValueType]): See [`MultiValueType`][vizro.models.types.MultiValueType]. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Checklist` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/input/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Categorical multi-option selector `Checklist`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"checklist\"]): Defaults to `\"checklist\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[MultiValueType]): See [`MultiValueType`][vizro.models.types.MultiValueType]. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Checklist` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/input/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -316,7 +316,7 @@ }, "Container": { "additionalProperties": false, - "description": "Container to group together a set of components on a page.\n\nArgs:\n type (Literal[\"container\"]): Defaults to `\"container\"`.\n components (list[ComponentType]): See [ComponentType][vizro.models.types.ComponentType]. At least one component\n has to be provided.\n title (str): Title to be displayed.\n layout (Optional[Layout]): Layout to place components in. Defaults to `None`.\n variant (Literal[\"plain\", \"filled\", \"outlined\"]): Predefined styles to choose from. Options are `plain`,\n `filled` or `outlined`. Defaults to `plain`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Container` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/layout/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Container to group together a set of components on a page.\n\nArgs:\n type (Literal[\"container\"]): Defaults to `\"container\"`.\n components (list[ComponentType]): See [ComponentType][vizro.models.types.ComponentType]. At least one component\n has to be provided.\n title (str): Title to be displayed.\n layout (Optional[Layout]): Layout to place components in. Defaults to `None`.\n variant (Literal[\"plain\", \"filled\", \"outlined\"]): Predefined styles to choose from. Options are `plain`,\n `filled` or `outlined`. Defaults to `plain`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.Container` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/layout/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -407,7 +407,7 @@ }, "DatePicker": { "additionalProperties": false, - "description": "Temporal single/range option selector `DatePicker`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"date_picker\"]): Defaults to `\"date_picker\"`.\n min (Optional[date]): Start date for date picker. Defaults to `None`.\n max (Optional[date]): End date for date picker. Defaults to `None`.\n value (Optional[Union[list[date], date]]): Default date/dates for date picker. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n range (bool): Boolean flag for displaying range picker. Defaults to `True`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dmc.DatePickerInput` and overwrite\n any defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dmc documentation](https://www.dash-mantine-components.com/components/datepicker)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Temporal single/range option selector `DatePicker`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"date_picker\"]): Defaults to `\"date_picker\"`.\n min (Optional[date]): Start date for date picker. Defaults to `None`.\n max (Optional[date]): End date for date picker. Defaults to `None`.\n value (Optional[Union[list[date], date]]): Default date/dates for date picker. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n range (bool): Boolean flag for displaying range picker. Defaults to `True`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dmc.DatePickerInput` and overwrite\n any defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dmc documentation](https://www.dash-mantine-components.com/components/datepicker)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -496,7 +496,7 @@ }, "Dropdown": { "additionalProperties": false, - "description": "Categorical single/multi-option selector `Dropdown`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"dropdown\"]): Defaults to `\"dropdown\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[Union[SingleValueType, MultiValueType]]): See\n [`SingleValueType`][vizro.models.types.SingleValueType] and\n [`MultiValueType`][vizro.models.types.MultiValueType]. Defaults to `None`.\n multi (bool): Whether to allow selection of multiple values. Defaults to `True`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.Dropdown` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/dropdown)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Categorical single/multi-option selector `Dropdown`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"dropdown\"]): Defaults to `\"dropdown\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[Union[SingleValueType, MultiValueType]]): See\n [`SingleValueType`][vizro.models.types.SingleValueType] and\n [`MultiValueType`][vizro.models.types.MultiValueType]. Defaults to `None`.\n multi (bool): Whether to allow selection of multiple values. Defaults to `True`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.Dropdown` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/dropdown)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -1182,7 +1182,7 @@ }, "RadioItems": { "additionalProperties": false, - "description": "Categorical single-option selector `RadioItems`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"radio_items\"]): Defaults to `\"radio_items\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[SingleValueType]): See [`SingleValueType`][vizro.models.types.SingleValueType].\n Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.RadioItems` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/input/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Categorical single-option selector `RadioItems`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"radio_items\"]): Defaults to `\"radio_items\"`.\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (Optional[SingleValueType]): See [`SingleValueType`][vizro.models.types.SingleValueType].\n Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dbc.RadioItems` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://dash-bootstrap-components.opensource.faculty.ai/docs/components/input/)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -1275,7 +1275,7 @@ }, "RangeSlider": { "additionalProperties": false, - "description": "Numeric multi-option selector `RangeSlider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"range_slider\"]): Defaults to `\"range_slider\"`.\n min (Optional[float]): Start value for slider. Defaults to `None`.\n max (Optional[float]): End value for slider. Defaults to `None`.\n step (Optional[float]): Step-size for marks on slider. Defaults to `None`.\n marks (Optional[dict[Union[float, int], str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[list[float]]): Default start and end value for slider. Must be 2 items. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.RangeSlider` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/rangeslider)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Numeric multi-option selector `RangeSlider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"range_slider\"]): Defaults to `\"range_slider\"`.\n min (Optional[float]): Start value for slider. Defaults to `None`.\n max (Optional[float]): End value for slider. Defaults to `None`.\n step (Optional[float]): Step-size for marks on slider. Defaults to `None`.\n marks (Optional[dict[Union[float, int], str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[list[float]]): Default start and end value for slider. Must be 2 items. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.RangeSlider` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/rangeslider)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "", @@ -1381,7 +1381,7 @@ }, "Slider": { "additionalProperties": false, - "description": "Numeric single-option selector `Slider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"range_slider\"]): Defaults to `\"range_slider\"`.\n min (Optional[float]): Start value for slider. Defaults to `None`.\n max (Optional[float]): End value for slider. Defaults to `None`.\n step (Optional[float]): Step-size for marks on slider. Defaults to `None`.\n marks (Optional[dict[Union[float, int], str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[float]): Default value for slider. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.Slider` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior if the defaults change.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/slider)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and may\n not be supported in the future. Defaults to `{}`.", + "description": "Numeric single-option selector `Slider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nArgs:\n type (Literal[\"range_slider\"]): Defaults to `\"range_slider\"`.\n min (Optional[float]): Start value for slider. Defaults to `None`.\n max (Optional[float]): End value for slider. Defaults to `None`.\n step (Optional[float]): Step-size for marks on slider. Defaults to `None`.\n marks (Optional[dict[Union[float, int], str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[float]): Default value for slider. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (list[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.\n extra (Optional[dict[str, Any]]): Extra keyword arguments that are passed to `dcc.Slider` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dcc documentation](https://dash.plotly.com/dash-core-components/slider)\n to see all available arguments. [Not part of the official Vizro schema](../explanation/schema.md) and the\n underlying component may change in the future. Defaults to `{}`.", "properties": { "id": { "default": "",