Class ColoringCollection

[iterator]

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

• Returns Iterator<Coloring, any, undefined>

ReadonlyItem

Count

• get Count(): number

• Gets the number of items in the collection.

  Returns number

  Since

  2.0

DefaultBooleanReference

• get DefaultBooleanReference(): Coloring

• Gets or sets the default coloring for Boolean datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultBooleanReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultDateReference

• get DefaultDateReference(): Coloring

• Gets or sets the default coloring for date datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultDateReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultDateTimeReference

• get DefaultDateTimeReference(): Coloring

• Gets or sets the default coloring for date time datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultDateTimeReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultNumericReference

• get DefaultNumericReference(): Coloring

• Gets or sets the default coloring for numeric datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultNumericReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultStringReference

• get DefaultStringReference(): Coloring

• Gets or sets the default coloring for string datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultStringReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultTimeReference

• get DefaultTimeReference(): Coloring

• Gets or sets the default coloring for time datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultTimeReference(value): void

• Parameters

  • value: Coloring

  Returns void

DefaultTimeSpanReference

• get DefaultTimeSpanReference(): Coloring

• Gets or sets the default coloring for TimeSpan datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  Since

  2.0

• set DefaultTimeSpanReference(value): void

• Parameters

  • value: Coloring

  Returns void

LegendItem

• get LegendItem(): LegendColorItem

• Gets the legend item used to display information about this ColoringCollection.

  Returns LegendColorItem

  Since

  2.0

AddCopy

• AddCopy(coloring): Coloring

• Adds a copy of the given color rule collection with a new display name.

  Parameters

  • coloring: Coloring

    The coloring to copy.

  Returns Coloring

  A copy of the provided coloring that has been inserted to this collection.

  Since

  2.0

AddMapping

• AddMapping(category, coloring): void

• Adds a mapping between the specified Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance and the specified Spotfire.Dxp.Application.Visuals.CategoryKey value. This means that the specified category will be colored by the specified coloring.

  Parameters

  • category: CategoryKey

    The category.
  • coloring: Coloring

    The coloring.

  Returns void

  Since

  2.0

AddNew

• AddNew(): Coloring

• Adds a new Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance to this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns Coloring

  The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

  Since

  2.0

• AddNew(displayName): Coloring

• Adds a new Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance to this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Parameters

  • displayName: string | String

    A display name for the new coloring.

  Returns Coloring

  The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

  Since

  2.0

Clear

• Clear(): void

• Clears all Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instances and mappings in this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns void

  Since

  2.0

Contains

• Contains(coloring): boolean

• Determines whether the given coloring exists in this collection.

  Parameters

  • coloring: Coloring

    The coloring to look for.

  Returns boolean

  true if this collection contains the given coloring; otherwise, false.

  Since

  2.0

GetCategories

• GetCategories(): System.Collections.Generic.IList<CategoryKey>

• Gets all Spotfire.Dxp.Application.Visuals.CategoryKey values that are currently mapped to any Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring managed by this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringCollection.

  Returns System.Collections.Generic.IList<CategoryKey>

  The Spotfire.Dxp.Application.Visuals.CategoryKey values.

  Since

  2.0

GetCategoriesForColoring

• GetCategoriesForColoring(coloring): System.Collections.Generic.IList<CategoryKey>

• Gets the Spotfire.Dxp.Application.Visuals.CategoryKey values that are mapped to the specified Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring, otherwise an empty list.

  Parameters

  • coloring: Coloring

    The coloring to get categories for.

  Returns System.Collections.Generic.IList<CategoryKey>

  A list of the mapped Spotfire.Dxp.Application.Visuals.CategoryKey values, otherwise an empty list.

  Since

  2.0

GetColoringForCategory

• GetColoringForCategory(category): null | Coloring

• Gets the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance that is mapped to the specified Spotfire.Dxp.Application.Visuals.CategoryKey value, otherwise the default coloring for the category's data type. If no type can be established for the given category, or if no default has been set, null is returned.

  Parameters

  • category: CategoryKey

    The category.

  Returns null | Coloring

  The mapped Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance, the default, or null when no default can be established.

  Since

  2.0

Remove

• Remove(coloring): boolean

• Removes the specified Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance and any mappings to it.

  Parameters

  • coloring: Coloring

    The coloring to remove.

  Returns boolean

  true if the coloring is successfully removed, otherwise false.

  Since

  2.0

RemoveAt

• RemoveAt(index): void

• Removes the item at the given index.

  Parameters

  • index: number | Int32

    Index to remove.

  Returns void

  Since

  2.0

RemoveMapping

• RemoveMapping(category): boolean

• Removes the mapping between the specified Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring instance and the specified Spotfire.Dxp.Application.Visuals.CategoryKey value.

  Parameters

  • category: CategoryKey

    The category to remove the mapping for.

  Returns boolean

  true if the mapping is successfully removed, otherwise false.

  Since

  2.0