Class Coloring

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.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- Coloring

Implements

Methods

[iterator]

"[iterator]"(): Iterator<ColorRule>
Returns Iterator<ColorRule>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): 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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from DocumentNode.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, ColorRule>

Gets the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRule at the specified index.

Param: index

The index.

Returns

The Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRule at the specified index.

Since

2.0

ColorByOther

get ColorByOther(): ColorByOtherExpression
Gets an object that enables coloring by another expression than the default.

Returns ColorByOtherExpression
Since
2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRule instances in this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Returns number
Since
2.0

DefaultColor

get DefaultColor(): Color
Gets or sets the default color. This color is used for values that are non-empty and are not colored by any Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRule.

Returns Color
Since
2.0
set DefaultColor(value: Color): void
Parameters
- value: Color
Returns void

DisplayName

get DisplayName(): string
Gets or sets the display name of this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Returns string
Since
2.0
set DisplayName(value: string): void
Parameters
- value: string
Returns void

EmptyColor

get EmptyColor(): Color
Gets or sets color used for empty values.

Returns Color
Since
2.0
set EmptyColor(value: Color): void
Parameters
- value: Color
Returns void

EvaluatePerColumn

get EvaluatePerColumn(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring should be evaluated per column.

Returns boolean
Remark
This setting will only affect the color assignment when the Coloring is applied to more than one column, which is only possible in Spotfire.Dxp.Application.Visuals.CrossTablePlot, Spotfire.Dxp.Application.Visuals.TablePlot and Spotfire.Dxp.Application.Visuals.HeatMap. When set to true, each column the Coloring is applied to is treated as an individual subset, meaning that statistical calculations will be calculated individually for each column (i.e. each column will have their own min and max value).

Since
2.0
set EvaluatePerColumn(value: boolean): void
Parameters
- value: boolean
Returns void

EvaluatePerTrellis

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
Remark
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).

Since
2.0
set EvaluatePerTrellis(value: boolean): void
Parameters
- value: boolean
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

SetColorOnText

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
Since
2.0
set SetColorOnText(value: boolean): void
Parameters
- value: boolean
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddBottomNRule

AddBottomNRule(rank: number | Int32, color: Color): TopBottomColorRule
Adds a bottom N rule to the end of the collection.
Parameters
- rank: number | Int32
  An integer specifying the rank of the added TopBottomColorRule.
- color: Color
  The color of the added TopBottomColorRule.
Returns TopBottomColorRule
The rule that was added.

Since
2.0
AddBottomNRule(value: ConditionValue, color: Color): TopBottomColorRule
Adds a bottom N rule to the end of the collection.
Parameters
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- color: Color
  The color.
Returns TopBottomColorRule
The rule that was added.

Since
2.0

AddCategoricalColorRule

AddCategoricalColorRule(): CategoricalColorRule
Adds a new categorical color rule with default configuration to the end of the collection.

Returns CategoricalColorRule
The categorical color rule that was added.

Since
2.0

AddContinuousColorRule

AddContinuousColorRule(): ContinuousColorRule
Adds a new empty continuous rule to the end of the collection.

Returns ContinuousColorRule
The continuous color rule that was added.

Since
2.0

AddExpressionRule

AddExpressionRule(
booleanExpression: string | String,
color: Color,
): ExpressionColorRule
Adds a new expression rule to the end of the collection.
Parameters
- booleanExpression: string | String
  The boolean expression.
- color: Color
  The color.
Returns ExpressionColorRule
The ExpressionColorRule that was added.

Since
2.0

AddRangeRule

AddRangeRule(
    startValue: ConditionValue,
    endValue: ConditionValue,
    color: Color,
): RangeColorRule
Adds a range rule to the end of the collection.
Parameters
- startValue: ConditionValue
  The start value.
- endValue: ConditionValue
  The end value.
- color: Color
  The color.
Returns RangeColorRule
The rule that was added.

Since
2.0

AddStringColorRule

AddStringColorRule(
    comparisonOperator: StringComparisonOperator,
    value: ConditionValue,
    color: Color,
): StringColorRule
Adds a string color rule to the end of the collection.
Parameters
- comparisonOperator: StringComparisonOperator
  The comparison operator.
- value: ConditionValue
  The value.
- color: Color
  The color.
Returns StringColorRule
The rule that was added.

Since
2.0

AddThresholdColorRule

AddThresholdColorRule(
    comparisonOperator: RuleComparisonOperator,
    value: ConditionValue,
    color: Color,
): ThresholdColorRule
Adds a threshold color rule to the end of the collection.
Parameters
- comparisonOperator: RuleComparisonOperator
  The comparison operator.
- value: ConditionValue
  The threshold value.
- color: Color
  The color.
Returns ThresholdColorRule
The rule that was added.

Since
2.0

AddTopNRule

AddTopNRule(rank: number | Int32, color: Color): TopBottomColorRule
Adds a top N rule to the end of the collection.
Parameters
- rank: number | Int32
  An integer specifying the rank of the added TopBottomColorRule.
- color: Color
  The color.
Returns TopBottomColorRule
The rule that was added.

Since
2.0
AddTopNRule(value: ConditionValue, color: Color): TopBottomColorRule
Adds a top N rule to the end of the collection.
Parameters
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- color: Color
  The color.
Returns TopBottomColorRule
The rule that was added.

Since
2.0

Apply

Apply(template: Coloring): void
Applies the given Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring as a template. This will clear the current settings and replace them with the settings from the template.
Parameters
- template: Coloring
  The template to apply.
Returns void
Since
2.0
Apply(templateName: string | String): void
Applies the template named templateName from the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringTemplateCollection to this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.
Parameters
- templateName: string | String
  Name of the template to apply.
Returns void
Since
2.0

Clear

Clear(): void
Clears this collection, removing all ColorRules.

Returns void
Since
2.0

Contains

Contains(rule: ColorRule): boolean
Determines whether the collection contains a specified rule.
Parameters
- rule: ColorRule
  The rule to locate in the collection.
Returns boolean
True if the collection contains the specified rule; otherwise, false.

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetColorForCategory

GetColorForCategory(category: CategoryKey): Color
Gets the categorical color for the given category. The color is taken from the current Spotfire.Dxp.Application.Visuals.ConditionalColoring.CategoricalColorRule, or if no such rule is available the DefaultColor of this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring is returned.
Parameters
- category: CategoryKey
  The category to get a color for.
Returns Color
A Color for the given category.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<ColorRule>
Returns an enumerator that iterates through the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorRules in this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Returns System.Collections.Generic.IEnumerator<ColorRule>
An System.Collections.Generic.IEnumerator for this Coloring.

Since
2.0

IndexOf

IndexOf(rule: ColorRule): number
Determines the index of a specific rule in the collection.
Parameters
- rule: ColorRule
  The rule to locate in the collection.
Returns number
The index of the rule if found in the list; otherwise, -1.

Since
2.0

Move

Move(fromIndex: number | Int32, toIndex: number | Int32): void
Moves a rule at the specified index to another location in the collection.
Parameters
- fromIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(rule: ColorRule): boolean
Removes the specified rule from the collection.
Parameters
- rule: ColorRule
  The rule to remove.
Returns boolean
True if the rule was removed; otherwise false.

Since
2.0

SaveAs

SaveAs(stream: Stream): void
Saves the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring to a stream.
Parameters
- stream: Stream
  The stream to write to.
Returns void
Since
2.0
SaveAs(
    folder: LibraryItem,
    title: string | String,
    keywords: OrExplicit<
        System.Collections.Generic.IEnumerable<string | String>,
    >,
): LibraryItem
Saves the coloring as a new item in the library.
Parameters
- folder: LibraryItem
  The library folder in which to save the coloring to.
- title: string | String
  The title of the library item.
- keywords: OrExplicit<System.Collections.Generic.IEnumerable<string | String>>
  The keywords.
Returns LibraryItem
The new library item.

Remark
This method will overwrite any existing item but keep the existing library item id.

Since
2.0

SetColorForCategory

SetColorForCategory(category: CategoryKey, color: Color): void
Sets a color for the given category in this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring. This will be set in a Spotfire.Dxp.Application.Visuals.ConditionalColoring.CategoricalColorRule in this collection. If no such rule is available when this methods is run, it will be added.
Parameters
- category: CategoryKey
  The category to set a color for.
- color: Color
  The color to set for the category.
Returns void
Since
2.0

Extended capability 'LibraryWrite'

SaveAs

SaveAs(stream: Stream): void
Saves the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring to a stream.
Parameters
- stream: Stream
  The stream to write to.
Returns void
Since
2.0
SaveAs(
    folder: LibraryItem,
    title: string | String,
    keywords: OrExplicit<
        System.Collections.Generic.IEnumerable<string | String>,
    >,
): LibraryItem
Saves the coloring as a new item in the library.
Parameters
- folder: LibraryItem
  The library folder in which to save the coloring to.
- title: string | String
  The title of the library item.
- keywords: OrExplicit<System.Collections.Generic.IEnumerable<string | String>>
  The keywords.
Returns LibraryItem
The new library item.

Remark
This method will overwrite any existing item but keep the existing library item id.

Since
2.0

Class Coloring

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Extended capability 'LibraryWrite'

Methods

[iterator]

Returns Iterator<ColorRule>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

ColorByOther

Returns ColorByOtherExpression

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

DefaultColor

Returns Color

Since

Parameters

Returns void

DisplayName

Returns string

Since

Parameters

Returns void

EmptyColor

Returns Color

Since

Parameters

Returns void

EvaluatePerColumn

Returns boolean

Remark

Since

Parameters

Returns void

EvaluatePerTrellis

Returns boolean

Remark

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

SetColorOnText

Returns boolean

Since

Parameters

Returns void

Transactions

Returns ITransactions

`Static`Equals

`Readonly`Item