From ef3e2ae313550d07a6b92ba38a3fa94981d2fc97 Mon Sep 17 00:00:00 2001 From: Li Nguyen <90609403+huong-li-nguyen@users.noreply.github.com> Date: Mon, 15 Apr 2024 10:31:31 +0200 Subject: [PATCH] [Release] Release of vizro 0.1.15 (#421) --- .../20240415_091003_huong_li_nguyen_0_1_15.md | 0 vizro-ai/hatch.toml | 2 +- vizro-core/CHANGELOG.md | 20 + ...6_huong_li_nguyen_replace_css_bootstrap.md | 48 - ..._huong_li_nguyen_add_css_floatingfilter.md | 47 - ...3_huong_li_nguyen_improve_semantics_nav.md | 48 - ..._custom_action_w_custom_component_guide.md | 47 - ...ic_actions_assert_component_equal_tests.md | 48 - ...240402_165352_antony.milne_data_manager.md | 46 - ...o_stichbury_update_core_to_highlight_ai.md | 48 - ..._jo_stichbury_update_guides_subsections.md | 48 - ...240403_124418_alexey_snigir_env_support.md | 48 - ...sic_graca_add_card_icon_styling_example.md | 48 - ...jo_stichbury_update_build_docs_settings.md | 48 - .../20240405_103212_antony.milne_fix_mypy.md | 48 - ...55_huong_li_nguyen_change_theme_default.md | 48 - ...09_110318_huong_li_nguyen_replace_label.md | 48 - ...dija_ratkusic_graca_fix_style_icon_link.md | 48 - ...3_antony.milne_add_data_manager_warning.md | 48 - ...20240415_090419_huong_li_nguyen_0_1_15.md} | 0 vizro-core/hatch.toml | 2 +- vizro-core/schemas/0.1.15.dev0.json | 1388 ----------------- .../schemas/{0.1.14.json => 0.1.15.json} | 0 vizro-core/src/vizro/__init__.py | 2 +- 24 files changed, 23 insertions(+), 2155 deletions(-) rename vizro-core/changelog.d/20240326_100046_nadija_ratkusic_graca_0_1_14.md => vizro-ai/changelog.d/20240415_091003_huong_li_nguyen_0_1_15.md (100%) delete mode 100644 vizro-core/changelog.d/20240325_180146_huong_li_nguyen_replace_css_bootstrap.md delete mode 100644 vizro-core/changelog.d/20240326_111333_huong_li_nguyen_add_css_floatingfilter.md delete mode 100644 vizro-core/changelog.d/20240327_104803_huong_li_nguyen_improve_semantics_nav.md delete mode 100644 vizro-core/changelog.d/20240328_135330_nadija_ratkusic_graca_custom_action_w_custom_component_guide.md delete mode 100644 vizro-core/changelog.d/20240328_163211_petar_pejovic_actions_assert_component_equal_tests.md delete mode 100644 vizro-core/changelog.d/20240402_165352_antony.milne_data_manager.md delete mode 100644 vizro-core/changelog.d/20240402_180814_jo_stichbury_update_core_to_highlight_ai.md delete mode 100644 vizro-core/changelog.d/20240403_123319_jo_stichbury_update_guides_subsections.md delete mode 100644 vizro-core/changelog.d/20240403_124418_alexey_snigir_env_support.md delete mode 100644 vizro-core/changelog.d/20240403_151537_nadija_ratkusic_graca_add_card_icon_styling_example.md delete mode 100644 vizro-core/changelog.d/20240404_112524_jo_stichbury_update_build_docs_settings.md delete mode 100644 vizro-core/changelog.d/20240405_103212_antony.milne_fix_mypy.md delete mode 100644 vizro-core/changelog.d/20240405_135655_huong_li_nguyen_change_theme_default.md delete mode 100644 vizro-core/changelog.d/20240409_110318_huong_li_nguyen_replace_label.md delete mode 100644 vizro-core/changelog.d/20240409_125129_nadija_ratkusic_graca_fix_style_icon_link.md delete mode 100644 vizro-core/changelog.d/20240412_082253_antony.milne_add_data_manager_warning.md rename vizro-core/changelog.d/{20240326_105937_nadija_ratkusic_graca_0_1_15_dev0.md => 20240415_090419_huong_li_nguyen_0_1_15.md} (100%) delete mode 100644 vizro-core/schemas/0.1.15.dev0.json rename vizro-core/schemas/{0.1.14.json => 0.1.15.json} (100%) diff --git a/vizro-core/changelog.d/20240326_100046_nadija_ratkusic_graca_0_1_14.md b/vizro-ai/changelog.d/20240415_091003_huong_li_nguyen_0_1_15.md similarity index 100% rename from vizro-core/changelog.d/20240326_100046_nadija_ratkusic_graca_0_1_14.md rename to vizro-ai/changelog.d/20240415_091003_huong_li_nguyen_0_1_15.md diff --git a/vizro-ai/hatch.toml b/vizro-ai/hatch.toml index 9a4375efb..41a67352b 100644 --- a/vizro-ai/hatch.toml +++ b/vizro-ai/hatch.toml @@ -29,7 +29,7 @@ prep-release = [ "hatch version release", "hatch run changelog:collect", "hatch run changelog:add", - 'echo "Now raise a PR to merge into main with title: Release of vizro-ai $(hatch version)"' + 'echo "Now raise a PR to merge into main with title: [Release] Release of vizro-ai $(hatch version)"' ] pypath = "hatch run python -c 'import sys; print(sys.executable)'" secrets = "pre-commit run gitleaks --all-files" diff --git a/vizro-core/CHANGELOG.md b/vizro-core/CHANGELOG.md index 79a8b45c6..32d513d3e 100644 --- a/vizro-core/CHANGELOG.md +++ b/vizro-core/CHANGELOG.md @@ -11,6 +11,26 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse + + +# 0.1.15 — 2024-04-15 + +## Highlights ✨ + +- Add dynamic data, which can be reloaded while the dashboard is running. An optional caching layer enables efficient refreshes with per-data source timeouts. Visit the [user guide on data](https://vizro.readthedocs.io/en/stable/pages/user-guides/data/) for more details. ([#398](https://github.com/mckinsey/vizro/pull/398)) + +## Changed + +- Replace default bootstrap stylesheet with `vizro-bootstrap` stylesheet. ([#384](https://github.com/mckinsey/vizro/pull/384)) + +- Refactor code and remove custom classNames from `Button`, `Card`, `NavBar` and `NavLink`. ([#384](https://github.com/mckinsey/vizro/pull/384)) + +- Change default continuous color scale to `SEQUENTIAL_CYAN`. ([#407](https://github.com/mckinsey/vizro/pull/407)) + +## Fixed + +- Fix CSS for `floatingFilter` in `AgGrid`. ([#388](https://github.com/mckinsey/vizro/pull/388)) + # 0.1.14 — 2024-03-26 diff --git a/vizro-core/changelog.d/20240325_180146_huong_li_nguyen_replace_css_bootstrap.md b/vizro-core/changelog.d/20240325_180146_huong_li_nguyen_replace_css_bootstrap.md deleted file mode 100644 index 720bb351b..000000000 --- a/vizro-core/changelog.d/20240325_180146_huong_li_nguyen_replace_css_bootstrap.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - -### Changed - -- Replace default bootstrap stylesheet with `vizro-bootstrap` stylesheet. ([#384](https://github.com/mckinsey/vizro/pull/384)) -- Refactor code and remove custom classNames from `Button`, `Card`, `NavBar` and `NavLink`. ([#384](https://github.com/mckinsey/vizro/pull/384)) - - - - diff --git a/vizro-core/changelog.d/20240326_111333_huong_li_nguyen_add_css_floatingfilter.md b/vizro-core/changelog.d/20240326_111333_huong_li_nguyen_add_css_floatingfilter.md deleted file mode 100644 index 99f2e607a..000000000 --- a/vizro-core/changelog.d/20240326_111333_huong_li_nguyen_add_css_floatingfilter.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - -### Fixed - -- Fix CSS for `floatingFilter` in `AgGrid`. ([#388](https://github.com/mckinsey/vizro/pull/388)) - - diff --git a/vizro-core/changelog.d/20240327_104803_huong_li_nguyen_improve_semantics_nav.md b/vizro-core/changelog.d/20240327_104803_huong_li_nguyen_improve_semantics_nav.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240327_104803_huong_li_nguyen_improve_semantics_nav.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240328_135330_nadija_ratkusic_graca_custom_action_w_custom_component_guide.md b/vizro-core/changelog.d/20240328_135330_nadija_ratkusic_graca_custom_action_w_custom_component_guide.md deleted file mode 100644 index a4b60781a..000000000 --- a/vizro-core/changelog.d/20240328_135330_nadija_ratkusic_graca_custom_action_w_custom_component_guide.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - -### Added - -- Add additional examples to docs of using custom components with custom actions. ([#392](https://github.com/mckinsey/vizro/pull/392)) - - - - - diff --git a/vizro-core/changelog.d/20240328_163211_petar_pejovic_actions_assert_component_equal_tests.md b/vizro-core/changelog.d/20240328_163211_petar_pejovic_actions_assert_component_equal_tests.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240328_163211_petar_pejovic_actions_assert_component_equal_tests.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240402_165352_antony.milne_data_manager.md b/vizro-core/changelog.d/20240402_165352_antony.milne_data_manager.md deleted file mode 100644 index c172e1fc9..000000000 --- a/vizro-core/changelog.d/20240402_165352_antony.milne_data_manager.md +++ /dev/null @@ -1,46 +0,0 @@ - - -### Highlights ✨ - -- Add dynamic data, which can be reloaded while the dashboard is running. An optional caching layer enables efficient refreshes with per-data source timeouts. Visit the [user guide on data](https://vizro.readthedocs.io/en/stable/pages/user-guides/data/) for more details. ([#398](https://github.com/mckinsey/vizro/pull/398)) - - - - - - - diff --git a/vizro-core/changelog.d/20240402_180814_jo_stichbury_update_core_to_highlight_ai.md b/vizro-core/changelog.d/20240402_180814_jo_stichbury_update_core_to_highlight_ai.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240402_180814_jo_stichbury_update_core_to_highlight_ai.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240403_123319_jo_stichbury_update_guides_subsections.md b/vizro-core/changelog.d/20240403_123319_jo_stichbury_update_guides_subsections.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240403_123319_jo_stichbury_update_guides_subsections.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240403_124418_alexey_snigir_env_support.md b/vizro-core/changelog.d/20240403_124418_alexey_snigir_env_support.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240403_124418_alexey_snigir_env_support.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240403_151537_nadija_ratkusic_graca_add_card_icon_styling_example.md b/vizro-core/changelog.d/20240403_151537_nadija_ratkusic_graca_add_card_icon_styling_example.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240403_151537_nadija_ratkusic_graca_add_card_icon_styling_example.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240404_112524_jo_stichbury_update_build_docs_settings.md b/vizro-core/changelog.d/20240404_112524_jo_stichbury_update_build_docs_settings.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240404_112524_jo_stichbury_update_build_docs_settings.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240405_103212_antony.milne_fix_mypy.md b/vizro-core/changelog.d/20240405_103212_antony.milne_fix_mypy.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240405_103212_antony.milne_fix_mypy.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240405_135655_huong_li_nguyen_change_theme_default.md b/vizro-core/changelog.d/20240405_135655_huong_li_nguyen_change_theme_default.md deleted file mode 100644 index f1558014b..000000000 --- a/vizro-core/changelog.d/20240405_135655_huong_li_nguyen_change_theme_default.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - -### Changed - -- Change default continuous color scale to `SEQUENTIAL_CYAN`. ([#407](https://github.com/mckinsey/vizro/pull/407)) - - - - - diff --git a/vizro-core/changelog.d/20240409_110318_huong_li_nguyen_replace_label.md b/vizro-core/changelog.d/20240409_110318_huong_li_nguyen_replace_label.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240409_110318_huong_li_nguyen_replace_label.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240409_125129_nadija_ratkusic_graca_fix_style_icon_link.md b/vizro-core/changelog.d/20240409_125129_nadija_ratkusic_graca_fix_style_icon_link.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240409_125129_nadija_ratkusic_graca_fix_style_icon_link.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240412_082253_antony.milne_add_data_manager_warning.md b/vizro-core/changelog.d/20240412_082253_antony.milne_add_data_manager_warning.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240412_082253_antony.milne_add_data_manager_warning.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240326_105937_nadija_ratkusic_graca_0_1_15_dev0.md b/vizro-core/changelog.d/20240415_090419_huong_li_nguyen_0_1_15.md similarity index 100% rename from vizro-core/changelog.d/20240326_105937_nadija_ratkusic_graca_0_1_15_dev0.md rename to vizro-core/changelog.d/20240415_090419_huong_li_nguyen_0_1_15.md diff --git a/vizro-core/hatch.toml b/vizro-core/hatch.toml index 289f7a72e..e6aec4779 100644 --- a/vizro-core/hatch.toml +++ b/vizro-core/hatch.toml @@ -42,7 +42,7 @@ prep-release = [ "rm -rf schemas/*json", "schema", "git add schemas", - 'echo "Now raise a PR to merge into main with title: Release of vizro-core $(hatch version)"' + 'echo "Now raise a PR to merge into main with title: [Release] Release of vizro $(hatch version)"' ] pypath = "python -c 'import sys; print(sys.executable)'" schema = ["python schemas/generate.py {args}", '- hatch run lint --files="schemas/$(hatch version).json" > /dev/null'] diff --git a/vizro-core/schemas/0.1.15.dev0.json b/vizro-core/schemas/0.1.15.dev0.json deleted file mode 100644 index b019142e0..000000000 --- a/vizro-core/schemas/0.1.15.dev0.json +++ /dev/null @@ -1,1388 +0,0 @@ -{ - "title": "Dashboard", - "description": "Vizro Dashboard to be used within [`Vizro`][vizro._vizro.Vizro.build].\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 `\"\"`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "pages": { - "title": "Pages", - "type": "array", - "items": { - "$ref": "#/definitions/Page" - } - }, - "theme": { - "title": "Theme", - "description": "Layout theme to be applied across dashboard. Defaults to `vizro_dark`", - "default": "vizro_dark", - "enum": ["vizro_dark", "vizro_light"], - "type": "string" - }, - "navigation": { - "$ref": "#/definitions/Navigation" - }, - "title": { - "title": "Title", - "description": "Dashboard title to appear on every page on top left-side.", - "default": "", - "type": "string" - } - }, - "required": ["pages"], - "additionalProperties": false, - "definitions": { - "Action": { - "title": "Action", - "description": "Action to be inserted into `actions` of relevant component.\n\nArgs:\n function (CapturedCallable): See [`CapturedCallable`][vizro.models.types.CapturedCallable].\n inputs (List[str]): Inputs in the form `.` passed to the action function.\n Defaults to `[]`.\n outputs (List[str]): Outputs in the form `.` changed by the action function.\n Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "inputs": { - "title": "Inputs", - "description": "Inputs in the form `.` passed to the action function.", - "default": [], - "pattern": "^[^.]+[.][^.]+$", - "type": "array", - "items": { - "type": "string", - "pattern": "^[^.]+[.][^.]+$" - } - }, - "outputs": { - "title": "Outputs", - "description": "Outputs in the form `.` changed by the action function.", - "default": [], - "pattern": "^[^.]+[.][^.]+$", - "type": "array", - "items": { - "type": "string", - "pattern": "^[^.]+[.][^.]+$" - } - } - }, - "additionalProperties": false - }, - "AgGrid": { - "title": "AgGrid", - "description": "Wrapper for `dash-ag-grid.AgGrid` to visualize grids in dashboard.\n\nArgs:\n type (Literal[\"ag_grid\"]): Defaults to `\"ag_grid\"`.\n figure (CapturedCallable): AgGrid like object to be displayed. For more information see:\n [`dash-ag-grid.AgGrid`](https://dash.plotly.com/dash-ag-grid).\n title (str): Title of the table. Defaults to `\"\"`.\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "ag_grid", - "enum": ["ag_grid"], - "type": "string" - }, - "title": { - "title": "Title", - "description": "Title of the AgGrid", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Button": { - "title": "Button", - "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 actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "button", - "enum": ["button"], - "type": "string" - }, - "text": { - "title": "Text", - "description": "Text to be displayed on button.", - "default": "Click me!", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Card": { - "title": "Card", - "description": "Creates a card utilizing `dcc.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 `\"\"`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "card", - "enum": ["card"], - "type": "string" - }, - "text": { - "title": "Text", - "description": "Markdown string to create card title/text that should adhere to the CommonMark Spec.", - "type": "string" - }, - "href": { - "title": "Href", - "description": "URL (relative or absolute) to navigate to. If not provided the Card serves as a text card only.", - "default": "", - "type": "string" - } - }, - "required": ["text"], - "additionalProperties": false - }, - "Graph": { - "title": "Graph", - "description": "Wrapper for `dcc.Graph` to visualize charts in dashboard.\n\nArgs:\n type (Literal[\"graph\"]): Defaults to `\"graph\"`.\n figure (CapturedCallable): See [`CapturedCallable`][vizro.models.types.CapturedCallable].\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "graph", - "enum": ["graph"], - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Table": { - "title": "Table", - "description": "Wrapper for `dash_table.DataTable` to visualize tables in dashboard.\n\nArgs:\n type (Literal[\"table\"]): Defaults to `\"table\"`.\n figure (CapturedCallable): Table like object to be displayed. For more information see:\n [`dash_table.DataTable`](https://dash.plotly.com/datatable).\n title (str): Title of the table. Defaults to `\"\"`.\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "table", - "enum": ["table"], - "type": "string" - }, - "title": { - "title": "Title", - "description": "Title of the table", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Tabs": { - "title": "Tabs", - "description": "Tabs to group together a set of containers on a page.\n\nArgs:\n type (Literal[\"tabs\"]): Defaults to `\"tabs\"`.\n tabs (List[Container]): See [`Container`][vizro.models.Container].", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "tabs", - "enum": ["tabs"], - "type": "string" - }, - "tabs": { - "title": "Tabs", - "type": "array", - "items": { - "$ref": "#/definitions/Container" - } - } - }, - "required": ["tabs"], - "additionalProperties": false - }, - "Layout": { - "title": "Layout", - "description": "Grid specification to place chart/components on the [`Page`][vizro.models.Page].\n\nArgs:\n grid (List[List[int]]): Grid specification to arrange components on screen.\n row_gap (str): Gap between rows in px. Defaults to `\"12px\"`.\n col_gap (str): Gap between columns in px. Defaults to `\"12px\"`.\n row_min_height (str): Minimum row height in px. Defaults to `\"0px\"`.\n col_min_width (str): Minimum column width in px. Defaults to `\"0px\"`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "grid": { - "title": "Grid", - "description": "Grid specification to arrange components on screen.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "row_gap": { - "title": "Row Gap", - "description": "Gap between rows in px. Defaults to 12px.", - "default": "12px", - "pattern": "[0-9]+px", - "type": "string" - }, - "col_gap": { - "title": "Col Gap", - "description": "Gap between columns in px. Defaults to 12px.", - "default": "12px", - "pattern": "[0-9]+px", - "type": "string" - }, - "row_min_height": { - "title": "Row Min Height", - "description": "Minimum row height in px. Defaults to 0px.", - "default": "0px", - "pattern": "[0-9]+px", - "type": "string" - }, - "col_min_width": { - "title": "Col Min Width", - "description": "Minimum column width in px. Defaults to 0px.", - "default": "0px", - "pattern": "[0-9]+px", - "type": "string" - } - }, - "required": ["grid"], - "additionalProperties": false - }, - "Container": { - "title": "Container", - "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 (Layout): Layout to place components in. Defaults to `None`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "container", - "enum": ["container"], - "type": "string" - }, - "components": { - "title": "Components", - "type": "array", - "items": { - "discriminator": { - "propertyName": "type", - "mapping": { - "ag_grid": "#/definitions/AgGrid", - "button": "#/definitions/Button", - "card": "#/definitions/Card", - "container": "#/definitions/Container", - "graph": "#/definitions/Graph", - "table": "#/definitions/Table", - "tabs": "#/definitions/Tabs" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/AgGrid" - }, - { - "$ref": "#/definitions/Button" - }, - { - "$ref": "#/definitions/Card" - }, - { - "$ref": "#/definitions/Container" - }, - { - "$ref": "#/definitions/Graph" - }, - { - "$ref": "#/definitions/Table" - }, - { - "$ref": "#/definitions/Tabs" - } - ] - } - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "type": "string" - }, - "layout": { - "$ref": "#/definitions/Layout" - } - }, - "required": ["components", "title"], - "additionalProperties": false - }, - "OptionsDictType": { - "title": "OptionsDictType", - "type": "object", - "properties": { - "label": { - "title": "Label", - "type": "string" - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "string", - "format": "date" - } - ] - } - }, - "required": ["label", "value"], - "additionalProperties": false - }, - "Checklist": { - "title": "Checklist", - "description": "Categorical multi-option selector `Checklist`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter]. Based on the underlying\n[`dcc.Checklist`](https://dash.plotly.com/dash-core-components/checklist).\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 `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "checklist", - "enum": ["checklist"], - "type": "string" - }, - "options": { - "title": "Options", - "default": [], - "anyOf": [ - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - } - ] - }, - "title": { - "title": "Title", - "description": "Title to be displayed", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "DatePicker": { - "title": "DatePicker", - "description": "Temporal single/range option selector `DatePicker`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or [`Parameter`][vizro.models.Parameter].\nBased on the underlying [`dmc.DatePicker`](https://www.dash-mantine-components.com/components/datepicker) or\n[`dmc.DateRangePicker`](https://www.dash-mantine-components.com/components/datepicker#daterangepicker).\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 (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. Default to `True`.\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "date_picker", - "enum": ["date_picker"], - "type": "string" - }, - "min": { - "title": "Min", - "description": "Start date for date picker.", - "type": "string", - "format": "date" - }, - "max": { - "title": "Max", - "description": "End date for date picker.", - "type": "string", - "format": "date" - }, - "value": { - "title": "Value", - "description": "Default date for date picker", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - }, - { - "type": "string", - "format": "date" - } - ] - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "default": "", - "type": "string" - }, - "range": { - "title": "Range", - "description": "Boolean flag for displaying range picker.", - "default": true, - "type": "boolean" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Dropdown": { - "title": "Dropdown", - "description": "Categorical single/multi-option selector `Dropdown`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter]. Based on the underlying\n[`dcc.Dropdown`](https://dash.plotly.com/dash-core-components/dropdown).\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 `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "dropdown", - "enum": ["dropdown"], - "type": "string" - }, - "options": { - "title": "Options", - "default": [], - "anyOf": [ - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "string", - "format": "date" - }, - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - } - ] - }, - "multi": { - "title": "Multi", - "description": "Whether to allow selection of multiple values", - "default": true, - "type": "boolean" - }, - "title": { - "title": "Title", - "description": "Title to be displayed", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "RadioItems": { - "title": "RadioItems", - "description": "Categorical single-option selector `RadioItems`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter]. Based on the underlying\n[`dcc.RadioItems`](https://dash.plotly.com/dash-core-components/radioitems).\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 `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "radio_items", - "enum": ["radio_items"], - "type": "string" - }, - "options": { - "title": "Options", - "default": [], - "anyOf": [ - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "string", - "format": "date" - } - ] - }, - "title": { - "title": "Title", - "description": "Title to be displayed", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "RangeSlider": { - "title": "RangeSlider", - "description": "Numeric multi-option selector `RangeSlider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter]. Based on the underlying\n[`dcc.RangeSlider`](https://dash.plotly.com/dash-core-components/rangeslider).\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[int, Union[str, dict]]]): 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 `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "range_slider", - "enum": ["range_slider"], - "type": "string" - }, - "min": { - "title": "Min", - "description": "Start value for slider.", - "type": "number" - }, - "max": { - "title": "Max", - "description": "End value for slider.", - "type": "number" - }, - "step": { - "title": "Step", - "description": "Step-size for marks on slider.", - "type": "number" - }, - "marks": { - "title": "Marks", - "description": "Marks to be displayed on slider.", - "default": {}, - "type": "object", - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - } - }, - "value": { - "title": "Value", - "description": "Default start and end value for slider", - "minItems": 2, - "maxItems": 2, - "type": "array", - "items": { - "type": "number" - } - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Slider": { - "title": "Slider", - "description": "Numeric single-option selector `Slider`.\n\nCan be provided to [`Filter`][vizro.models.Filter] or\n[`Parameter`][vizro.models.Parameter]. Based on the underlying\n[`dcc.Slider`](https://dash.plotly.com/dash-core-components/slider).\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[int, Union[str, dict]]]): 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 `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "slider", - "enum": ["slider"], - "type": "string" - }, - "min": { - "title": "Min", - "description": "Start value for slider.", - "type": "number" - }, - "max": { - "title": "Max", - "description": "End value for slider.", - "type": "number" - }, - "step": { - "title": "Step", - "description": "Step-size for marks on slider.", - "type": "number" - }, - "marks": { - "title": "Marks", - "description": "Marks to be displayed on slider.", - "default": {}, - "type": "object", - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - } - }, - "value": { - "title": "Value", - "description": "Default value for slider.", - "type": "number" - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Filter": { - "title": "Filter", - "description": "Filter the data supplied to `targets` on the [`Page`][vizro.models.Page].\n\nExamples:\n >>> print(repr(Filter(column=\"species\")))\n\nArgs:\n type (Literal[\"filter\"]): Defaults to `\"filter\"`.\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`.\n selector (SelectorType): See [SelectorType][vizro.models.types.SelectorType]. Defaults to `None`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "filter", - "enum": ["filter"], - "type": "string" - }, - "column": { - "title": "Column", - "description": "Column of DataFrame to filter.", - "type": "string" - }, - "targets": { - "title": "Targets", - "description": "Target component to be affected by filter. If none are given then target all components on the page that use `column`.", - "default": [], - "type": "array", - "items": { - "type": "string" - } - }, - "selector": { - "title": "Selector", - "description": "Selectors to be used inside a control.", - "discriminator": { - "propertyName": "type", - "mapping": { - "checklist": "#/definitions/Checklist", - "date_picker": "#/definitions/DatePicker", - "dropdown": "#/definitions/Dropdown", - "radio_items": "#/definitions/RadioItems", - "range_slider": "#/definitions/RangeSlider", - "slider": "#/definitions/Slider" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Checklist" - }, - { - "$ref": "#/definitions/DatePicker" - }, - { - "$ref": "#/definitions/Dropdown" - }, - { - "$ref": "#/definitions/RadioItems" - }, - { - "$ref": "#/definitions/RangeSlider" - }, - { - "$ref": "#/definitions/Slider" - } - ] - } - }, - "required": ["column"], - "additionalProperties": false - }, - "Parameter": { - "title": "Parameter", - "description": "Alter the arguments supplied to any `targets` on the [`Page`][vizro.models.Page].\n\nExamples:\n >>> print(repr(Parameter(\n >>> targets=[\"scatter.x\"], selector=Slider(min=0, max=1, default=0.8, title=\"Bubble opacity\"))))\n\nArgs:\n type (Literal[\"parameter\"]): Defaults to `\"parameter\"`.\n targets (List[str]): Targets in the form of `.`.\n selector (SelectorType): See [SelectorType][vizro.models.types.SelectorType]. Converts selector value\n `\"NONE\"` into `None` to allow optional parameters.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "parameter", - "enum": ["parameter"], - "type": "string" - }, - "targets": { - "title": "Targets", - "description": "Targets in the form of `.`.", - "type": "array", - "items": { - "type": "string" - } - }, - "selector": { - "title": "Selector", - "description": "Selectors to be used inside a control.", - "discriminator": { - "propertyName": "type", - "mapping": { - "checklist": "#/definitions/Checklist", - "date_picker": "#/definitions/DatePicker", - "dropdown": "#/definitions/Dropdown", - "radio_items": "#/definitions/RadioItems", - "range_slider": "#/definitions/RangeSlider", - "slider": "#/definitions/Slider" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Checklist" - }, - { - "$ref": "#/definitions/DatePicker" - }, - { - "$ref": "#/definitions/Dropdown" - }, - { - "$ref": "#/definitions/RadioItems" - }, - { - "$ref": "#/definitions/RangeSlider" - }, - { - "$ref": "#/definitions/Slider" - } - ] - } - }, - "required": ["targets", "selector"], - "additionalProperties": false - }, - "ActionsChain": { - "title": "ActionsChain", - "description": "All models that are registered to the model manager should inherit from this class.\n\nArgs:\n id (str): ID to identify model. Must be unique throughout the whole dashboard. Defaults to `\"\"`.\n When no ID is chosen, ID will be automatically generated.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "trigger": { - "title": "Trigger", - "type": "array", - "items": [ - { - "title": "Component Id", - "type": "string" - }, - { - "title": "Component Property", - "type": "string" - } - ], - "minItems": 2, - "maxItems": 2 - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "required": ["trigger"], - "additionalProperties": false - }, - "Page": { - "title": "Page", - "description": "A page in [`Dashboard`][vizro.models.Dashboard] with its own URL path and place in the `Navigation`.\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 to be displayed.\n description (str): Description for meta tags.\n layout (Layout): Layout to place components in. 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 `\"\"`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "components": { - "title": "Components", - "type": "array", - "items": { - "discriminator": { - "propertyName": "type", - "mapping": { - "ag_grid": "#/definitions/AgGrid", - "button": "#/definitions/Button", - "card": "#/definitions/Card", - "container": "#/definitions/Container", - "graph": "#/definitions/Graph", - "table": "#/definitions/Table", - "tabs": "#/definitions/Tabs" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/AgGrid" - }, - { - "$ref": "#/definitions/Button" - }, - { - "$ref": "#/definitions/Card" - }, - { - "$ref": "#/definitions/Container" - }, - { - "$ref": "#/definitions/Graph" - }, - { - "$ref": "#/definitions/Table" - }, - { - "$ref": "#/definitions/Tabs" - } - ] - } - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "type": "string" - }, - "description": { - "title": "Description", - "description": "Description for meta tags.", - "default": "", - "type": "string" - }, - "layout": { - "$ref": "#/definitions/Layout" - }, - "controls": { - "title": "Controls", - "default": [], - "type": "array", - "items": { - "discriminator": { - "propertyName": "type", - "mapping": { - "filter": "#/definitions/Filter", - "parameter": "#/definitions/Parameter" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Filter" - }, - { - "$ref": "#/definitions/Parameter" - } - ] - } - }, - "path": { - "title": "Path", - "description": "Path to navigate to page.", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionsChain" - } - } - }, - "required": ["components", "title"], - "additionalProperties": false - }, - "Accordion": { - "title": "Accordion", - "description": "Accordion to be used as nav_selector in [`Navigation`][vizro.models.Navigation].\n\nArgs:\n type (Literal[\"accordion\"]): Defaults to `\"accordion\"`.\n pages (Dict[str, List[str]]): Mapping from name of a pages group to a list of page IDs. Defaults to `{}`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "accordion", - "enum": ["accordion"], - "type": "string" - }, - "pages": { - "title": "Pages", - "description": "Mapping from name of a pages group to a list of page IDs.", - "default": {}, - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "additionalProperties": false - }, - "NavLink": { - "title": "NavLink", - "description": "Icon that serves as a navigation link to be used in navigation bar of Dashboard.\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 `\"\"`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "pages": { - "title": "Pages", - "default": [], - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - ] - }, - "label": { - "title": "Label", - "description": "Text description of the icon for use in tooltip.", - "type": "string" - }, - "icon": { - "title": "Icon", - "description": "Icon name from Google Material icons library.", - "default": "", - "type": "string" - } - }, - "required": ["label"], - "additionalProperties": false - }, - "NavBar": { - "title": "NavBar", - "description": "Navigation bar to be used as a nav_selector for `Navigation`.\n\nArgs:\n type (Literal[\"nav_bar\"]): Defaults to `\"nav_bar\"`.\n pages (Dict[str, List[str]]): Mapping from name of a pages group to a list of page IDs. Defaults to `{}`.\n items (List[NavLink]): See [`NavLink`][vizro.models.NavLink]. Defaults to `[]`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "type": { - "title": "Type", - "default": "nav_bar", - "enum": ["nav_bar"], - "type": "string" - }, - "pages": { - "title": "Pages", - "description": "Mapping from name of a pages group to a list of page IDs.", - "default": {}, - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "items": { - "title": "Items", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/NavLink" - } - } - }, - "additionalProperties": false - }, - "Navigation": { - "title": "Navigation", - "description": "Navigation in [`Dashboard`][vizro.models.Dashboard] to structure [`Pages`][vizro.models.Page].\n\nArgs:\n pages (NavPagesType): See [`NavPagesType`][vizro.models.types.NavPagesType]. Defaults to `[]`.\n nav_selector (NavSelectorType): See [`NavSelectorType`][vizro.models.types.NavSelectorType].\n Defaults to `None`.", - "type": "object", - "properties": { - "id": { - "title": "Id", - "description": "ID to identify model. Must be unique throughout the whole dashboard.When no ID is chosen, ID will be automatically generated.", - "default": "", - "type": "string" - }, - "pages": { - "title": "Pages", - "default": [], - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - ] - }, - "nav_selector": { - "title": "Nav Selector", - "anyOf": [ - { - "$ref": "#/definitions/Accordion" - }, - { - "$ref": "#/definitions/NavBar" - } - ] - } - }, - "additionalProperties": false - } - } -} diff --git a/vizro-core/schemas/0.1.14.json b/vizro-core/schemas/0.1.15.json similarity index 100% rename from vizro-core/schemas/0.1.14.json rename to vizro-core/schemas/0.1.15.json diff --git a/vizro-core/src/vizro/__init__.py b/vizro-core/src/vizro/__init__.py index 73d49adfe..dcee98db3 100644 --- a/vizro-core/src/vizro/__init__.py +++ b/vizro-core/src/vizro/__init__.py @@ -5,6 +5,6 @@ __all__ = ["Vizro"] -__version__ = "0.1.15.dev0" +__version__ = "0.1.15" logging.basicConfig(level=os.getenv("VIZRO_LOG_LEVEL", "WARNING"))