Class KpiSortMode

Represents sort modes for the Spotfire.Dxp.Application.Visuals.KpiChart.

Since

2.0

Hierarchy (view full)

Properties

Alphabetical HighestFirst LowestFirst None ReverseAlphabetical

Methods

Cast Equals GetHashCode HasFlag ToString TryCast Equals

Default capability

And Or Xor

Properties

Static ReadonlyAlphabetical

Alphabetical: KpiSortMode

The KPI tiles are shown in alphabetical order based firstly on the expressions on their tile axes and secondly on the expressions on their Y axes.

Static ReadonlyHighestFirst

HighestFirst: KpiSortMode

The KPI tiles are sorted with respect to the value on their Spotfire.Dxp.Application.Visuals.SortColumn with the tile with highest value coming first. A Spotfire.Dxp.Application.Visuals.KpiVisualization with nothing set on the Spotfire.Dxp.Application.Visuals.SortColumn will be displayed in Spotfire.Dxp.Application.Visuals.KpiSortMode.None order after the ones that have the Spotfire.Dxp.Application.Visuals.SortColumn set.

Static ReadonlyLowestFirst

LowestFirst: KpiSortMode

The KPI tiles are sorted with respect to the value on their Spotfire.Dxp.Application.Visuals.SortColumn with the tile with the lowest value coming first. A Spotfire.Dxp.Application.Visuals.KpiVisualization with nothing set on the Spotfire.Dxp.Application.Visuals.SortColumn will be displayed in Spotfire.Dxp.Application.Visuals.KpiSortMode.None order after the ones that have the Spotfire.Dxp.Application.Visuals.SortColumn set.

Static ReadonlyNone

None: KpiSortMode

The KPI tiles are shown in the order defined by the items in Spotfire.Dxp.Application.Visuals.KpiCollection and the sort order of the expressions on their tile axes.

Static ReadonlyReverseAlphabetical

ReverseAlphabetical: KpiSortMode

The KPI tiles are shown in reversed alphabetical order based firstly on the expressions on their tile axes and secondly on the expressions on their Y axes.

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

HasFlag

  • HasFlag(flag): boolean

  • Determines whether one or more bit fields are set in the current instance.

    Parameters

    • flag: Enum

      An enumeration value.

    Returns boolean

    true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

And

  • And(...rest): this

  • Perform And operation on enum values.

    Parameters

    • Rest...rest: Enum[]

      The other enum values.

    Returns this

    The result.

    Since

    2.0

Or

  • Or(...rest): this

  • Perform Or operation on enum values.

    Parameters

    • Rest...rest: Enum[]

      The other enum values.

    Returns this

    The result.

    Since

    2.0

Xor

  • Xor(...rest): this

  • Perform Xor operation on enum values.

    Parameters

    • Rest...rest: Enum[]

      The other enum values.

    Returns this

    The result.

    Since

    2.0

Settings

Member Visibility

On This Page

Properties
Methods
Default capability