Skip to content

Commit

Permalink
Update docs (#844)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dljdd authored Oct 30, 2024
1 parent a1f8f3d commit 6a84353
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions vizro-core/docs/pages/user-guides/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ This model enables the automatic creation of [selectors](../user-guides/selector

To add a filter to your page, do the following:

- add the [`Filter`][vizro.models.Filter] model into the `controls` argument of the [`Page`][vizro.models.Page] model
- configure the `column` argument, which denotes the target column to be filtered
1. add the [`Filter`][vizro.models.Filter] model into the `controls` argument of the [`Page`][vizro.models.Page] model
2. configure the `column` argument, which denotes the target column to be filtered

By default, all components on a page with such a `column` present will be filtered. The selector type will be chosen
automatically based on the target column, for example, a dropdown for categorical data, a range slider for numerical data, or a date picker for temporal data.
Expand Down
4 changes: 2 additions & 2 deletions vizro-core/docs/pages/user-guides/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The [`Graph`][vizro.models.Graph] model is the most used component in many dashb

To add a [`Graph`][vizro.models.Graph] to your page, do the following:

- insert the [`Graph`][vizro.models.Graph] model into the `components` argument of the
1. insert the [`Graph`][vizro.models.Graph] model into the `components` argument of the
[`Page`][vizro.models.Page] model
- enter any of the currently available charts of the open source library [`plotly.express`](https://plotly.com/python/plotly-express/) into the `figure` argument
2. enter any of the currently available charts of the open source library [`plotly.express`](https://plotly.com/python/plotly-express/) into the `figure` argument

!!! note

Expand Down
6 changes: 3 additions & 3 deletions vizro-core/docs/pages/user-guides/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The [`Page`][vizro.models.Page] model accepts the `controls` argument, where you

To add a parameter to your page, do the following:

- add the [`Parameter`][vizro.models.Parameter] model into the `controls` argument of the [`Page`][vizro.models.Page] model.
- add the `targets` argument
- add a selector model to the `selector` argument.
1. add the [`Parameter`][vizro.models.Parameter] model into the `controls` argument of the [`Page`][vizro.models.Page] model.
2. add the `targets` argument
3. add a selector model to the `selector` argument.

In the `targets` argument, you can specify the component and function argument that the parameter should be applied to in the form of `<target_component_id>.<target_argument>` (for example, `scatter_chart.title`).

Expand Down
6 changes: 3 additions & 3 deletions vizro-core/docs/pages/user-guides/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ You can use [PyCafe](https://py.cafe/snippet/vizro/v1) snippet mode to experimen

Vizro().build(dashboard).run()
```
- create a Python file named `app.py`.
- type the command `python app.py` into your terminal.
- information below will be displayed in your terminal, go to [http://127.0.0.1:8050/](http://127.0.0.1:8050/).
1. create a Python file named `app.py`.
2. type the command `python app.py` into your terminal.
3. information below will be displayed in your terminal, go to [http://127.0.0.1:8050/](http://127.0.0.1:8050/).

```
Dash is running on http://127.0.0.1:8050/
Expand Down
8 changes: 4 additions & 4 deletions vizro-core/docs/pages/user-guides/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ original [Javascript implementation](https://www.ag-grid.com/).

To add a [`AgGrid`][vizro.models.AgGrid] to your page, do the following:

- Insert the [`AgGrid`][vizro.models.AgGrid] model into the `components` argument of the
1. Insert the [`AgGrid`][vizro.models.AgGrid] model into the `components` argument of the
[`Page`][vizro.models.Page] model.
- Enter the `dash_ag_grid` function under the `figure` argument (imported via `from vizro.tables import dash_ag_grid`).
2. Enter the `dash_ag_grid` function under the `figure` argument (imported via `from vizro.tables import dash_ag_grid`).

The Vizro version of this AG Grid differs in one way from the original Dash AG Grid: it requires the user to pass a pandas DataFrame as the source of data.
As explained in [our guide to using data in Vizro](data.md), this must be entered under the argument `data_frame`. Most other [parameters of the Dash AG Grid](https://dash.plotly.com/dash-ag-grid/reference) can be entered as keyword arguments.
Expand Down Expand Up @@ -348,9 +348,9 @@ The Vizro [`Table`][vizro.models.Table] model is based on the [Dash DataTable](h

To add a [`Table`][vizro.models.Table] to your page, do the following:

- Insert the [`Table`][vizro.models.Table] model into the `components` argument of the
1. Insert the [`Table`][vizro.models.Table] model into the `components` argument of the
[`Page`][vizro.models.Page] model.
- Enter the `dash_data_table` function under the `figure` argument (imported via `from vizro.tables import dash_data_table`).
2. Enter the `dash_data_table` function under the `figure` argument (imported via `from vizro.tables import dash_data_table`).


The Vizro version of this table differs in one way from the original table: it requires the user to pass a pandas DataFrame as the source of data.
Expand Down

0 comments on commit 6a84353

Please sign in to comment.