Skip to content

Commit 1fd3ea0

Browse files
authored
Merge pull request #12141 from yordan-st/charts-overhaul
[WC-3596] Charts docs: reconcile with Charts module 6.3.2
2 parents 56cde19 + 2423f10 commit 1fd3ea0

72 files changed

Lines changed: 888 additions & 711 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/en/docs/marketplace/platform-supported-content/services/_index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Services"
33
url: /appstore/services/
44
description: "Presents details on the platform-supported services in the Mendix Marketplace."
5-
weight: 3
65
no_list: false
76
---
87

‎content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md‎

Lines changed: 121 additions & 443 deletions
Large diffs are not rendered by default.
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "Chart Playground"
3+
url: /appstore/widgets/chart-playground/
4+
weight: 180
5+
description: "Describes the Chart playground widget, which lets you edit the layout, configuration, and series settings of a chart live while the app runs."
6+
aliases:
7+
- /appstore/widgets/ChartPlayground/
8+
---
9+
10+
## Introduction
11+
12+
The Chart playground widget is a helper for customizing charts. It adds a live JSON editor to a chart in the running app, so you can see the effect of layout, configuration, and series settings right away. When you are happy with the result, you copy the JSON to the chart properties in Studio Pro.
13+
14+
The Chart playground widget is included in the [Charts](/appstore/widgets/charts/) module. It works with all chart widgets in the module, including [Custom chart](/appstore/widgets/charts-custom-usage/).
15+
16+
{{% alert color="warning" %}}
17+
Changes made in the Chart playground are for preview only. They are lost when you reload the page. To keep your changes, copy the JSON to the chart properties in Studio Pro.
18+
{{% /alert %}}
19+
20+
{{% alert color="info" %}}
21+
In Charts versions below 5.0.0, the live editor was enabled with the **Enable developer mode** property instead of a separate Chart playground widget.
22+
{{% /alert %}}
23+
24+
## Adding Chart Playground to a Chart {#add}
25+
26+
To add a Chart playground to a chart, do the following:
27+
28+
1. Open the page with the chart in Studio Pro.
29+
1. Open the chart properties and go to the **General** tab.
30+
1. Set **Show playground slot** to **Yes**. A **Playground slot** drop zone appears on the chart.
31+
1. In the **Toolbox**, find the **Chart playground** widget.
32+
1. Drag the **Chart playground** widget into the **Playground slot**.
33+
34+
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/chart-playground-add.png" alt="Chart in the page editor with a Chart playground widget in its Playground slot, and the Chart playground widget in the Toolbox" class="no-border" >}}
35+
36+
1. Run the app and open the page with the chart.
37+
38+
{{% alert color="info" %}}
39+
The Chart playground widget has no properties of its own. It gets all its data from the chart it is placed in. If you place it anywhere other than a **Playground slot**, it shows an error.
40+
{{% /alert %}}
41+
42+
## Using the Editor {#editor}
43+
44+
In the running app, click **Toggle Editor** on the chart to open the editor panel.
45+
46+
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/chart-playground-editor.png" alt="Chart playground editor panel next to a line chart, with Layout selected in the drop-down list, an empty Custom settings editor, and the Settings from the Studio Pro view" class="no-border" >}}
47+
48+
The editor panel has these parts:
49+
50+
* **Drop-down list** – Selects which settings to edit:
51+
* **Layout** – The layout of the whole chart, such as fonts, titles, axes, and legend. For available options, see [Layout](https://plotly.com/javascript/reference/layout/) in the Plotly documentation.
52+
* One item per series – The settings of a single series (a trace in Plotly). The item shows the series name, or **trace** with a number if the series has no name. For available options, see the [JavaScript Figure Reference](https://plotly.com/javascript/reference/) in the Plotly documentation.
53+
* **Configuration** – The configuration of the chart, such as the mode bar and zoom behavior. For available options, see [Configuration Options](https://plotly.com/javascript/configuration-options/) in the Plotly documentation.
54+
* **Custom settings** – An editable JSON editor. Your changes are applied to the chart immediately. If the JSON is invalid, the editor shows it and the chart is not updated.
55+
* **Settings from the Studio Pro** – A read-only view of the settings that come from the chart properties in Studio Pro.
56+
57+
To move the keyboard focus out of the editor, press <kbd>Esc</kbd> and then <kbd>Tab</kbd>.
58+
59+
## Saving Your Changes {#save}
60+
61+
The playground does not save anything. Copy the JSON from **Custom settings** to the matching chart property in Studio Pro:
62+
63+
| Playground Item | Chart Widgets | Custom Chart |
64+
| --- | --- | --- |
65+
| **Layout** | **Advanced** tab > **Custom layout** | **Layout options** tab > **Static** |
66+
| A series | **Edit Series Item** dialog box > **Advanced** tab > **Custom series options** (for pie charts and heat maps: **Advanced** tab > **Custom series options**) | **Data** tab > **Static** (the item at the same position in the array) |
67+
| **Configuration** | **Advanced** tab > **Custom configurations** | **Configuration options** tab > **Configuration options** |
68+
69+
## Removing Chart Playground {#remove}
70+
71+
Chart playground is a development tool. Before you deploy your app to production, remove it from your charts:
72+
73+
1. Delete the **Chart playground** widget from the **Playground slot**.
74+
1. Set **Show playground slot** to **No**.
75+
76+
If **Show playground slot** is set to **No** while a widget is still in the slot, Studio Pro shows an error asking you to remove the widget from the slot.
77+
78+
## Read More
79+
80+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
81+
* [Chart Advanced Cheat Sheet](/refguide/charts-advanced-cheat-sheet/)
82+
* [Charts](/appstore/widgets/charts/)
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Chart-Specific Settings"
3+
url: /appstore/widgets/chart-specific-settings/
4+
description: "Groups the specific settings of individual web chart widgets."
5+
no_list: false
6+
---
7+
8+
## Introduction
9+
10+
These documents will help you learn and configure specific chart widgets:
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Area Chart"
3+
url: /appstore/widgets/charts-area-chart/
4+
weight: 100
5+
description: "Describes the properties of the Area Chart widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
An area chart shows one or more series as lines with the area under each line filled.
11+
12+
For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the area chart.
13+
14+
## Appearance Tab
15+
16+
* **Interpolation** – Determines the line shape:
17+
* **Linear** – Data points are connected with straight lines.
18+
* **Curved** – Data points are connected with curved lines.
19+
* **Line style**:
20+
* **Line** – Draws the series as a simple line.
21+
* **Line with markers** – Draws a line with a marker on each data point.
22+
* **Custom** – Draws a line with markers as a starting point for your own style in **Custom series options**.
23+
* **Line color** – The color of the line for this series.
24+
* **Marker color** – The color of the markers for this series. This property is visible only when **Line style** is set to **Line with markers**.
25+
* **Area fill color** – The color of the area under the line for this series.
26+
27+
## Read More
28+
29+
* [Charts](/appstore/widgets/charts/)
30+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Bar Chart"
3+
url: /appstore/widgets/charts-bar-chart/
4+
weight: 110
5+
description: "Describes the properties of the Bar Chart widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
A bar chart shows one or more series as horizontal bars.
11+
12+
For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the bar chart.
13+
14+
## General Section
15+
16+
### Bar Format
17+
18+
This setting controls the bar format:
19+
20+
* **Grouped** – Bars of different series are placed one below the other.
21+
* **Stacked** – Bars of different series are stacked on top of one another, forming one bar.
22+
23+
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/bar-chart-formats.png" width="450px" alt="Two bar charts. On the left bar chart lines in group go one below other. On the right chart, lines in group stacked on top of each other, forming one big line." class="no-border" >}}
24+
25+
## Appearance Tab
26+
27+
* **Bar color** – The color of the bars for this series.
28+
29+
## Read More
30+
31+
* [Charts](/appstore/widgets/charts/)
32+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Bubble Chart"
3+
url: /appstore/widgets/charts-bubble-chart/
4+
weight: 120
5+
description: "Describes the properties of the Bubble Chart widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
A bubble chart shows one or more series as bubbles. The size of each bubble is set by an attribute.
11+
12+
For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the bubble chart.
13+
14+
## General Tab
15+
16+
In addition to the [common series properties](/appstore/widgets/charts/#series-general), the **General** tab has these properties:
17+
18+
* **Bubble size attribute** – The attribute whose value determines the size of the bubble.
19+
* **Auto scale** – If set to **Yes**, bubble sizes are scaled automatically. If set to **No**, the **Scale factor** is used.
20+
* **Scale factor** – The number used to calculate the rendered bubble size. The value of the **Bubble size attribute** is multiplied by this factor. This property is visible only when **Auto scale** is set to **No**. The default value is **10**.
21+
22+
## Appearance Tab
23+
24+
* **Marker color** – The color of the bubbles for this series.
25+
26+
## Read More
27+
28+
* [Charts](/appstore/widgets/charts/)
29+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "Column Chart"
3+
url: /appstore/widgets/charts-column-chart/
4+
weight: 130
5+
description: "Describes the properties of the Column Chart widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
A column chart shows one or more series as vertical columns.
11+
12+
For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the column chart.
13+
14+
## General Section
15+
16+
### Column Format
17+
18+
This setting controls the column format:
19+
20+
* **Grouped** – Columns of different series are placed next to each other.
21+
* **Stacked** – Columns of different series are stacked on top of each other, forming one column.
22+
23+
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/column-chart-format-grouped-vs-stacked.png" alt="Two column charts. On the left, Alpha and Beta columns are side by side. On the right, Beta is stacked on top of Alpha." class="no-border" >}}
24+
Two format types of column chart, where group format is present on the left and stack format is present on the right.
25+
26+
## Appearance Tab
27+
28+
* **Column color** – The color of the columns for this series.
29+
30+
## Read More
31+
32+
* [Charts](/appstore/widgets/charts/)
33+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "Heat Map"
3+
url: /appstore/widgets/charts-heat-map/
4+
weight: 140
5+
description: "Describes the properties of the Heat Map widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
A heat map shows values as colors on a grid of X and Y locations.
11+
12+
For the **Dimensions** and **Advanced** settings, which all charts share, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the heat map.
13+
14+
The heat map does not use a series list. It uses one data source and draws a value (the "heat") at each X and Y location.
15+
16+
## Data Source Section
17+
18+
* **Series** – The data source for the heat map.
19+
* **Value attribute** – The attribute used to display the heat at an X and Y location.
20+
* **Selection type** – Set to **Single** to let users select a cell. Other widgets can then listen to the selection.
21+
22+
## Axis Section
23+
24+
* **X Axis Attribute** – The attribute used for the horizontal (X) axis.
25+
* **X Axis Sort Attribute** – The attribute used to sort the items on the horizontal axis. Sorting only works when the data source is **Database**. For a **Microflow** data source, sort the data in the microflow.
26+
* **X Axis Sort Order** – **Ascending** or **Descending**.
27+
* **Y Axis Attribute** – The attribute used for the vertical (Y) axis.
28+
* **Y Axis Sort Attribute** – The attribute used to sort the items on the vertical axis. Sorting only works when the data source is **Database**. For a **Microflow** data source, sort the data in the microflow.
29+
* **Y Axis Sort Order** – **Ascending** or **Descending**.
30+
31+
## General Section
32+
33+
* **Show Scale** – If set to **Yes**, a color scale is shown on the right side of the chart.
34+
35+
The heat map also has the **X axis label**, **Y axis label**, and **Grid lines** properties described in [General Section](/appstore/widgets/charts/#general). It does not have the **Show legend** property.
36+
37+
## Scale Section
38+
39+
* **Colors** – The list of colors to use in the heat map. Each item sets a color for a **Percentage** of the value range, between 0 and 100. Specify at least two items, for 0% and 100%. Otherwise, the default colors are used.
40+
* **Smooth color** – If set to **Yes**, the colors form a gradual gradient between data points.
41+
* **Show values** – If set to **Yes**, the value of each cell is shown on the chart.
42+
* **Font value color** – The font color of the values shown on the chart.
43+
44+
**Smooth color**, **Show values**, and **Font value color** are visible only when [Enable advanced options](/appstore/widgets/charts/#enable-advanced-options) is set to **Yes**.
45+
46+
## Events Section
47+
48+
* **On click action** – The action that runs when the user clicks a cell.
49+
* **Tooltip hover text** – The text template for the message shown when the user hovers over a cell.
50+
51+
## Read More
52+
53+
* [Charts](/appstore/widgets/charts/)
54+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Line Chart"
3+
url: /appstore/widgets/charts-line-chart/
4+
weight: 150
5+
description: "Describes the properties of the Line Chart widget in the Charts module."
6+
---
7+
8+
## Introduction
9+
10+
A line chart shows one or more series as lines.
11+
12+
For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the line chart.
13+
14+
## Appearance Tab
15+
16+
* **Interpolation** – Determines the line shape:
17+
* **Linear** – Data points are connected with straight lines.
18+
* **Curved** – Data points are connected with curved lines.
19+
* **Line style**:
20+
* **Line** – Draws the series as a simple line.
21+
* **Line with markers** – Draws a line with a marker on each data point.
22+
* **Custom** – Draws a line with markers as a starting point for your own style in **Custom series options**.
23+
* **Line color** – The color of the line for this series.
24+
* **Marker color** – The color of the markers for this series. This property is visible only when **Line style** is set to **Line with markers**.
25+
26+
## Read More
27+
28+
* [Charts](/appstore/widgets/charts/)
29+
* [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/)

0 commit comments

Comments
 (0)