TopNOptions.ThresholdValue Property

Gets or sets the value, which is the minimum limit for values of the Top N series points.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public double ThresholdValue { get; set; }
Public Property ThresholdValue As Double

Property Value

Type Description
Double

A Double value that represents the minimum value.

Property Paths

You can access this nested property as listed below:

Object Type Path to ThresholdValue
Series
.TopNOptions.ThresholdValue
SeriesBase
.TopNOptions.ThresholdValue
SeriesTemplate
.TopNOptions.ThresholdValue

Remarks

The "Top N" feature is intended to visually represent only selected series points in a series, and is determined by the TopNOptions object returned by the SeriesBase.TopNOptions property. This feature is applied only if the SeriesBase.TopNOptions's TopNOptions.Enabled property is set to true.

If this feature is enabled and the TopNOptions.Mode property is set to TopNMode.ThresholdValue, then the ThresholdValue property specifies how many series points will be visible in a chart. So, all series points are sorted by their values (in this case, absolute values are taken into account), and only those series points whose absolute value is greater than or equal to the ThresholdValue property's value are visible. All other series points are combined into a single "Others" point, which can be visible or hidden according to the TopNOptions.ShowOthers property value. The text shown as an argument of the "Others" point is specified by the TopNOptions.OthersArgument property.

Also, it is possible to determine the top N visible points by their TopNOptions.Count (if the TopNOptions.Mode property is set to TopNMode.Count) or TopNOptions.ThresholdPercent (if the TopNOptions.Mode property is set to TopNMode.ThresholdPercent) values.

NOTE

Only one of the TopNOptions.Count, ThresholdValue or TopNOptions.ThresholdPercent properties can be in effect at one time. The currently active property is determined by the top N options' TopNOptions.Mode.

The following image demonstrates how the ThresholdValue property works.

TopN_1b

For more information, refer to Using The Top-N Feature.

See Also