diff --git a/docs/user-guide/img/widgets/advanced_options_counter.jpg b/docs/user-guide/img/widgets/advanced_options_counter.jpg new file mode 100644 index 0000000000..eba7c8dece Binary files /dev/null and b/docs/user-guide/img/widgets/advanced_options_counter.jpg differ diff --git a/docs/user-guide/img/widgets/advanced_options_pie_chart.jpg b/docs/user-guide/img/widgets/advanced_options_pie_chart.jpg new file mode 100644 index 0000000000..c7afd8f16a Binary files /dev/null and b/docs/user-guide/img/widgets/advanced_options_pie_chart.jpg differ diff --git a/docs/user-guide/img/widgets/percentages_in_legend.jpg b/docs/user-guide/img/widgets/percentages_in_legend.jpg new file mode 100644 index 0000000000..81c9592ae0 Binary files /dev/null and b/docs/user-guide/img/widgets/percentages_in_legend.jpg differ diff --git a/docs/user-guide/widgets.md b/docs/user-guide/widgets.md index 357c3d5f4d..9d2eb02103 100644 --- a/docs/user-guide/widgets.md +++ b/docs/user-guide/widgets.md @@ -159,9 +159,9 @@ The user can customize the bars by choosing between: !!! Note By default, the bar chart type is **Stacked** -#### Advanced Options +#### Advanced Options for Bar and Line Charts -In addition, only for *Bar Charts* and *Line Charts*, [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) provides advanced setting capabilities through the *Advanced Options* section. +In addition [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) provides advanced setting capabilities through the *Advanced Options* section. @@ -194,6 +194,29 @@ Through this section, the user is allowed to: !!! Warning In order to move forward to the next step, only **X Attribute**, **Y Attribute** and **Operation** are considered as mandatory fields. +#### Advanced Options for Pie Charts + +Also for the *Pie Charts* [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) provides advanced setting capabilities through the *Advanced Options* section. + + + +Through this section, the user is allowed to: + +* Customize the labels by adding a *Prefix* (e.g. `~`), a custom *Format* (e.g. `0%: rounded percentage, '12%'` or more) or a *Suffix* (e.g. `Km`). + +* Configure a *Formula* to transform tick values as needed (e.g. `value + 2` or `value / 100` or more). + +!!! Note + More information about the syntax options allowed for **Format** are available [here](https://d3-wiki.readthedocs.io/zh_CN/master/Formatting/) and the allowed expression to be used as **Formula** are available [here](https://github.com/m93a/filtrex#expressions) in the online documentation. + +* Choose to completely hide labels through the *Hide labels* option. + +* View percentages in the legend using the *Include percentages in legend* option. + + + +#### Publish Charts + Once the settings are done, the next step of the chart widget creation/configuration is displayed as follows: @@ -324,6 +347,21 @@ An example of counter widget could be: +#### Advanced Options + +From the *Configure data* step, [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) provides advanced setting capabilities through the *Advanced Options* section. + + + +Through this section, the user is allowed to: + +* Customize the labels by adding a *Prefix* (e.g. `~`), a custom *Format* (e.g. `0%: rounded percentage, '12%'` or more) or a *Suffix* (e.g. `Km`). + +* Configure a *Formula* to transform tick values as needed (e.g. `value + 2` or `value / 100` or more). + +!!! Note + More information about the syntax options allowed for **Format** are available [here](https://d3-wiki.readthedocs.io/zh_CN/master/Formatting/) and the allowed expression to be used as **Formula** are available [here](https://github.com/m93a/filtrex#expressions) in the online documentation. + ## Manage existing widgets Once widgets have been created, they will be placed on the bottom right of the map viewer and the *Widgets Tray* appears: