From 9435b9269e3625a3611004cffa449ae73429b7af Mon Sep 17 00:00:00 2001 From: Li Nguyen <90609403+huong-li-nguyen@users.noreply.github.com> Date: Thu, 25 Jan 2024 12:17:32 +0100 Subject: [PATCH] Release of vizro-core 0.1.9 (#287) --- vizro-core/CHANGELOG.md | 26 + ...g_li_nguyen_replace_selected_components.md | 47 - ...uong_li_nguyen_dashboard_title_position.md | 47 - ...0104_141852_huong_li_nguyen_enable_logo.md | 47 - ...144414_nadija_ratkusic_graca_0_1_9_dev0.md | 48 - ...63349_huong_li_nguyen_enable_containers.md | 46 - ...111254_alexey_snigir_fix_running_status.md | 48 - ...09_140626_huong_li_nguyen_use_ctx_short.md | 48 - ...83336_huong_li_nguyen_warning_bootstrap.md | 48 - ...111807_alexey_snigir_fix_running_status.md | 48 - ...milian_schulz_improve_value_proposition.md | 48 - ...12_161730_huong_li_nguyen_split_up_demo.md | 48 - ...ratkusic_graca_enable_collapsible_panel.md | 47 - ..._nadija_ratkusic_graca_slider_value_bug.md | 47 - ...240119_110922_huong_li_nguyen_fix_table.md | 48 - ...12645_antony.milne_enable_containers_AM.md | 48 - ..._114344_anna_xiong_add_depdency_Pyarrow.md | 48 - ..._200148_huong_li_nguyen_container_model.md | 48 - ...932_huong_li_nguyen_clean_up_docstrings.md | 47 - ...40123_131012_nadija_ratkusic_graca_logo.md | 48 - ... 20240125_114940_huong_li_nguyen_0_1_9.md} | 0 .../docs/pages/user_guides/components.md | 2 + vizro-core/schemas/0.1.8.json | 1106 ----------------- .../schemas/{0.1.9.dev0.json => 0.1.9.json} | 0 vizro-core/src/vizro/__init__.py | 2 +- 25 files changed, 29 insertions(+), 2011 deletions(-) delete mode 100644 vizro-core/changelog.d/20240103_170310_huong_li_nguyen_replace_selected_components.md delete mode 100644 vizro-core/changelog.d/20240103_210035_huong_li_nguyen_dashboard_title_position.md delete mode 100644 vizro-core/changelog.d/20240104_141852_huong_li_nguyen_enable_logo.md delete mode 100644 vizro-core/changelog.d/20240104_144414_nadija_ratkusic_graca_0_1_9_dev0.md delete mode 100644 vizro-core/changelog.d/20240105_163349_huong_li_nguyen_enable_containers.md delete mode 100644 vizro-core/changelog.d/20240109_111254_alexey_snigir_fix_running_status.md delete mode 100644 vizro-core/changelog.d/20240109_140626_huong_li_nguyen_use_ctx_short.md delete mode 100644 vizro-core/changelog.d/20240109_183336_huong_li_nguyen_warning_bootstrap.md delete mode 100644 vizro-core/changelog.d/20240110_111807_alexey_snigir_fix_running_status.md delete mode 100644 vizro-core/changelog.d/20240111_124930_maximilian_schulz_improve_value_proposition.md delete mode 100644 vizro-core/changelog.d/20240112_161730_huong_li_nguyen_split_up_demo.md delete mode 100644 vizro-core/changelog.d/20240112_163629_nadija_ratkusic_graca_enable_collapsible_panel.md delete mode 100644 vizro-core/changelog.d/20240115_110324_nadija_ratkusic_graca_slider_value_bug.md delete mode 100644 vizro-core/changelog.d/20240119_110922_huong_li_nguyen_fix_table.md delete mode 100644 vizro-core/changelog.d/20240122_112645_antony.milne_enable_containers_AM.md delete mode 100644 vizro-core/changelog.d/20240122_114344_anna_xiong_add_depdency_Pyarrow.md delete mode 100644 vizro-core/changelog.d/20240122_200148_huong_li_nguyen_container_model.md delete mode 100644 vizro-core/changelog.d/20240123_093932_huong_li_nguyen_clean_up_docstrings.md delete mode 100644 vizro-core/changelog.d/20240123_131012_nadija_ratkusic_graca_logo.md rename vizro-core/changelog.d/{20240104_125358_nadija_ratkusic_graca_0_1_8.md => 20240125_114940_huong_li_nguyen_0_1_9.md} (100%) delete mode 100644 vizro-core/schemas/0.1.8.json rename vizro-core/schemas/{0.1.9.dev0.json => 0.1.9.json} (100%) diff --git a/vizro-core/CHANGELOG.md b/vizro-core/CHANGELOG.md index b993f04db..af7d6738d 100644 --- a/vizro-core/CHANGELOG.md +++ b/vizro-core/CHANGELOG.md @@ -11,6 +11,32 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse + + +# 0.1.9 — 2024-01-25 + +## Highlights ✨ + +- Introduce `Container` model as a new `Page` component. Visit the [user guide on container](https://vizro.readthedocs.io/en/stable/pages/user_guides/container/) to learn more. ([#254](https://github.com/mckinsey/vizro/pull/254)) + +## Added + +- Enable automatic logo insertion into `page-header` container. ([#248](https://github.com/mckinsey/vizro/pull/248)) + +- Enable the side panel to collapse/expand with a button. ([#225](https://github.com/mckinsey/vizro/pull/225)) + +## Changed + +- Move `dashboard-title` to top header container `page-header`. ([#238](https://github.com/mckinsey/vizro/pull/238)) + +## Fixed + +- Add CSS for `dmc.Switch` and fix CSS when toggle-switch is turned on. ([#244](https://github.com/mckinsey/vizro/pull/244)) + +- Fix bug of `value` argument not properly being evaluated in `Slider` and `RangeSlider`. ([#266](https://github.com/mckinsey/vizro/pull/266)) + +- Fix bug on scrolling and viewport on Safari. ([#277](https://github.com/mckinsey/vizro/pull/277)) + # 0.1.8 — 2024-01-04 diff --git a/vizro-core/changelog.d/20240103_170310_huong_li_nguyen_replace_selected_components.md b/vizro-core/changelog.d/20240103_170310_huong_li_nguyen_replace_selected_components.md deleted file mode 100644 index d6813a9b2..000000000 --- a/vizro-core/changelog.d/20240103_170310_huong_li_nguyen_replace_selected_components.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - -### Fixed - -- Add CSS for `dmc.Switch` and fix CSS when toggle-switch is turned on ([#244](https://github.com/mckinsey/vizro/pull/244)) - - diff --git a/vizro-core/changelog.d/20240103_210035_huong_li_nguyen_dashboard_title_position.md b/vizro-core/changelog.d/20240103_210035_huong_li_nguyen_dashboard_title_position.md deleted file mode 100644 index b9f8ad2d7..000000000 --- a/vizro-core/changelog.d/20240103_210035_huong_li_nguyen_dashboard_title_position.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - -### Changed - -- Move `dashboard-title` to top header container `page-header`. ([#238](https://github.com/mckinsey/vizro/pull/238)) - - - - diff --git a/vizro-core/changelog.d/20240104_141852_huong_li_nguyen_enable_logo.md b/vizro-core/changelog.d/20240104_141852_huong_li_nguyen_enable_logo.md deleted file mode 100644 index 3abb24736..000000000 --- a/vizro-core/changelog.d/20240104_141852_huong_li_nguyen_enable_logo.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - -### Added - -- Enable automatic logo insertion into `page-header` container ([#248](https://github.com/mckinsey/vizro/pull/248)) - - - - - diff --git a/vizro-core/changelog.d/20240104_144414_nadija_ratkusic_graca_0_1_9_dev0.md b/vizro-core/changelog.d/20240104_144414_nadija_ratkusic_graca_0_1_9_dev0.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240104_144414_nadija_ratkusic_graca_0_1_9_dev0.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240105_163349_huong_li_nguyen_enable_containers.md b/vizro-core/changelog.d/20240105_163349_huong_li_nguyen_enable_containers.md deleted file mode 100644 index 3d2013908..000000000 --- a/vizro-core/changelog.d/20240105_163349_huong_li_nguyen_enable_containers.md +++ /dev/null @@ -1,46 +0,0 @@ - - -### Highlights ✨ - -- Introduce `Container` model as a new `Page` component. Visit the [user guide on container](https://vizro.readthedocs.io/en/stable/pages/user_guides/container/) to learn more. ([#254](https://github.com/mckinsey/vizro/pull/254)) - - - - - - - diff --git a/vizro-core/changelog.d/20240109_111254_alexey_snigir_fix_running_status.md b/vizro-core/changelog.d/20240109_111254_alexey_snigir_fix_running_status.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240109_111254_alexey_snigir_fix_running_status.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240109_140626_huong_li_nguyen_use_ctx_short.md b/vizro-core/changelog.d/20240109_140626_huong_li_nguyen_use_ctx_short.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240109_140626_huong_li_nguyen_use_ctx_short.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240109_183336_huong_li_nguyen_warning_bootstrap.md b/vizro-core/changelog.d/20240109_183336_huong_li_nguyen_warning_bootstrap.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240109_183336_huong_li_nguyen_warning_bootstrap.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240110_111807_alexey_snigir_fix_running_status.md b/vizro-core/changelog.d/20240110_111807_alexey_snigir_fix_running_status.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240110_111807_alexey_snigir_fix_running_status.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240111_124930_maximilian_schulz_improve_value_proposition.md b/vizro-core/changelog.d/20240111_124930_maximilian_schulz_improve_value_proposition.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240111_124930_maximilian_schulz_improve_value_proposition.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240112_161730_huong_li_nguyen_split_up_demo.md b/vizro-core/changelog.d/20240112_161730_huong_li_nguyen_split_up_demo.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240112_161730_huong_li_nguyen_split_up_demo.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240112_163629_nadija_ratkusic_graca_enable_collapsible_panel.md b/vizro-core/changelog.d/20240112_163629_nadija_ratkusic_graca_enable_collapsible_panel.md deleted file mode 100644 index f5ba6e99a..000000000 --- a/vizro-core/changelog.d/20240112_163629_nadija_ratkusic_graca_enable_collapsible_panel.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - -### Added - -- Enable the side panel to collapse/expand with a button. ([#225](https://github.com/mckinsey/vizro/pull/225)) - - - - - diff --git a/vizro-core/changelog.d/20240115_110324_nadija_ratkusic_graca_slider_value_bug.md b/vizro-core/changelog.d/20240115_110324_nadija_ratkusic_graca_slider_value_bug.md deleted file mode 100644 index af570f3b3..000000000 --- a/vizro-core/changelog.d/20240115_110324_nadija_ratkusic_graca_slider_value_bug.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - -### Fixed - -- Fix bug of `value` argument not properly being evaluated in `Slider` and `RangeSlider`. ([#266](https://github.com/mckinsey/vizro/pull/266)) - - diff --git a/vizro-core/changelog.d/20240119_110922_huong_li_nguyen_fix_table.md b/vizro-core/changelog.d/20240119_110922_huong_li_nguyen_fix_table.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240119_110922_huong_li_nguyen_fix_table.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240122_112645_antony.milne_enable_containers_AM.md b/vizro-core/changelog.d/20240122_112645_antony.milne_enable_containers_AM.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240122_112645_antony.milne_enable_containers_AM.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240122_114344_anna_xiong_add_depdency_Pyarrow.md b/vizro-core/changelog.d/20240122_114344_anna_xiong_add_depdency_Pyarrow.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240122_114344_anna_xiong_add_depdency_Pyarrow.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240122_200148_huong_li_nguyen_container_model.md b/vizro-core/changelog.d/20240122_200148_huong_li_nguyen_container_model.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240122_200148_huong_li_nguyen_container_model.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240123_093932_huong_li_nguyen_clean_up_docstrings.md b/vizro-core/changelog.d/20240123_093932_huong_li_nguyen_clean_up_docstrings.md deleted file mode 100644 index 9f782c630..000000000 --- a/vizro-core/changelog.d/20240123_093932_huong_li_nguyen_clean_up_docstrings.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - -### Fixed - -- Fix bug on scrolling and viewport on Safari ([#277](https://github.com/mckinsey/vizro/pull/277)) - - diff --git a/vizro-core/changelog.d/20240123_131012_nadija_ratkusic_graca_logo.md b/vizro-core/changelog.d/20240123_131012_nadija_ratkusic_graca_logo.md deleted file mode 100644 index f1f65e73c..000000000 --- a/vizro-core/changelog.d/20240123_131012_nadija_ratkusic_graca_logo.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - diff --git a/vizro-core/changelog.d/20240104_125358_nadija_ratkusic_graca_0_1_8.md b/vizro-core/changelog.d/20240125_114940_huong_li_nguyen_0_1_9.md similarity index 100% rename from vizro-core/changelog.d/20240104_125358_nadija_ratkusic_graca_0_1_8.md rename to vizro-core/changelog.d/20240125_114940_huong_li_nguyen_0_1_9.md diff --git a/vizro-core/docs/pages/user_guides/components.md b/vizro-core/docs/pages/user_guides/components.md index 48be24ecd..cd35d02f4 100755 --- a/vizro-core/docs/pages/user_guides/components.md +++ b/vizro-core/docs/pages/user_guides/components.md @@ -37,3 +37,5 @@ listed below to fill your dashboard with visuals. Use containers to group your page components into sections and subsections. [:octicons-arrow-right-24: View User Guide](container.md) + + diff --git a/vizro-core/schemas/0.1.8.json b/vizro-core/schemas/0.1.8.json deleted file mode 100644 index 3e1bab3d3..000000000 --- a/vizro-core/schemas/0.1.8.json +++ /dev/null @@ -1,1106 +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 - }, - "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 table components to visualize in dashboard.\n\nArgs:\n type (Literal[\"table\"]): Defaults to `\"table\"`.\n figure (CapturedCallable): Table like object to be displayed. Current choices include:\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 - }, - "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 - }, - "OptionsDictType": { - "title": "OptionsDictType", - "type": "object", - "properties": { - "label": { - "title": "Label", - "type": "string" - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - } - }, - "required": ["label", "value"], - "additionalProperties": false - }, - "Checklist": { - "title": "Checklist", - "description": "Categorical multi-selector `Checklist` to be provided to [`Filter`][vizro.models.Filter].\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": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "title": { - "title": "Title", - "description": "Title to be displayed", - "default": "", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/Action" - } - } - }, - "additionalProperties": false - }, - "Dropdown": { - "title": "Dropdown", - "description": "Categorical multi-selector `Dropdown` to be provided to [`Filter`][vizro.models.Filter].\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": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "boolean" - } - }, - { - "type": "array", - "items": { - "type": "number" - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "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-selector `RadioItems` to be provided to `Filter`.\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": { - "$ref": "#/definitions/OptionsDictType" - } - } - ] - }, - "value": { - "title": "Value", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "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-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[float, str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[List[float]]): Default start and end value for slider. Must be 2 items. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "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": { - "type": "string" - } - }, - "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-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[float, str]]): Marks to be displayed on slider. Defaults to `{}`.\n value (Optional[float]): Default value for slider. Defaults to `None`.\n title (str): Title to be displayed. Defaults to `\"\"`.\n actions (List[Action]): See [`Action`][vizro.models.Action]. Defaults to `[]`.", - "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": { - "type": "string" - } - }, - "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", - "dropdown": "#/definitions/Dropdown", - "radio_items": "#/definitions/RadioItems", - "range_slider": "#/definitions/RangeSlider", - "slider": "#/definitions/Slider" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Checklist" - }, - { - "$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.\n\nRaises:\n ValueError: If targets are invalid and not of the form `.`.", - "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", - "dropdown": "#/definitions/Dropdown", - "radio_items": "#/definitions/RadioItems", - "range_slider": "#/definitions/RangeSlider", - "slider": "#/definitions/Slider" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Checklist" - }, - { - "$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 `\"\"`.\n\nRaises:\n ValueError: If number of page and grid components is not the same", - "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": { - "button": "#/definitions/Button", - "card": "#/definitions/Card", - "graph": "#/definitions/Graph", - "table": "#/definitions/Table" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Button" - }, - { - "$ref": "#/definitions/Card" - }, - { - "$ref": "#/definitions/Graph" - }, - { - "$ref": "#/definitions/Table" - } - ] - } - }, - "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 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.9.dev0.json b/vizro-core/schemas/0.1.9.json similarity index 100% rename from vizro-core/schemas/0.1.9.dev0.json rename to vizro-core/schemas/0.1.9.json diff --git a/vizro-core/src/vizro/__init__.py b/vizro-core/src/vizro/__init__.py index 796a9757b..a69c63649 100644 --- a/vizro-core/src/vizro/__init__.py +++ b/vizro-core/src/vizro/__init__.py @@ -5,6 +5,6 @@ __all__ = ["Vizro"] -__version__ = "0.1.9.dev0" +__version__ = "0.1.9" logging.basicConfig(level=os.getenv("VIZRO_LOG_LEVEL", "WARNING"))