Skip to main content
All docs
V25.1
  • TdxChartSeriesTopNOptionsMode Enum

    Enumerates available Top N value display modes for simple series.

    Declaration

    TdxChartSeriesTopNOptionsMode = (
        Count,
        ThresholdValue,
        ThresholdPercent
    );

    Members

    Name Description
    Count

    Default. In this mode, a simple series displays a number of first points as separate slices according to their order in the Points collection if series points are unsorted.

    Visible Point Count
    The TopNOptions.Value property value specifies the number of points displayed as separate slices. The series displays all other points as an aggregate slice if the TopNOptions.ShowOthers property is set to True (default).
    Sort Order and Visible Points
    You can use SortOrder and SortBy properties of the series to change its point display order. For example, if you need to display points with highest values as separate slices, set the SortOrder property to soDescending, and the SortBy property to TdxChartSeriesSortBy.Value.

    If you assign a non-integer value to the TopNOptions.Value property in this mode, the property setter truncates the fractional part.

    Default Visible Point Count
    The default number of displayed top or bottom series values is 5.
    ThresholdValue

    All series points whose values exceed the TopNOptions.Value property value are displayed as separate slices. The TopNOptions.Value property setter does not impose limitations on assigned values in this mode.

    Sort Order and Visible Points
    The current sort order does not affect series point display criteria. Only the point display order is affected.
    Default Visible Point Count
    The default threshold value is 50.
    ThresholdPercent

    All series points whose values exceed the TopNOptions.Value property value (as a percentage) are displayed as separate simple series slices.

    The TopNOptions.Value property value can be within the range between MinDouble and 100.

    Sort Order and Visible Points
    The current sort order does not affect the series point display criteria. Only the point display order is affected.
    Default Visible Point Count
    The default threshold percentage is 10.

    Remarks

    Different TdxChartSeriesTopNOptionsMode values change interpretation of the TdxChartSeriesTopNOptions.Value property value.

    Note

    TdxChartSeriesTopNOptionsMode is a scoped enumeration type. Use the type name together with a scope resolution token (. in Delphi or :: in C++Builder) followed by an enumeration value to refer to this value. For example, use TdxChartSeriesTopNOptionsMode.ThresholdValue (in Delphi) or TdxChartSeriesTopNOptionsMode::ThresholdValue (in C++Builder) to refer to the ThresholdValue value in code.

    Direct TdxChartSeriesTopNOptionsMode Type Reference

    The TdxChartSeriesTopNOptions.Mode property references the TdxChartSeriesTopNOptionsMode type.

    See Also