DimensionTopNOptions Class

Contains the Top N settings.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v18.2.Core.dll

Declaration

C#

public class DimensionTopNOptions

VB.NET

Public Class DimensionTopNOptions

Related API Members

The following members return DimensionTopNOptions objects:

• Dimension.TopNOptions

Remarks

The Top N Values feature enables dashboard items to display a specified number of top or bottom dimension values, while ignoring the rest. The DimensionTopNOptions class contains settings that allow you to configure this feature. Use the Dimension.TopNOptions property to access these settings.

Set the DimensionTopNOptions.Enabled property to true to enable the Top N Values feature. Use the DimensionTopNOptions.Count property to specify the number of values to be displayed, and the DimensionTopNOptions.Mode property to specify whether the largest or smallest values should be selected.

To select the top or bottom values in the dimension, the Dashboard ranges all values by a measure specified by the DimensionTopNOptions.Measure property.

You can also introduce the “Others” value that aggregates the remaining dimension values. To do this, use the DimensionTopNOptions.ShowOthers property.

Note that when the Top N Values feature is enabled, dimension values are forcibly sorted by the specified measure, and sort order is descending if top values are displayed and ascending if bottom values are displayed.

Inheritance

Object

DimensionTopNOptions