Class Coloring

[iterator]

• [iterator](): Iterator<ColorRule, any, undefined>

• Returns Iterator<ColorRule, any, undefined>

ReadonlyItem

ColorByOther

• get ColorByOther(): ColorByOtherExpression

• Gets an object that enables coloring by another expression than the default.

  Returns ColorByOtherExpression

  Since

  2.0

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): 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): 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): 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

  Since

  2.0

• set EvaluatePerColumn(value): 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): void

• Parameters

  • value: boolean

  Returns void

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): void

• Parameters

  • value: boolean

  Returns void

AddBottomNRule

• AddBottomNRule(rank, 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, 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, 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, endValue, 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, value, 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, value, 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, 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, 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): 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): 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): 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

GetColorForCategory

• GetColorForCategory(category): 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): 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, toIndex): 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): 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): 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, title, keywords): 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.

  Since

  2.0

SetColorForCategory

• SetColorForCategory(category, 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

SaveAs

• SaveAs(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, title, keywords): 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.

  Since

  2.0