TopNOptions.Mode Property

Gets or sets the value that specifies how to determine the total number of top N series points.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public TopNMode Mode { get; set; }
Public Property Mode As TopNMode

Property Value

Type Description
TopNMode

A TopNMode enumeration value, which chooses one of the modes.

Property Paths

You can access this nested property as listed below:

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

Remarks

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

If this feature is enabled, then the Mode property specifies the determining property (TopNOptions.Count, TopNOptions.ThresholdValue or TopNOptions.ThresholdPercent) that will specify how many series points should be visible in a chart. 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.

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

See Also