diff --git a/vizro-core/CHANGELOG.md b/vizro-core/CHANGELOG.md index a0d38f9dc..8e371e0da 100644 --- a/vizro-core/CHANGELOG.md +++ b/vizro-core/CHANGELOG.md @@ -11,6 +11,39 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse + + +# 0.1.4 — 2023-10-09 + +## Added + +- Add validator for `Dashboard.navigation` to default to `Navigation()` if not provided ([#74](https://github.com/mckinsey/vizro/pull/74)) + +- Add comparison table to `Why Vizro` docs page ([#90](https://github.com/mckinsey/vizro/pull/90)) + +- Parameters can be optional: use the string `"NONE"` as an option of `Parameter.selector` to pass `None`([#95](https://github.com/mckinsey/vizro/pull/95)) + +- Raise `ModuleNotFoundError` in case the `export_data` action is used with `file_format="xlsx"` and neither `openpyxl` nor `xlsxwriter` are installed ([#97](https://github.com/mckinsey/vizro/pull/97)) + +## Changed + +- Move creation of `dash.page_registry` to `Dashboard.pre_build` ([#74](https://github.com/mckinsey/vizro/pull/74)) +- Change the default collapsible behavior and highlighting color of the selected accordion group ([#74](https://github.com/mckinsey/vizro/pull/74)) + +## Fixed + +- Add highlighting to accordion button of active page ([#74](https://github.com/mckinsey/vizro/pull/74)) + +- Fix unit test interdependence issue due to shared dash.page_registry ([#84](https://github.com/mckinsey/vizro/pull/84)) + +- Fix bug of horizontal rulers not being visible in `Card` ([#91](https://github.com/mckinsey/vizro/pull/91)) + +Fix bug so that `add_type` updates forward references in new type added ([#92](https://github.com/mckinsey/vizro/pull/92)) + +## Security + +- Update pydantic requirement to `pydantic>=1.10.13, <2` due to medium Snyk vulnerability ([#83](https://github.com/mckinsey/vizro/pull/83)) + # 0.1.3 — 2023-09-29 diff --git a/vizro-core/changelog.d/20230928_143738_nadija_ratkusic_graca_highlight_active_accordion_item.md b/vizro-core/changelog.d/20230928_143738_nadija_ratkusic_graca_highlight_active_accordion_item.md deleted file mode 100644 index bd0ac5577..000000000 --- a/vizro-core/changelog.d/20230928_143738_nadija_ratkusic_graca_highlight_active_accordion_item.md +++ /dev/null @@ -1,39 +0,0 @@ - - - - -### Added - -- Add validator for `Dashboard.navigation` to default to `Navigation()` if not provided ([#74](https://github.com/mckinsey/vizro/pull/74)) - -### Changed - -- Move creation of `dash.page_registry` to `Dashboard.pre_build` ([#74](https://github.com/mckinsey/vizro/pull/74)) -- Change the default collapsible behavior and highlighting color of the selected accordion group ([#74](https://github.com/mckinsey/vizro/pull/74)) - - - -### Fixed - -- Add highlighting to accordion button of active page ([#74](https://github.com/mckinsey/vizro/pull/74)) - - diff --git a/vizro-core/changelog.d/20230929_101825_huong_li_nguyen_v0_1_3.md b/vizro-core/changelog.d/20230929_101825_huong_li_nguyen_v0_1_3.md deleted file mode 100644 index d57e34cc2..000000000 --- a/vizro-core/changelog.d/20230929_101825_huong_li_nguyen_v0_1_3.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - diff --git a/vizro-core/changelog.d/20230929_110424_huong_li_nguyen_bump_version_after_013.md b/vizro-core/changelog.d/20230929_110424_huong_li_nguyen_bump_version_after_013.md deleted file mode 100644 index d57e34cc2..000000000 --- a/vizro-core/changelog.d/20230929_110424_huong_li_nguyen_bump_version_after_013.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - diff --git a/vizro-core/changelog.d/20230929_152304_47756459+axa99_docs_review.md b/vizro-core/changelog.d/20230929_152304_47756459+axa99_docs_review.md deleted file mode 100644 index d57e34cc2..000000000 --- a/vizro-core/changelog.d/20230929_152304_47756459+axa99_docs_review.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - diff --git a/vizro-core/changelog.d/20231001_000340_huong_li_nguyen_fix_test_interdependence.md b/vizro-core/changelog.d/20231001_000340_huong_li_nguyen_fix_test_interdependence.md deleted file mode 100644 index 645717527..000000000 --- a/vizro-core/changelog.d/20231001_000340_huong_li_nguyen_fix_test_interdependence.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -### Fixed - -- Fix unit test interdependence issue due to shared dash.page_registry ([#84](https://github.com/mckinsey/vizro/pull/84)) - - diff --git a/vizro-core/changelog.d/20231002_135801_alexey_snigir_release_tests_fix.md b/vizro-core/changelog.d/20231002_135801_alexey_snigir_release_tests_fix.md deleted file mode 100644 index d57e34cc2..000000000 --- a/vizro-core/changelog.d/20231002_135801_alexey_snigir_release_tests_fix.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - diff --git a/vizro-core/changelog.d/20231002_182747_huong_li_nguyen_snyk_fix_45c953e9ecaac62cbefac81184742ed1.md b/vizro-core/changelog.d/20231002_182747_huong_li_nguyen_snyk_fix_45c953e9ecaac62cbefac81184742ed1.md deleted file mode 100644 index e8053167c..000000000 --- a/vizro-core/changelog.d/20231002_182747_huong_li_nguyen_snyk_fix_45c953e9ecaac62cbefac81184742ed1.md +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - -### Security - -- Update pydantic requirement to `pydantic>=1.10.13, <2` due to medium Snyk vulnerability ([#83](https://github.com/mckinsey/vizro/pull/83)) diff --git a/vizro-core/changelog.d/20231003_103941_huong_li_nguyen_end_to_end_use_case_example.md b/vizro-core/changelog.d/20231003_103941_huong_li_nguyen_end_to_end_use_case_example.md deleted file mode 100644 index 45c24150e..000000000 --- a/vizro-core/changelog.d/20231003_103941_huong_li_nguyen_end_to_end_use_case_example.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - -### Added - -- Add comparison table to `Why Vizro` docs page ([#90](https://github.com/mckinsey/vizro/pull/90)) - - - - - diff --git a/vizro-core/changelog.d/20231003_115910_huong_li_nguyen_make_rulers_visible.md b/vizro-core/changelog.d/20231003_115910_huong_li_nguyen_make_rulers_visible.md deleted file mode 100644 index 021706e52..000000000 --- a/vizro-core/changelog.d/20231003_115910_huong_li_nguyen_make_rulers_visible.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -### Fixed - -- Fix bug of horizontal rulers not being visible in `Card` ([#91](https://github.com/mckinsey/vizro/pull/91)) - - diff --git a/vizro-core/changelog.d/20231004_131631_huong_li_nguyen_fix_child_forwardref.md b/vizro-core/changelog.d/20231004_131631_huong_li_nguyen_fix_child_forwardref.md deleted file mode 100644 index 18329405b..000000000 --- a/vizro-core/changelog.d/20231004_131631_huong_li_nguyen_fix_child_forwardref.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -### Fixed - -Fix bug so that `add_type` updates forward references in new type added ([#92](https://github.com/mckinsey/vizro/pull/92)) - - diff --git a/vizro-core/changelog.d/20231004_184107_maximilian_schulz_allow_none_parameters.md b/vizro-core/changelog.d/20231004_184107_maximilian_schulz_allow_none_parameters.md deleted file mode 100644 index 5c0307cd6..000000000 --- a/vizro-core/changelog.d/20231004_184107_maximilian_schulz_allow_none_parameters.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - -### Added - -- Parameters can be optional: use the string `"NONE"` as an option of `Parameter.selector` to pass `None`([#95](https://github.com/mckinsey/vizro/pull/95)) - - - - - diff --git a/vizro-core/changelog.d/20231005_135142_huong_li_nguyen_update_custom_control_example.md b/vizro-core/changelog.d/20231005_135142_huong_li_nguyen_update_custom_control_example.md deleted file mode 100644 index d57e34cc2..000000000 --- a/vizro-core/changelog.d/20231005_135142_huong_li_nguyen_update_custom_control_example.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - diff --git a/vizro-core/changelog.d/20231005_145819_maximilian_schulz_86_absence_of_openpyxl_library_causes_console_errors.md b/vizro-core/changelog.d/20231005_145819_maximilian_schulz_86_absence_of_openpyxl_library_causes_console_errors.md deleted file mode 100644 index 82cc7741a..000000000 --- a/vizro-core/changelog.d/20231005_145819_maximilian_schulz_86_absence_of_openpyxl_library_causes_console_errors.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - -### Added - -- Raise `ModuleNotFoundError` in case the `export_data` action is used with `file_format="xlsx"` and neither `openpyxl` nor `xlsxwriter` are installed ([#97](https://github.com/mckinsey/vizro/pull/97)) - - - - - diff --git a/vizro-core/changelog.d/20230927_081254_petar_pejovic_actions_unit_tests.md b/vizro-core/changelog.d/20231009_162714_petar_pejovic_v0_1_4.md similarity index 100% rename from vizro-core/changelog.d/20230927_081254_petar_pejovic_actions_unit_tests.md rename to vizro-core/changelog.d/20231009_162714_petar_pejovic_v0_1_4.md diff --git a/vizro-core/schemas/0.1.3.json b/vizro-core/schemas/0.1.3.json deleted file mode 100644 index ad89ca9e6..000000000 --- a/vizro-core/schemas/0.1.3.json +++ /dev/null @@ -1,894 +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 (Optional[Navigation]): See [`Navigation`][vizro.models.Navigation]. Defaults to `None`.\n title (Optional[str]): Dashboard title to appear on every page on top left-side. 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.", - "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.", - "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.", - "type": "string" - }, - "inputs": { - "title": "Inputs", - "description": "Inputs in the form `.` passed to the action function.", - "default": [], - "pattern": "^[a-zA-Z0-9_]+[.][a-zA-Z_]+$", - "type": "array", - "items": { - "type": "string", - "pattern": "^[a-zA-Z0-9_]+[.][a-zA-Z_]+$" - } - }, - "outputs": { - "title": "Outputs", - "description": "Outputs in the form `.` changed by the action function.", - "default": [], - "pattern": "^[a-zA-Z0-9_]+[.][a-zA-Z_]+$", - "type": "array", - "items": { - "type": "string", - "pattern": "^[a-zA-Z0-9_]+[.][a-zA-Z_]+$" - } - } - }, - "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.", - "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 (Optional[str]): URL (relative or absolute) to navigate to. If not provided the Card serves as a text card\n only. 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.", - "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.", - "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.", - "type": "string" - }, - "type": { - "title": "Type", - "default": "graph", - "enum": ["graph"], - "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.", - "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 (Optional[str]): Title to be displayed. Defaults to `None`.\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.", - "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", - "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 (Optional[str]): Title to be displayed. Defaults to `None`.\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.", - "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", - "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 (Optional[str]): Title to be displayed. Defaults to `None`.\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.", - "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", - "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 `None`.\n value (Optional[List[float]]): Default start and end value for slider. Must be 2 items. Defaults to `None`.\n title (Optional[str]): Title to be displayed. Defaults to `None`.\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.", - "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.", - "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.", - "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 `None`.\n value (Optional[float]): Default value for slider. Defaults to `None`.\n title (Optional[str]): Title to be displayed. Defaults to `None`.\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.", - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "value": { - "title": "Value", - "description": "Default value for slider.", - "type": "number" - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "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[str]): Target component to be affected by filter. If none are given then target all components on\n the page that use `column`.\n selector (Optional[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.", - "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", - "anyOf": [ - { - "$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 (Optional[SelectorType]): See [SelectorType][vizro.models.types.SelectorType]. Defaults to `None`.\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.", - "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 (Optional[str]): ID to identify model. Must be unique throughout the whole dashboard. Defaults to `None`.\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.", - "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 layout (Optional[Layout]): Layout to place components in. Defaults to `None`.\n controls (List[ControlType]): See [ControlType][vizro.models.types.ControlType]. Defaults to `[]`.\n path (Optional[str]): Path to navigate to page. Defaults to `None`.\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.", - "type": "string" - }, - "components": { - "title": "Components", - "type": "array", - "items": { - "discriminator": { - "propertyName": "type", - "mapping": { - "button": "#/definitions/Button", - "card": "#/definitions/Card", - "graph": "#/definitions/Graph" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Button" - }, - { - "$ref": "#/definitions/Card" - }, - { - "$ref": "#/definitions/Graph" - } - ] - } - }, - "title": { - "title": "Title", - "description": "Title to be displayed.", - "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.", - "type": "string" - }, - "actions": { - "title": "Actions", - "default": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionsChain" - } - } - }, - "required": ["components", "title"], - "additionalProperties": false - }, - "Navigation": { - "title": "Navigation", - "description": "Navigation in [`Dashboard`][vizro.models.Dashboard] to structure [`Pages`][vizro.models.Page].\n\nArgs:\n pages (Optional[NavigationPagesType]): See [NavigationPagesType][vizro.models.types.NavigationPagesType].\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.", - "type": "string" - }, - "pages": { - "title": "Pages", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - ] - } - }, - "additionalProperties": false - } - } -} diff --git a/vizro-core/schemas/0.1.4.dev0.json b/vizro-core/schemas/0.1.4.json similarity index 100% rename from vizro-core/schemas/0.1.4.dev0.json rename to vizro-core/schemas/0.1.4.json diff --git a/vizro-core/src/vizro/__init__.py b/vizro-core/src/vizro/__init__.py index e1f3dcd25..8dfb72b0e 100644 --- a/vizro-core/src/vizro/__init__.py +++ b/vizro-core/src/vizro/__init__.py @@ -5,6 +5,6 @@ __all__ = ["Vizro"] -__version__ = "0.1.4.dev0" +__version__ = "0.1.4" logging.basicConfig(level=os.getenv("VIZRO_LOG_LEVEL", "WARNING"))