Skip to content

Commit a3fcede

Browse files
Chart: Update demo descriptions (DevExpress#30833)
1 parent 96894c6 commit a3fcede

File tree

12 files changed

+71
-29
lines changed

12 files changed

+71
-29
lines changed
Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
1-
In this example, the crosshair pointer is enabled and a custom style is applied to it. The crosshair pointer allows a user to determine the argument and the value of a specific point more precisely.
2-
<!--split-->
1+
The DevExtreme Chart component supports crosshairs (vertical and horizontal lines centered on a data point). When enabled, the crosshair follows the cursor and snaps to the nearest series point. To configure crosshair settings, specify the [crosshair](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/) object.
2+
<!--split-->
3+
4+
This demo configures the following **crosshair** properties:
5+
6+
- [color](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/#color)
7+
Specifies the line color.
8+
- [width](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/#width)
9+
Configures the line width.
10+
- [dashStyle](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/#dashStyle)
11+
Specifies the line style.
12+
- [label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/label/)
13+
Configures labels (text and appearance).
14+
15+
You can configure **crosshair**.[horizontalLine](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/horizontalLine/) and **crosshair**.[verticalLine](/Documentation/ApiReference/UI_Components/dxChart/Configuration/crosshair/verticalLine/) objects to override settings for each line individually.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
DevExtreme Chart supports value error bars. Implement these bars to indicate data measurement tolerances and [confidence intervals](https://en.wikipedia.org/wiki/Confidence_interval). Configure error bar settings and appearance in the **series**.[valueErrorBar](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/) object.
1+
DevExtreme Chart supports value error bars. These bars indicate data measurement tolerances and [confidence intervals](https://en.wikipedia.org/wiki/Confidence_interval). Use the **series**.[valueErrorBar](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/) object to configure error bar settings and appearance.
22

33
<!--split-->
44

5-
To enable error bars, specify one of the following pairs of **valueErrorBar** properties:
5+
To display error bars, specify one of the following pairs of **valueErrorBar** properties:
66

77
- [lowValueField](Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/#lowValueField) and [highValueField](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/#highValueField)
8-
Specify predefined error bars for each series point.
8+
Bind fields that contain error values for each series point.
99

1010
- [value](Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/#value) and [type](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/valueErrorBar/#type)
11-
Configure dynamically calculated error bars.
11+
Calculate error bar values based on series data points.
1212

1313
This demo implements predefined error bars specified in the Chart data source.

apps/demos/Demos/Charts/FunnelChart/description.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
DevExtreme Funnel displays data in a funnel chart. You can implement funnel charts to display the flow of data over different stages. This demo displays conversion rates from website visits to product renewals.
1+
DevExtreme Funnel displays the flow of data over different stages. This demo displays conversion rates from website visits to product renewals.
22

33
<!--split-->
44

5-
This demo specifies multiple Funnel configuration objects:
5+
This demo configures the following objects:
66

77
- [title](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/title/)
8-
Specifies a title for the Funnel component.
8+
Specifies the component title.
99
- [export](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/export/)
10-
Configures export settings. Funnel supports multiple export [formats](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/export/#formats).
10+
Configures export settings. Funnel supports the following export [formats](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/export/#formats): PNG, PDF, JPEG, SVG, and GIF.
1111
- [tooltip](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/tooltip/)
1212
Specifies item tooltips.
1313
- [label](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/label/)
1414
Configures item labels.
1515
- [item](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/item/)
16-
Customizes the visual appearance of items.
16+
Customizes item appearance.
1717

1818
[note]
1919

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1-
The Chart and PieChart components support different modes of&nbsp;series hovering. This demo shows the _&laquo;includePoints&raquo;_ mode, when all the points of&nbsp;a&nbsp;hovered series change their display style. In&nbsp;addition, you can specify a&nbsp;custom hover mode for legend items. Here, the _&laquo;excludePoints&raquo;_ mode is&nbsp;used, when only the series line changes its display style leaving the points as&nbsp;they were.
2-
<!--split-->
1+
DevExtreme Chart supports configurable hover modes for series and points. This demo specifies properties that set common **hoverMode** for all series/points and a custom mode for the component legend.
2+
<!--split-->
3+
4+
You can specify **hoverMode** for the following Chart elements:
5+
6+
- [series](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#hoverMode)
7+
A specific series.
8+
- [commonSeriesSettings](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/#hoverMode)
9+
All series.
10+
- **commonSeriesSettings**.[spline](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/#spline) (or other [Series Type](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/) objects)
11+
All series of a specific type.
12+
- [legend](/Documentation/ApiReference/UI_Components/dxChart/Configuration/legend/#hoverMode)
13+
Series hovered in the Chart legend.
14+
- **series**.[point](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/point/#hoverMode)
15+
Points in a specific series.
16+
- **commonSeriesSettings**.[point](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/point/#hoverMode) (or other Series Type objects)
17+
All points.
18+
- **commonSeriesSettings**.**spline**.**point**
19+
All points in series of a specific type.
20+
- [argumentAxis](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/#hoverMode)
21+
All points at common argument values.
22+
23+
To further customize Chart behavior, define the [stickyHovering](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#stickyHovering) property. When enabled (default), points remain in the hover state until users hover the mouse pointer over other points or move it outside the component.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
The DevExtreme Chart component allows you to display data in multiple panes. To configure a multi-pane chart, specify the [panes[]](/Documentation/ApiReference/UI_Components/dxChart/Configuration/panes/) array. The component stacks panes vertically (or horizontally when [rotated](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#rotated) is `true`).
1+
The DevExtreme Chart component allows you to display data in multiple panes. The component stacks panes vertically (or horizontally when Chart axes are [rotated](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#rotated)). To create a multi-pane chart, add items to the [panes[]](/Documentation/ApiReference/UI_Components/dxChart/Configuration/panes/) array.
22

33
<!--split-->
44

5-
Chart assigns unique [value axes](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/) and a shared [argument axis](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/) to all panes. To configure the value axis of a specific pane, define **valueAxis** properties and assign the **pane**.[name](/Documentation/ApiReference/UI_Components/dxChart/Configuration/panes/#name) value to **valueAxis**.[pane](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/#pane).
5+
The Chart renders multiple [value axes](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/) and a shared [argument axis](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/). To create multiple value axes, add a **valueAxis[]** object for each value axis. To assign a value axis to a pane, pass the pane [name](/Documentation/ApiReference/UI_Components/dxChart/Configuration/panes/#name) to the **valueAxis**.[pane](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/#pane) property.
66

77
DevExtreme Chart can display multiple [series](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/) in a single pane. Specify the **series**.[pane](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#pane) property to display a series in a specific pane.
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
You can utilize the DevExtreme Chart component to display data in a [Pareto chart](https://en.wikipedia.org/wiki/Pareto_chart). A Pareto chart displays individual values along with their cumulative totals. In this demo, individual values are numbers of complaints and cumulative totals are represented as percentages.
1+
You can use the DevExtreme Chart component to visualize data as a [Pareto chart](https://en.wikipedia.org/wiki/Pareto_chart). Such charts display individual values along with their cumulative totals. In this demo, individual values are numbers of complaints and cumulative totals are given in percentages.
22

33
<!--split-->
44

5-
To create a Pareto chart, configure two [series](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/) objects. Assign the [Bar](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/BarSeries/) and [Line](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/LineSeries/)/[Spline](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/SplineSeries/) series types to **series**.[type](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#type). To represent the numbers of the [Pareto principle](https://en.wikipedia.org/wiki/Pareto_principle) (80/20), you can specify constant lines. This demo configures a **valueAxis**.[constantLines](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/constantLines/) object to display a constant line at 80% of the cumulative total axis.
5+
Follow the steps below to create a Pareto chart:
6+
7+
1. Configure a [Bar](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/BarSeries/) series and assign your primary data to this series (specify **series**.[valueField](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#valueField) property).
8+
2. Add a [Line](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/LineSeries/) or [Spline](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/SplineSeries/) series and assign your cumulative total values to this series.
9+
3. Specify **valueAxis**.[constantLines](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/constantLines/) to illustrate [Pareto principle](https://en.wikipedia.org/wiki/Pareto_principle) correlation (80/20).
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
In&nbsp;the PieChart, series may include a&nbsp;large number of&nbsp;points, which may result in&nbsp;point label overlapping. This demo illustrates the **resolveLabelOverlapping** property that allows you to&nbsp;specify how the component must behave when point labels overlap.
2-
<!--split-->
1+
When a DevExtreme Pie Chart contains a lot of data points or they are crowded, point labels may overlap. Use the [resolveLabelOverlapping](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/#resolveLabelOverlapping) property to resolve overlapping labels. In this demo, you can hide or shift overlapping labels.
2+
<!--split-->
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1-
This demo shows that the Chart can display custom images instead of&nbsp;standard point symbols.
2-
<!--split-->
1+
DevExtreme Chart can display custom images for series points. Specify the **point**.**image** object in [common series](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/point/image/) or [series](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/point/image/) settings to display these images.
2+
<!--split-->
3+
4+
This demo [hides](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/point/#visible) default point [symbols](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonSeriesSettings/point/#symbol) and calls the [customizePoint](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#customizePoint) function to display images based on point values.

apps/demos/Demos/Charts/PyramidChart/description.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
DevExtreme Funnel can display data in a pyramid chart. To configure the component as a pyramid chart, assign *"dynamicHeight"* to the [algorithm](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/#algorithm) property and enable [inverted](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/#inverted).
1+
DevExtreme Funnel can display data as a pyramid chart. To create such visualization, set the [algorithm](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/#algorithm) property to *"dynamicHeight"* and [invert the Funnel](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/#inverted).
22
<!--split-->
33

4-
This demo specifies multiple Funnel configuration objects:
4+
This demo configures the following objects:
55

66
- [title](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/title/)
7-
Specifies a title for the Funnel component.
7+
Specifies the component title.
88
- [tooltip](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/tooltip/)
99
Specifies item tooltips.
1010
- [item](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/item/)
11-
Customizes the appearance of items.
11+
Customizes item appearance.
1212
- [legend](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/legend/)
1313
Configures the component legend.
1414
- [label](/Documentation/ApiReference/UI_Components/dxFunnel/Configuration/label/)
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1-
In&nbsp;this example, the PieChart component combines all values below the **threshold** property in&nbsp;one category called _&laquo;others&raquo;_.
2-
<!--split-->
1+
DevExtreme PieChart supports small value grouping. To enable this functionality, configure the [smallValuesGrouping](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/series/smallValuesGrouping/) object in [series](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/series/) or [commonSeriesSettings](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/commonSeriesSettings/). This demo sets **smallValuesGrouping**.[mode](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/series/smallValuesGrouping/) to *"smallValueThreshold"* and specifies the [threshold](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/series/smallValuesGrouping/#threshold) property.
2+
<!--split-->
3+
4+
You can also set **smallValuesGrouping**.**mode** to *"topN"*. In this mode, PieChart displays a predefined number of the largest data points (specified with [topCount](/Documentation/ApiReference/UI_Components/dxPieChart/Configuration/series/smallValuesGrouping/#topCount)) and groups the rest.

0 commit comments

Comments
 (0)