Class TopBottomColorRule

TopBottomColorRule represents a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRule that colors the top or bottom n values.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Color Context IsAttached IsBottom ManualDisplayName Rank RankManualDisplayName Transactions

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.

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

Color

  • get Color(): Color

  • Gets or sets the color for this rule.

    Returns Color

    Since

    2.0

  • set Color(value): void

  • Parameters

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsBottom

  • get IsBottom(): boolean

  • Gets or sets a value indicating whether this rule ranks bottom or top values. Default is false.

    Returns boolean

    Since

    2.0

  • set IsBottom(value): void

  • Parameters

    • value: boolean

    Returns void

ManualDisplayName

  • get ManualDisplayName(): string

  • Gets or sets the display name. If set to null, the ColorRule will be represented with an auto-generated name.

    Returns string

    Since

    2.0

  • set ManualDisplayName(value): void

  • Parameters

    • value: string

    Returns void

Rank

RankManualDisplayName

  • get RankManualDisplayName(): string

  • Gets or sets the manual display name for the rank value of this TopBottomColorRule. If set to null, the rank value will be represented with an auto-generated name.

    Returns string

    Since

    2.0

  • set RankManualDisplayName(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability