SeriesBase.TopNOptions Property

Provides access to settings that indicate whether it is required to show only the Top N series points in a series and define the rule to determine the Top N points.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

[XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public TopNOptions TopNOptions { get; }
<XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)>
<PersistenceMode(PersistenceMode.InnerProperty)>
Public ReadOnly Property TopNOptions As TopNOptions

Property Value

Type Description
TopNOptions

A TopNOptions object which contains settings of the "Top N" feature.

Remarks

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

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

NOTE

The "Top N" feature is in effect only for a series whose data points contain only one value, because this value is used to determine which points to show. So, if data points contain more than one value (e.g., Value and Weight for a Bubble chart or Low, High, Open and Close Financial charts), the "Top N" feature can't be enabled.

NOTE

If a series contains data points with negative values, their absolute values are taken into account when calculating which points should be visible within a chart.

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

See Also