TopNOptions.Enabled Property

Gets or sets a value indicating whether it is required to show only the Top N series points in a series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v19.2.dll

Declaration

public bool Enabled { get; set; }
Public Property Enabled As Boolean

Property Value

Type Description
Boolean

true, to show only the Top N series points; otherwise, false.

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 applicable only if the SeriesBase.TopNOptions's 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.

See Also