vizro-mcp

{ "$defs": { "Accordion": { "additionalProperties": false, "description": "Accordion to be used as `nav_selector` in [`Navigation`][vizro.models.Navigation].\n\nAbstract: Usage documentation\n [How to use an accordion](../user-guides/navigation.md/#group-pages)\n\nArgs:\n pages (dict[str, list[ModelID]]): Mapping from name of a pages group to a list of page IDs/titles.\n Defaults to `{}`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "accordion", "default": "accordion", "title": "Type", "type": "string" }, "pages": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "default": {}, "description": "Mapping from name of a pages group to a list of page IDs/titles.", "title": "Pages", "type": "object" } }, "title": "Accordion", "type": "object" }, "Action": { "additionalProperties": false, "description": "Custom action to be inserted into `actions` of source component.\n\nAbstract: Usage documentation\n [How to create custom actions](../user-guides/custom-actions.md)\n\nArgs:\n function (CapturedCallable): Custom action function.\n inputs (list[str]): List of inputs provided to the action function. Each input can be specified as\n `<model_id>` or `<model_id>.<argument_name>` or `<component_id>.<property>`. Defaults to `[]`.\n \u2757Deprecated: `inputs` is deprecated and [will not exist in Vizro 0.2.0](\n deprecations.md#action-model-inputs-argument).\n outputs (OutputsType): See [`OutputsType`][vizro.models.types.OutputsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "outputs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "type": "string" }, "type": "object" } ], "default": [], "title": "Outputs" }, "type": { "const": "action", "default": "action", "title": "Type", "type": "string" }, "inputs": { "default": [], "description": "List of inputs provided to the action function. Each input can be specified as\n `<model_id>` or `<model_id>.<argument_name>` or `<component_id>.<property>`. Defaults to `[]`.\n \u2757Deprecated: `inputs` is deprecated and [will not exist in Vizro 0.2.0](\n deprecations.md#action-model-inputs-argument).", "items": { "type": "string" }, "title": "Inputs", "type": "array" } }, "title": "Action", "type": "object" }, "AgGrid": { "additionalProperties": false, "description": "Wrapper for `dash_ag_grid.AgGrid` to visualize grids in dashboard.\n\nAbstract: Usage documentation\n [How to use an AgGrid](../user-guides/table.md/#ag-grid)\n\nArgs:\n figure (CapturedCallable): Function that returns a Dash AgGrid. See [`vizro.tables`][vizro.tables].\n title (str): Title of the `AgGrid`. Defaults to `\"\"`.\n header (str): Markdown text positioned below the `AgGrid.title`. Follows the CommonMark specification.\n Ideal for adding supplementary information such as subtitles, descriptions, or additional context.\n Defaults to `\"\"`.\n footer (str): Markdown text positioned below the `AgGrid`. Follows the CommonMark specification.\n Ideal for providing further details such as sources, disclaimers, or additional notes. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "ag_grid", "default": "ag_grid", "title": "Type", "type": "string" }, "title": { "default": "", "description": "Title of the `AgGrid`.", "title": "Title", "type": "string" }, "header": { "default": "", "description": "Markdown text positioned below the `AgGrid.title`. Follows the CommonMark specification. Ideal for adding supplementary information such as subtitles, descriptions, or additional context.", "title": "Header", "type": "string" }, "footer": { "default": "", "description": "Markdown text positioned below the `AgGrid`. Follows the CommonMark specification. Ideal for providing further details such as sources, disclaimers, or additional notes.", "title": "Footer", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "AgGrid", "type": "object" }, "Button": { "additionalProperties": false, "description": "Button that can trigger actions or navigate.\n\nAbstract: Usage documentation\n [How to use buttons](../user-guides/button.md)\n\nArgs:\n icon (str): Icon name from [Google Material icons library](https://fonts.google.com/icons). Defaults to `\"\"`.\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 (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n variant (Literal[\"plain\", \"filled\", \"outlined\"]): Predefined styles to choose from. Options are `plain`,\n `filled` or `outlined`. Defaults to `filled`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the button text.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n extra (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://www.dash-bootstrap-components.com/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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "button", "default": "button", "title": "Type", "type": "string" }, "icon": { "default": "", "description": "Icon name from Google Material icons library.", "title": "Icon", "type": "string" }, "text": { "default": "Click me!", "description": "Text to be displayed on button.", "title": "Text", "type": "string" }, "href": { "default": "", "description": "URL (relative or absolute) to navigate to.", "title": "Href", "type": "string" }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" }, "variant": { "default": "filled", "description": "Predefined styles to choose from. Options are `plain`, `filled` or `outlined`.Defaults to `filled`.", "enum": ["plain", "filled", "outlined"], "title": "Variant", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the button text.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." } }, "title": "Button", "type": "object" }, "Card": { "additionalProperties": false, "description": "Card based on Markdown syntax.\n\nAbstract: Usage documentation\n [How to use cards](../user-guides/card.md)\n\nArgs:\n text (str): Markdown string to create card title/text that should adhere to the CommonMark Spec.\n header (str): Markdown text positioned above the card text. Follows the CommonMark specification.\n Ideal for adding supplementary information. Defaults to `\"\"`.\n footer (str): Markdown text positioned at the bottom of the `Card`. Follows the CommonMark specification.\n Ideal for providing further details such as sources, disclaimers, or additional notes. Defaults to `\"\"`.\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 description (Tooltip | None): Optional markdown string that adds an icon in the top-right corner of the Card.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n extra (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://www.dash-bootstrap-components.com/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 `{}`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "card", "default": "card", "title": "Type", "type": "string" }, "text": { "description": "Markdown string to create card title/text that should adhere to the CommonMark Spec.", "title": "Text", "type": "string" }, "header": { "default": "", "description": "Markdown text positioned above the card text. Follows the CommonMark specification. Ideal for\n adding supplementary information.", "title": "Header", "type": "string" }, "footer": { "default": "", "description": "Markdown text positioned at the bottom of the `Card`. Follows the CommonMark specification.\n Ideal for providing further details such as sources, disclaimers, or additional notes.", "title": "Footer", "type": "string" }, "href": { "default": "", "description": "URL (relative or absolute) to navigate to. If not provided the Card serves as a text card only.", "title": "Href", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon in the top-right corner of the Card.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "required": ["text"], "title": "Card", "type": "object" }, "Checklist": { "additionalProperties": false, "description": "Categorical multi-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use categorical selectors](../user-guides/selectors.md#categorical-selectors)\n\nArgs:\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (MultiValueType | None): See [`MultiValueType`][vizro.models.types.MultiValueType]. Defaults to\n `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n show_select_all (bool): Whether to display the 'Select All' option that allows users to select or\n deselect all available options with a single click. Defaults to `True`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (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://www.dash-bootstrap-components.com/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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "checklist", "default": "checklist", "title": "Type", "type": "string" }, "options": { "anyOf": [ { "items": { "type": "boolean" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "format": "date", "type": "string" }, "type": "array" }, { "items": { "$ref": "#/$defs/_OptionsDictType" }, "type": "array" } ], "default": [], "title": "Options" }, "value": { "anyOf": [ { "items": { "type": "boolean" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "format": "date", "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Value" }, "title": { "default": "", "description": "Title to be displayed", "title": "Title", "type": "string" }, "show_select_all": { "default": true, "description": "Whether to display the 'Select All' option that allows users to select or deselect all available options with a single click.", "title": "Show Select All", "type": "boolean" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Checklist", "type": "object" }, "Container": { "additionalProperties": false, "description": "Container to group together a set of components on a page.\n\nAbstract: Usage documentation\n [How to use containers](../user-guides/container.md)\n\nArgs:\n components (list[ComponentType]): See [ComponentType][vizro.models.types.ComponentType]. At least one component\n has to be provided.\n title (str): Title of the `Container`. Defaults to `\"\"`.\n layout (LayoutType | None): Layout to place components in. Defaults to `None`.\n collapsed (bool | None): Boolean flag that determines whether the container is collapsed on initial load.\n Set to `True` for a collapsed state, `False` for an expanded state. Defaults to `None`, meaning the\n container is not collapsible.\n variant (Literal[\"plain\", \"filled\", \"outlined\"] | None): Predefined styles to choose from. Options are\n `plain`, `filled` or `outlined`. Defaults to `plain` (or `outlined` for collapsible container).\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n controls (list[ControlType]): See [ControlType][vizro.models.types.ControlType]. Defaults to `[]`.\n extra (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://www.dash-bootstrap-components.com/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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "container", "default": "container", "title": "Type", "type": "string" }, "components": { "items": { "description": "Component that makes up part of the layout on the page.", "discriminator": { "mapping": { "ag_grid": "#/$defs/AgGrid", "button": "#/$defs/Button", "card": "#/$defs/Card", "container": "#/$defs/Container", "figure": "#/$defs/Figure", "graph": "#/$defs/Graph", "table": "#/$defs/Table", "tabs": "#/$defs/Tabs", "text": "#/$defs/Text" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/AgGrid" }, { "$ref": "#/$defs/Button" }, { "$ref": "#/$defs/Card" }, { "$ref": "#/$defs/Container" }, { "$ref": "#/$defs/Figure" }, { "$ref": "#/$defs/Graph" }, { "$ref": "#/$defs/Text" }, { "$ref": "#/$defs/Table" }, { "$ref": "#/$defs/Tabs" } ] }, "minItems": 1, "title": "Components", "type": "array" }, "title": { "default": "", "description": "Title of the `Container`", "title": "Title", "type": "string" }, "layout": { "anyOf": [ { "description": "Type of layout to place components on the page.", "oneOf": [ { "$ref": "#/$defs/Grid" }, { "$ref": "#/$defs/Flex" }, { "$ref": "#/$defs/Layout" } ] }, { "type": "null" } ], "default": null, "title": "Layout" }, "collapsed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Boolean flag that determines whether the container is collapsed on initial load. Set to `True` for a collapsed state, `False` for an expanded state. Defaults to `None`, meaning the container is not collapsible.", "title": "Collapsed" }, "variant": { "anyOf": [ { "enum": ["plain", "filled", "outlined"], "type": "string" }, { "type": "null" } ], "default": null, "description": "Predefined styles to choose from. Options are `plain`, `filled` or `outlined`.Defaults to `plain` (or `outlined` for collapsible container).", "title": "Variant" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "controls": { "default": [], "items": { "description": "Control that affects components on the page.", "discriminator": { "mapping": { "filter": "#/$defs/Filter", "parameter": "#/$defs/Parameter" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Filter" }, { "$ref": "#/$defs/Parameter" } ] }, "title": "Controls", "type": "array" } }, "required": ["components"], "title": "Container", "type": "object" }, "DatePicker": { "additionalProperties": false, "description": "Temporal single/range option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use temporal selectors](../user-guides/selectors.md#temporal-selectors)\n\nArgs:\n min (date | None): Start date for date picker. Defaults to `None`.\n max (date | None): End date for date picker. Defaults to `None`.\n value (list[date] | date | None): 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 description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n\n extra (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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "date_picker", "default": "date_picker", "title": "Type", "type": "string" }, "min": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Start date for date picker.", "title": "Min" }, "max": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "End date for date picker.", "title": "Max" }, "value": { "anyOf": [ { "items": { "format": "date", "type": "string" }, "type": "array" }, { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Default date/dates for date picker.", "title": "Value" }, "title": { "default": "", "description": "Title to be displayed.", "title": "Title", "type": "string" }, "range": { "default": true, "description": "Boolean flag for displaying range picker.", "title": "Range", "type": "boolean" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "DatePicker", "type": "object" }, "Dropdown": { "additionalProperties": false, "description": "Categorical single/multi-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use categorical selectors](../user-guides/selectors.md#categorical-selectors)\n\nArgs:\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (SingleValueType | MultiValueType | None): 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 description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "dropdown", "default": "dropdown", "title": "Type", "type": "string" }, "options": { "anyOf": [ { "items": { "type": "boolean" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "format": "date", "type": "string" }, "type": "array" }, { "items": { "$ref": "#/$defs/_OptionsDictType" }, "type": "array" } ], "default": [], "title": "Options" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "format": "date", "type": "string" }, { "items": { "type": "boolean" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "format": "date", "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Value" }, "multi": { "default": true, "description": "Whether to allow selection of multiple values", "title": "Multi", "type": "boolean" }, "title": { "default": "", "description": "Title to be displayed", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Dropdown", "type": "object" }, "Figure": { "additionalProperties": false, "description": "Object that is reactive to controls, for example a KPI card.\n\nAbstract: Usage documentation\n [How to use figures](../user-guides/figure.md)\n\nArgs:\n figure (CapturedCallable): Function that returns a figure-like object. See [`vizro.figures`][vizro.figures].\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "figure", "default": "figure", "title": "Type", "type": "string" }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Figure", "type": "object" }, "Filter": { "additionalProperties": false, "description": "Filter the data supplied to `targets`.\n\nAbstract: Usage documentation\n [How to use filters](../user-guides/filters.md)\n\nArgs:\n column (str): Column of `DataFrame` to filter.\n targets (list[ModelID]): Target component to be affected by filter. If none are given then target all components\n on the page that use `column`. Defaults to `[]`.\n selector (SelectorType | None): See [SelectorType][vizro.models.types.SelectorType]. Defaults to `None`.\n show_in_url (bool): Whether the filter should be included in the URL query string. Defaults to `False`.\n Useful for bookmarking or sharing dashboards with specific filter values pre-set.\n visible (bool): Whether the filter should be visible. Defaults to `True`.\n\nExample:\n ```python\n import vizro.models as vm\n\n vm.Filter(column=\"species\")\n ```", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "filter", "default": "filter", "title": "Type", "type": "string" }, "column": { "description": "Column of DataFrame to filter.", "title": "Column", "type": "string" }, "targets": { "default": [], "description": "Target component to be affected by filter. If none are given then target all components on the page that use `column`.", "items": { "type": "string" }, "title": "Targets", "type": "array" }, "selector": { "anyOf": [ { "description": "Selectors to be used inside a control.", "discriminator": { "mapping": { "checklist": "#/$defs/Checklist", "date_picker": "#/$defs/DatePicker", "dropdown": "#/$defs/Dropdown", "radio_items": "#/$defs/RadioItems", "range_slider": "#/$defs/RangeSlider", "slider": "#/$defs/Slider", "switch": "#/$defs/Switch" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Checklist" }, { "$ref": "#/$defs/DatePicker" }, { "$ref": "#/$defs/Dropdown" }, { "$ref": "#/$defs/RadioItems" }, { "$ref": "#/$defs/RangeSlider" }, { "$ref": "#/$defs/Slider" }, { "$ref": "#/$defs/Switch" } ] }, { "type": "null" } ], "default": null, "title": "Selector" }, "show_in_url": { "default": false, "description": "Whether the filter should be included in the URL query string. Defaults to `False`. Useful for bookmarking or sharing dashboards with specific filter values pre-set.", "title": "Show In Url", "type": "boolean" }, "visible": { "default": true, "description": "Whether the filter should be visible. Defaults to `True`.", "title": "Visible", "type": "boolean" } }, "required": ["column"], "title": "Filter", "type": "object" }, "Flex": { "additionalProperties": false, "description": "Flex layout for components on a [`Page`][vizro.models.Page] or in a [`Container`][vizro.models.Container].\n\nAbstract: Usage documentation\n [How to use the Flex layout](../user-guides/layouts.md#flex-layout)\n\nArgs:\n direction (Literal[\"row\", \"column\"]): Sets the direction of the flex items inside the container. Options are\n `row` or `column`. Defaults to `column`.\n gap (str): Specifies the gap between rows and columns. Allowed units: 'px', 'rem', 'em', or '%'.\n Defaults to `24px`.\n wrap (bool): Determines whether flex items are forced onto a single line or can wrap onto multiple lines.\n If `False`, all items will be on one line. If `True`, items will wrap onto multiple lines.\n Defaults to `False`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "flex", "default": "flex", "title": "Type", "type": "string" }, "direction": { "default": "column", "description": "Sets the direction of the flex items inside the container. Options are `row` or `column`.Defaults to `column`.", "enum": ["row", "column"], "title": "Direction", "type": "string" }, "gap": { "default": "24px", "description": "Specifies the gap between rows and columns. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Gap", "type": "string" }, "wrap": { "default": false, "description": "Determines whether flex items are forced onto a single line or can wrap onto multiple lines. If `False`, all items will be on one line. If `True`, items will wrap onto multiple lines. Defaults to `False`.", "title": "Wrap", "type": "boolean" } }, "title": "Flex", "type": "object" }, "Graph": { "additionalProperties": false, "description": "Wrapper for `dcc.Graph` to visualize charts.\n\nAbstract: Usage documentation\n [How to use graphs](../user-guides/graph.md)\n\nArgs:\n figure (CapturedCallable): Function that returns a graph. Either use\n [`vizro.plotly.express`](../user-guides/graph.md) or see\n [`CapturedCallable`][vizro.models.types.CapturedCallable].\n title (str): Title of the `Graph`. Defaults to `\"\"`.\n header (str): Markdown text positioned below the `Graph.title`. Follows the CommonMark specification.\n Ideal for adding supplementary information such as subtitles, descriptions, or additional context.\n Defaults to `\"\"`.\n footer (str): Markdown text positioned below the `Graph`. Follows the CommonMark specification.\n Ideal for providing further details such as sources, disclaimers, or additional notes. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (dict[str, Any]): Extra keyword arguments that are passed to `dcc.Graph` 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/graph#graph-properties)\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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "graph", "default": "graph", "title": "Type", "type": "string" }, "title": { "default": "", "description": "Title of the `Graph`", "title": "Title", "type": "string" }, "header": { "default": "", "description": "Markdown text positioned below the `Graph.title`. Follows the CommonMark specification. Ideal for adding supplementary information such as subtitles, descriptions, or additional context.", "title": "Header", "type": "string" }, "footer": { "default": "", "description": "Markdown text positioned below the `Graph`. Follows the CommonMark specification. Ideal for providing further details such as sources, disclaimers, or additional notes.", "title": "Footer", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Graph", "type": "object" }, "Grid": { "additionalProperties": false, "description": "Grid layout for components on a [`Page`][vizro.models.Page] or in a [`Container`][vizro.models.Container].\n\nAbstract: Usage documentation\n [How to use the Grid layout](../user-guides/layouts.md#grid-layout)\n\nArgs:\n grid (list[list[int]]): Grid specification to arrange components on screen.\n row_gap (str): Specifies the gap between rows. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.\n col_gap (str): Specifies the gap between columns. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.\n row_min_height (str): Minimum row height in px. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `0px`.\n col_min_width (str): Minimum column width in px. Allowed unit are: 'px', 'rem', 'em', or '%'. Defaults to `0px`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "grid", "default": "grid", "title": "Type", "type": "string" }, "grid": { "description": "Grid specification to arrange components on screen.", "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Grid", "type": "array" }, "row_gap": { "default": "24px", "description": "Specifies the gap between rows. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Row Gap", "type": "string" }, "col_gap": { "default": "24px", "description": "Specifies the gap between columns. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Col Gap", "type": "string" }, "row_min_height": { "default": "0px", "description": "Minimum row height in px. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `0px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Row Min Height", "type": "string" }, "col_min_width": { "default": "0px", "description": "Minimum column width in px. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `0px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Col Min Width", "type": "string" } }, "required": ["grid"], "title": "Grid", "type": "object" }, "JsonValue": {}, "Layout": { "additionalProperties": false, "deprecated": true, "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "legacy_layout", "default": "legacy_layout", "title": "Type", "type": "string" }, "grid": { "description": "Grid specification to arrange components on screen.", "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Grid", "type": "array" }, "row_gap": { "default": "24px", "description": "Specifies the gap between rows. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Row Gap", "type": "string" }, "col_gap": { "default": "24px", "description": "Specifies the gap between columns. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `24px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Col Gap", "type": "string" }, "row_min_height": { "default": "0px", "description": "Minimum row height in px. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `0px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Row Min Height", "type": "string" }, "col_min_width": { "default": "0px", "description": "Minimum column width in px. Allowed units: 'px', 'rem', 'em', or '%'. Defaults to `0px`.", "pattern": "^\\d+(px|rem|em|%)$", "title": "Col Min Width", "type": "string" } }, "required": ["grid"], "title": "Layout", "type": "object" }, "NavBar": { "additionalProperties": false, "description": "Navigation bar to be used as a `nav_selector` for `Navigation`.\n\nAbstract: Usage documentation\n [How to use the navigation bar](../user-guides/navigation.md#use-a-navigation-bar-with-icons)\n\nArgs:\n pages (dict[str, list[ModelID]]): Mapping from name of a pages group to a list of page IDs/titles.\n Defaults to `{}`.\n items (list[NavLink]): See [`NavLink`][vizro.models.NavLink]. Defaults to `[]`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "nav_bar", "default": "nav_bar", "title": "Type", "type": "string" }, "pages": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "default": {}, "description": "Mapping from name of a pages group to a list of page IDs/titles.", "title": "Pages", "type": "object" }, "items": { "default": [], "items": { "$ref": "#/$defs/NavLink" }, "title": "Items", "type": "array" } }, "title": "NavBar", "type": "object" }, "NavLink": { "additionalProperties": false, "description": "Icon that serves as a navigation link to be used in a [`NavBar`][vizro.models.NavBar].\n\nAbstract: Usage documentation\n [How to customize the NavBar icons](../user-guides/navigation.md#change-icons)\n\nArgs:\n pages (NavPagesType): See [`NavPagesType`][vizro.models.types.NavPagesType]. Defaults to `[]`.\n label (str): Text description of the icon for use in tooltip.\n icon (str): Icon name from [Google Material icons library](https://fonts.google.com/icons). Defaults to `\"\"`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "pages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" } ], "default": [], "title": "Pages" }, "label": { "description": "Text description of the icon for use in tooltip.", "title": "Label", "type": "string" }, "icon": { "default": "", "description": "Icon name from Google Material icons library.", "title": "Icon", "type": "string" } }, "required": ["label"], "title": "NavLink", "type": "object" }, "Navigation": { "additionalProperties": false, "description": "Navigation to arrange hierarchy of [`Pages`][vizro.models.Page].\n\nAbstract: Usage documentation\n [How to customize the navigation](../user-guides/navigation.md)\n\nArgs:\n pages (NavPagesType): See [`NavPagesType`][vizro.models.types.NavPagesType]. Defaults to `[]`.\n nav_selector (NavSelectorType | None): See [`NavSelectorType`][vizro.models.types.NavSelectorType].\n Defaults to `None`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "pages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" } ], "default": [], "title": "Pages" }, "nav_selector": { "anyOf": [ { "description": "Component for rendering navigation.", "discriminator": { "mapping": { "accordion": "#/$defs/Accordion", "nav_bar": "#/$defs/NavBar" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Accordion" }, { "$ref": "#/$defs/NavBar" } ] }, { "type": "null" } ], "default": null, "title": "Nav Selector" } }, "title": "Navigation", "type": "object" }, "Page": { "additionalProperties": false, "description": "A page in [`Dashboard`][vizro.models.Dashboard] with its own URL path and place in the `Navigation`.\n\nAbstract: Usage documentation\n [How to make dashboard pages](../user-guides/pages.md)\n\nArgs:\n components (list[ComponentType]): See [ComponentType][vizro.models.types.ComponentType]. At least one component\n has to be provided.\n title (str): Title of the `Page`.\n layout (LayoutType | None): Layout to place components in. Defaults to `None`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. This also sets the page's meta\n tags. Defaults to `None`.\n controls (list[ControlType]): See [ControlType][vizro.models.types.ControlType]. Defaults to `[]`.\n path (str): Path to navigate to page. Defaults to `\"\"`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "components": { "items": { "description": "Component that makes up part of the layout on the page.", "discriminator": { "mapping": { "ag_grid": "#/$defs/AgGrid", "button": "#/$defs/Button", "card": "#/$defs/Card", "container": "#/$defs/Container", "figure": "#/$defs/Figure", "graph": "#/$defs/Graph", "table": "#/$defs/Table", "tabs": "#/$defs/Tabs", "text": "#/$defs/Text" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/AgGrid" }, { "$ref": "#/$defs/Button" }, { "$ref": "#/$defs/Card" }, { "$ref": "#/$defs/Container" }, { "$ref": "#/$defs/Figure" }, { "$ref": "#/$defs/Graph" }, { "$ref": "#/$defs/Text" }, { "$ref": "#/$defs/Table" }, { "$ref": "#/$defs/Tabs" } ] }, "minItems": 1, "title": "Components", "type": "array" }, "title": { "description": "Title of the `Page`", "title": "Title", "type": "string" }, "layout": { "anyOf": [ { "description": "Type of layout to place components on the page.", "oneOf": [ { "$ref": "#/$defs/Grid" }, { "$ref": "#/$defs/Flex" }, { "$ref": "#/$defs/Layout" } ] }, { "type": "null" } ], "default": null, "title": "Layout" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. This also sets the page's meta\n tags. Defaults to `None`." }, "controls": { "default": [], "items": { "description": "Control that affects components on the page.", "discriminator": { "mapping": { "filter": "#/$defs/Filter", "parameter": "#/$defs/Parameter" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Filter" }, { "$ref": "#/$defs/Parameter" } ] }, "title": "Controls", "type": "array" }, "path": { "default": "", "description": "Path to navigate to page.", "title": "Path", "type": "string" }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "required": ["components", "title"], "title": "Page", "type": "object" }, "Parameter": { "additionalProperties": false, "description": "Alter the arguments supplied to any `targets`.\n\nAbstract: Usage documentation\n [How to use parameters](../user-guides/parameters.md)\n\nExample:\n ```python\n import vizro.models as vm\n\n vm.Parameter(targets=[\"scatter.x\"], selector=vm.Slider(min=0, max=1, default=0.8, title=\"Bubble opacity\"))\n ```\n\nArgs:\n targets (list[str]): Targets in the form of `<target_component>.<target_argument>`.\n selector (SelectorType): See [SelectorType][vizro.models.types.SelectorType]. Converts selector value\n `\"NONE\"` into `None` to allow optional parameters.\n show_in_url (bool): Whether the parameter should be included in the URL query string. Defaults to `False`.\n Useful for bookmarking or sharing dashboards with specific parameter values pre-set.\n visible (bool): Whether the parameter should be visible. Defaults to `True`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "parameter", "default": "parameter", "title": "Type", "type": "string" }, "targets": { "items": { "description": "Targets in the form of `<target_component>.<target_argument>`.", "type": "string" }, "title": "Targets", "type": "array" }, "selector": { "description": "Selectors to be used inside a control.", "discriminator": { "mapping": { "checklist": "#/$defs/Checklist", "date_picker": "#/$defs/DatePicker", "dropdown": "#/$defs/Dropdown", "radio_items": "#/$defs/RadioItems", "range_slider": "#/$defs/RangeSlider", "slider": "#/$defs/Slider", "switch": "#/$defs/Switch" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Checklist" }, { "$ref": "#/$defs/DatePicker" }, { "$ref": "#/$defs/Dropdown" }, { "$ref": "#/$defs/RadioItems" }, { "$ref": "#/$defs/RangeSlider" }, { "$ref": "#/$defs/Slider" }, { "$ref": "#/$defs/Switch" } ], "title": "Selector" }, "show_in_url": { "default": false, "description": "Whether the parameter should be included in the URL query string. Defaults to `False`. Useful for bookmarking or sharing dashboards with specific parameter values pre-set.", "title": "Show In Url", "type": "boolean" }, "visible": { "default": true, "description": "Whether the parameter should be visible. Defaults to `True`.", "title": "Visible", "type": "boolean" } }, "required": ["targets", "selector"], "title": "Parameter", "type": "object" }, "RadioItems": { "additionalProperties": false, "description": "Categorical single-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use categorical selectors](../user-guides/selectors.md/#categorical-selectors)\n\nArgs:\n options (OptionsType): See [`OptionsType`][vizro.models.types.OptionsType]. Defaults to `[]`.\n value (SingleValueType | None): See [`SingleValueType`][vizro.models.types.SingleValueType].\n Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (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://www.dash-bootstrap-components.com/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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "radio_items", "default": "radio_items", "title": "Type", "type": "string" }, "options": { "anyOf": [ { "items": { "type": "boolean" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "format": "date", "type": "string" }, "type": "array" }, { "items": { "$ref": "#/$defs/_OptionsDictType" }, "type": "array" } ], "default": [], "title": "Options" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "title": { "default": "", "description": "Title to be displayed", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "RadioItems", "type": "object" }, "RangeSlider": { "additionalProperties": false, "description": "Numeric multi-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use numerical selectors](../user-guides/selectors.md/#numerical-selectors)\n\nArgs:\n min (float | None): Start value for slider. Defaults to `None`.\n max (float | None): End value for slider. Defaults to `None`.\n step (float | None): Step-size for marks on slider. Defaults to `None`.\n marks (dict[float, str]): Marks to be displayed on slider. Defaults to `{}`.\n value (list[float] | None): Default start and end value for slider. Must be 2 items. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "range_slider", "default": "range_slider", "title": "Type", "type": "string" }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Start value for slider.", "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "End value for slider.", "title": "Max" }, "step": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Step-size for marks on slider.", "title": "Step" }, "marks": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": {}, "description": "Marks to be displayed on slider.", "title": "Marks" }, "value": { "anyOf": [ { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, { "type": "null" } ], "default": null, "title": "Value" }, "title": { "default": "", "description": "Title to be displayed.", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "RangeSlider", "type": "object" }, "Slider": { "additionalProperties": false, "description": "Numeric single-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use numerical selectors](../user-guides/selectors.md/#numerical-selectors)\n\nArgs:\n min (float | None): Start value for slider. Defaults to `None`.\n max (float | None): End value for slider. Defaults to `None`.\n step (float | None): Step-size for marks on slider. Defaults to `None`.\n marks (dict[float, str]): Marks to be displayed on slider. Defaults to `{}`.\n value (float | None): Default value for slider. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "slider", "default": "slider", "title": "Type", "type": "string" }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Start value for slider.", "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "End value for slider.", "title": "Max" }, "step": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Step-size for marks on slider.", "title": "Step" }, "marks": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": {}, "description": "Marks to be displayed on slider.", "title": "Marks" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Default value for slider.", "title": "Value" }, "title": { "default": "", "description": "Title to be displayed.", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Slider", "type": "object" }, "Switch": { "additionalProperties": false, "description": "Boolean single-option selector.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\n\nAbstract: Usage documentation\n [How to use boolean selectors](../user-guides/selectors.md/#boolean-selectors)\n\nArgs:\n value (bool): Initial state of the switch. When `True`, the switch is \"on\".\n When `False`, the switch is \"off\". Defaults to `False`.\n title (str): Title/Label to be displayed to the right of the switch. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].\n extra (dict[str, Any]): Extra keyword arguments that are passed to `dbc.Switch` and overwrite any\n defaults chosen by the Vizro team. This may have unexpected behavior.\n Visit the [dbc documentation](https://www.dash-bootstrap-components.com/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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "switch", "default": "switch", "title": "Type", "type": "string" }, "value": { "default": false, "description": "Initial state of the switch. When `True`, the switch is enabled/on.\n When `False`, the switch is disabled/off. Defaults to `False`.", "title": "Value", "type": "boolean" }, "title": { "default": "", "description": "Title/Label to be displayed to the right of the switch.", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Switch", "type": "object" }, "Table": { "additionalProperties": false, "description": "Wrapper for `dash_table.DataTable` to visualize tables in dashboard.\n\nAbstract: Usage documentation\n [How to use tables](../user-guides/table.md)\n\nArgs:\n figure (CapturedCallable): Function that returns a Dash DataTable. See [`vizro.tables`][vizro.tables].\n title (str): Title of the `Table`. Defaults to `\"\"`.\n header (str): Markdown text positioned below the `Table.title`. Follows the CommonMark specification.\n Ideal for adding supplementary information such as subtitles, descriptions, or additional context.\n Defaults to `\"\"`.\n footer (str): Markdown text positioned below the `Table`. Follows the CommonMark specification.\n Ideal for providing further details such as sources, disclaimers, or additional notes. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.\n actions (ActionsType): See [`ActionsType`][vizro.models.types.ActionsType].", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "table", "default": "table", "title": "Type", "type": "string" }, "title": { "default": "", "description": "Title of the `Table`", "title": "Title", "type": "string" }, "header": { "default": "", "description": "Markdown text positioned below the `Table.title`. Follows the CommonMark specification. Ideal for adding supplementary information such as subtitles, descriptions, or additional context.", "title": "Header", "type": "string" }, "footer": { "default": "", "description": "Markdown text positioned below the `Table`. Follows the CommonMark specification. Ideal for providing further details such as sources, disclaimers, or additional notes.", "title": "Footer", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." }, "actions": { "default": [], "items": { "description": "Action.", "oneOf": [ { "$ref": "#/$defs/Action" }, { "$ref": "#/$defs/export_data" }, { "$ref": "#/$defs/filter_interaction" }, { "$ref": "#/$defs/set_control" } ] }, "title": "Actions", "type": "array" } }, "title": "Table", "type": "object" }, "Tabs": { "additionalProperties": false, "description": "Tabs to group together a set of [`Containers`][vizro.models.Container].\n\nAbstract: Usage documentation\n [How to use tabs](../user-guides/tabs.md)\n\nArgs:\n tabs (list[Container]): See [`Container`][vizro.models.Container].\n title (str): Title displayed above Tabs. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "tabs", "default": "tabs", "title": "Type", "type": "string" }, "tabs": { "items": { "$ref": "#/$defs/Container" }, "minItems": 1, "title": "Tabs", "type": "array" }, "title": { "default": "", "description": "Title displayed above Tabs.", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. Defaults to `None`." } }, "required": ["tabs"], "title": "Tabs", "type": "object" }, "Text": { "additionalProperties": false, "description": "Text based on Markdown syntax.\n\nAbstract: Usage documentation\n [How to add text to your page](../user-guides/text.md)\n\nArgs:\n text (str): Markdown string to create text that should adhere to the CommonMark Spec.\n extra (dict[str, Any]): Extra keyword arguments that are passed to `dcc.Markdown` 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/markdown/)\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": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "text", "default": "text", "title": "Type", "type": "string" }, "text": { "description": "Markdown string to create text that should adhere to the CommonMark Spec.", "title": "Text", "type": "string" } }, "required": ["text"], "title": "Text", "type": "object" }, "Tooltip": { "additionalProperties": false, "description": "A tooltip that displays text when hovering over an icon.\n\nAbstract: Usage documentation\n Read more about usage in the guides on [dashboards](../user-guides/dashboard.md#add-a-dashboard-tooltip),\n [pages](../user-guides/pages.md#add-a-tooltip),\n [containers](../user-guides/container.md#add-a-tooltip),\n [graphs](../user-guides/graph.md#add-a-tooltip),\n [tables](../user-guides/table.md#add-a-tooltip), [tabs](../user-guides/tabs.md#add-a-tooltip),\n [selectors](../user-guides/selectors.md#add-a-tooltip) and\n [buttons](../user-guides/button.md#add-a-tooltip).\n\nArgs:\n text (str): Markdown string for text shown when hovering over the icon. Should adhere to the CommonMark Spec.\n icon (str): Icon name from [Google Material icons library](https://fonts.google.com/icons).\n extra (dict[str, Any]): Extra keyword arguments that are passed to `dbc.Tooltip` and overwrite any\n chosen by the Vizro team. This may have unexpected behavior. Visit the\n [dbc documentation](https://www.dash-bootstrap-components.com/docs/components/tooltip/)\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 `{}`.\n\nExample: `Tooltip` on a [`Checklist`][vizro.models.Checklist] selector\n ```python\n import vizro.models as vm\n\n vm.Checklist(\n title=\"Select Species\",\n description=vm.Tooltip(text=\"Select something\", icon=\"start\"),\n )\n ```", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "text": { "description": "Markdown string for text shown when hovering over the icon. Should adhere to the CommonMark Spec.", "title": "Text", "type": "string" }, "icon": { "description": "Icon name from Google Material icons library.", "title": "Icon", "type": "string" } }, "required": ["text", "icon"], "title": "Tooltip", "type": "object" }, "_OptionsDictType": { "additionalProperties": false, "description": "Permissible sub-type for OptionsType. Needs to be in the format of {\"label\": XXX, \"value\": XXX}.", "properties": { "label": { "title": "Label", "type": "string" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "format": "date", "type": "string" } ], "title": "Value" } }, "required": ["label", "value"], "title": "_OptionsDictType", "type": "object" }, "export_data": { "additionalProperties": false, "description": "Exports data of target charts, tables and figures.\n\nAbstract: Usage documentation\n [How to export data](../user-guides/data-actions.md#export-data)\n\nArgs:\n targets (list[ModelID]): List of target component ids for which to download data. If none are given then\n download data from all components on the page.\n file_format (Literal[\"csv\", \"xlsx\"]): Format of downloaded files. Defaults to `\"csv\"`.\n\nExample:\n ```python\n import vizro.actions as va\n\n vm.Button(\n text=\"Export data\",\n actions=va.export_data(targets=[\"graph_id\", \"table_id\"], file_format=\"xlsx\"),\n )\n ```", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "export_data", "default": "export_data", "title": "Type", "type": "string" }, "targets": { "default": [], "description": "List of target component ids for which to download data. If none are given then download data from all components on the page.", "items": { "type": "string" }, "title": "Targets", "type": "array" }, "file_format": { "default": "csv", "description": "Format of downloaded files. Defaults to `'csv'`.", "enum": ["csv", "xlsx"], "title": "File Format", "type": "string" } }, "title": "export_data", "type": "object" }, "filter_interaction": { "additionalProperties": false, "deprecated": true, "description": "Filters targeted graph, tables and figures when a source graph or table is clicked.\n\nArgs:\n targets (list[ModelID]): Target component to be affected by filter. If none are given then target all\n valid components on the page.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "filter_interaction", "default": "filter_interaction", "title": "Type", "type": "string" }, "targets": { "default": [], "description": "Target component IDs.", "items": { "type": "string" }, "title": "Targets", "type": "array" } }, "title": "filter_interaction", "type": "object" }, "set_control": { "additionalProperties": false, "description": "Sets the value of a control, which then updates its targets.\n\nAbstract: Usage documentation\n [Graph and table interactions](../user-guides/graph-table-actions.md)\n\nThe following Vizro models can be a source of `set_control`:\n\n* [`AgGrid`][vizro.models.AgGrid]: triggers `set_control` when user clicks on a row in the table. `value` is string\nspecifying which column in the clicked row is used to set `control`.\n* [`Graph`][vizro.models.Graph]: triggers `set_control` when user clicks on data in the graph. `value` is string\nthat can be used in two ways to specify how to set `control`:\n\n * Column from which to take the value. This requires you to set `custom_data` in the graph's `figure` function.\n * String to [traverse a Box](https://github.com/cdgriffith/Box/wiki/Types-of-Boxes#box-dots) that contains the\n trigger data [`clickData[\"points\"][0]`](https://dash.plotly.com/interactive-graphing). This is typically\n useful for a positional variable, for example `\"x\"`, and does not require setting `custom_data`.\n\n* [`Figure`][vizro.models.Figure]: triggers `set_control` when user clicks on the figure. `value` specifies a\nliteral value to set `control` to.\n* [`Button`][vizro.models.Button]: triggers `set_control` when user clicks on the button. `value` specifies a\nliteral value to set `control` to.\n* [`Card`][vizro.models.Card]: triggers `set_control` when user clicks on the card. `value` specifies a\nliteral value to set `control` to.\n\nArgs:\n control (ModelID): Control whose value is set. If this is on a different page from the trigger then it must have\n `show_in_url=True`. The control's selector must be categorical (e.g. Dropdown, RadioItems, Checklist).\n value (JsonValue): Value taken from trigger to set `control`. Format depends on the source model that triggers\n `set_control`.\n\nExample: `AgGrid` as trigger\n ```python\n import vizro.actions as va\n\n vm.AgGrid(\n figure=dash_ag_grid(iris),\n actions=va.set_control(control=\"target_control\", value=\"species\"),\n )\n ```\n\nExample: `Graph` as trigger with `custom_data`\n ```python\n import vizro.actions as va\n\n vm.Graph(\n figure=px.scatter(iris, x=\"sepal_width\", y=\"sepal_length\", custom_data=\"species\"),\n actions=va.set_control(control=\"target_control\", value=\"species\"),\n )\n ```\n\nExample: `Graph` as trigger without `custom_data`\n ```python\n import vizro.actions as va\n\n vm.Graph(\n figure=px.box(iris, x=\"species\", y=\"sepal_length\"),\n actions=va.set_control(control=\"target_control\", value=\"x\"),\n )\n ```\n\nExample: `Figure` as trigger\n ```python\n import vizro.actions as va\n from vizro.figures import kpi_card\n\n vm.Figure(\n figure=kpi_card(tips, value_column=\"tip\", title=\"Click KPI to set control to A\"),\n actions=va.set_control(control=\"target_control\", value=\"A\"),\n )\n ```\n\nExample: `Button` as trigger\n ```python\n import vizro.actions as va\n\n vm.Button(\n text=\"Click to set control to A\",\n actions=va.set_control(control=\"target_control\", value=\"A\"),\n )\n ```\n\nExample: `Card` as trigger\n ```python\n import vizro.actions as va\n\n vm.Card(\n title=\"Click Card to set control to A\",\n actions=va.set_control(control=\"target_control\", value=\"A\"),\n )\n ```", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "type": { "const": "set_control", "default": "set_control", "title": "Type", "type": "string" }, "control": { "description": "Filter or Parameter component id to be affected by the trigger.If the control is on a different page to the trigger then it must have `show_in_url=True`.", "title": "Control", "type": "string" }, "value": { "$ref": "#/$defs/JsonValue", "description": "Value to take from trigger and send to the `target`. Format depends on the model that triggers `set_control`." } }, "required": ["control", "value"], "title": "set_control", "type": "object" } }, "additionalProperties": false, "description": "Dashboard that is supplied to [`Vizro.build`][vizro.Vizro.build].\n\nAbstract: Usage documentation\n [How to create a dashboard](../user-guides/dashboard.md)\n\nArgs:\n pages (list[Page]): See [`Page`][vizro.models.Page].\n theme (Literal[\"vizro_dark\", \"vizro_light\"]): Layout theme to be applied across dashboard.\n Defaults to `vizro_dark`.\n navigation (Navigation): See [`Navigation`][vizro.models.Navigation]. Defaults to `None`.\n title (str): Dashboard title to appear on every page on top left-side. Defaults to `\"\"`.\n description (Tooltip | None): Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. This also sets the page's meta\n tags. Defaults to `None`.", "properties": { "id": { "description": "ID to identify model. Must be unique throughout the whole dashboard. When no ID is chosen, ID will be automatically generated.", "title": "Id", "type": "string" }, "pages": { "items": { "$ref": "#/$defs/Page" }, "title": "Pages", "type": "array" }, "theme": { "default": "vizro_dark", "description": "Theme to be applied across dashboard. Defaults to `vizro_dark`.", "enum": ["vizro_dark", "vizro_light"], "title": "Theme", "type": "string" }, "navigation": { "anyOf": [ { "$ref": "#/$defs/Navigation" }, { "type": "null" } ], "default": null }, "title": { "default": "", "description": "Dashboard title to appear on every page on top left-side.", "title": "Title", "type": "string" }, "description": { "anyOf": [ { "$ref": "#/$defs/Tooltip" }, { "type": "null" } ], "default": null, "description": "Optional markdown string that adds an icon next to the title.\n Hovering over the icon shows a tooltip with the provided description. This also sets the page's meta\n tags. Defaults to `None`." } }, "required": ["pages"], "title": "Dashboard", "type": "object" }