Action
    Preparing search index...

    Represents a color scheme used to color a visualization. The Coloring class is a list of Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRules. A Coloring will assign colors to values using first its rules, and if none of them match either the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.DefaultColor or Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.EmptyColor will be used.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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 T1 | null

    • 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

    The index.

    2.0

    • get EvaluatePerTrellis(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring should be evaluated per trellis panel.

      Returns boolean

      This setting will only affect the color assignment when the plot is currently trellising. When set to true, each trellis panel where the Coloring is applied is treated as an individual subset, meaning that statistical calculations will be calculated individually for each panel (i.e. each panel will have their own min and max value).

      2.0

    • set EvaluatePerTrellis(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get SetColorOnText(): boolean

      Gets or sets a value indicating whether to set color on cell text or on cell background. This property is used by tabular visualizations.

      Returns boolean

      2.0

    • set SetColorOnText(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • Clears this collection, removing all ColorRules.

      Returns void

      2.0

    • Moves a rule at the specified index to another location in the collection.

      Parameters

      • fromIndex: number | System.Int32

        The zero-based index specifying the location of the item to be moved.

      • toIndex: number | System.Int32

        The zero-based index specifying the new location of the item.

      Returns void

      2.0

    Extended capability 'LibraryWrite'