Web Components Chart Overlays
The Web Components IgcDataChartComponent
allows for placement of horizontal or vertical lines at a single numeric value that you define through usage of the IgcValueOverlayComponent
. This can help you to visualize data such as the mean or median of a particular series.
Web Components Value Overlay Example
The following example depicts a Column Chart with a few horizontal value overlays plotted.
Web Components Value Overlay Properties
Unlike other series types that use a ItemsSource
for data binding, the value overlay uses a ValueMemberPath
property to bind a single numeric value. In addition, the value overlay requires you to define a single axis
to use. If you use an X-axis, the value overlay will be a vertical line, and if you use a Y-axis, it will be a horizontal line.
When using a numeric X or Y axis, the ValueMemberPath
property should reflect the actual numeric value on the axis where you want the value overlay to be drawn. When using a category X or Y axis, the ValueMemberPath
should reflect the index of the category at which you want the value overlay to appear.
When using the value overlay with a numeric angle axis, it will appear as a line from the center of the chart and when using a numeric radius axis, it will appear as a circle.
IgcValueOverlayComponent
appearance properties are inherited from IgcSeriesComponent
and so brush
and thickness
for example are available and work the same way they do with other types of series.
It is also possible to show an axis annotation on a IgcValueOverlayComponent
to show the value of the overlay on the owning axis. In order to show this, you can set the isAxisAnnotationEnabled
property to true.
Web Components Value Layer
The Web Components charting components also expose the ability to use value lines to call out different focal points of your data, such as minimum, maximum, and average values.
Applying the IgcValueLayerComponent
in the IgcCategoryChartComponent
and IgcFinancialChartComponent
components is done by setting the valueLines
property on the chart. This property takes a collection of the ValueLayerValueMode
enumeration. You can mix and match multiple value layers in the same chart by adding multiple ValueLayerValueMode
enumerations to the valueLines
collection of the chart.
In the IgcDataChartComponent
, this is done by adding a IgcValueLayerComponent
to the IgcSeriesComponent
collection of the chart and then setting the ValueMode
property to one of the ValueLayerValueMode
enumerations. Each of these enumerations and what they mean is listed below:
Auto
: The default value mode of theValueLayerValueMode
enumeration.Average
: Applies potentially multiple value lines to call out the average value of each series plotted in the chart.GlobalAverage
: Applies a single value line to call out the average of all of the series values in the chart.GlobalMaximum
: Applies a single value line to call out the absolute maximum value of all of the series values in the chart.GlobalMinimum
: Applies a single value line to call out the absolute minimum value of all of the series values in the chart.Maximum
: Applies potentially multiple value lines to call out the maximum value of each series plotted in the chart.Minimum
: Applies potentially multiple value lines to call out the minimum value of each series plotted in the chart.
If you want to prevent any particular series from being taken into account when using the IgcValueLayerComponent
element, you can set the targetSeries
property on the layer. This will force the layer to target the series that you define. You can have as many IgcValueLayerComponent
elements within a single IgcDataChartComponent
as you want.
The following sample demonstrates usage of the different valueLines
in the IgcCategoryChartComponent
:
Web Components Financial Overlays
You can also plot built-in financial overlays and indicators in Web Components Stock Chart.
Additional Resources
You can find more information about related chart types in these topics:
API References
The following is a list of API members mentioned in the above sections:
IgcDataChartComponent
ItemsSource
IgcValueOverlayComponent
axis
brush
IsAxisAnnotationsEnabled
IgcSeriesComponent
thickness
IgcValueLayerComponent
ValueLayerValueMode
valueLines