TopNOptions Class

Contains settings which 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.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(TopNOptionsTypeConverter))]
public class TopNOptions :
    ChartElement

VB.NET

<TypeConverter(GetType(TopNOptionsTypeConverter))>
Public Class TopNOptions
    Inherits ChartElement

Related API Members

The following members return TopNOptions objects:

• SeriesBase.TopNOptions

Remarks

The “Top N” feature is intended to visually represent only selected series points of 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, then the TopNOptions.Mode property determines which property (TopNOptions.Count, TopNOptions.ThresholdValue or TopNOptions.ThresholdPercent) specifies how many series points will be visible in a chart. All other series points are merged 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.

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

Inheritance

Object

ChartElement

TopNOptions