ColoringCollection Class

Spotfire 14.3 API Reference

Manages a set of Coloring instances, and mappings between CategoryKey values and Coloring instances. CrossTablePlot, TablePlot and HeatMap uses a ColoringCollection to assign colors.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColoringCollection

Namespace: Spotfire.Dxp.Application.Visuals.ConditionalColoring
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(9, 0)]
public sealed class ColoringCollection : DocumentNode, 
	IEnumerable<Coloring>, IEnumerable

The ColoringCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of items in the collection.
	DefaultBooleanReference	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 ColoringCollection.
	DefaultDateReference	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 ColoringCollection.
	DefaultDateTimeReference	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 ColoringCollection.
	DefaultNumericReference	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 ColoringCollection.
	DefaultStringReference	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 ColoringCollection.
	DefaultTimeReference	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 ColoringCollection.
	DefaultTimeSpanReference	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 ColoringCollection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the Coloring at the given index.
	LegendItem	Gets the legend item used to display information about this ColoringCollection.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddCopy	Adds a copy of the given color rule collection with a new display name.
	AddMapping	Adds a mapping between the specified Coloring instance and the specified CategoryKey value. This means that the specified category will be colored by the specified coloring.
	AddNew	Adds a new Coloring instance to this ColoringCollection.
	AddNew(String)	Adds a new Coloring instance to this ColoringCollection.
	Clear	Clears all Coloring instances and mappings in this ColoringCollection.
	Contains	Determines whether the given coloring exists in this collection.
	GetCategories	Gets all CategoryKey values that are currently mapped to any Coloring managed by this ColoringCollection.
	GetCategoriesForColoring	Gets the CategoryKey values that are mapped to the specified Coloring, otherwise an empty list.
	GetColoringForCategory	Gets the Coloring instance that is mapped to the specified 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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes the specified Coloring instance and any mappings to it.
	RemoveAt	Removes the item at the given index.
	RemoveMapping	Removes the mapping between the specified Coloring instance and the specified CategoryKey value.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableColoringGetEnumerator	Returns an enumerator that iterates through this collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through this collection.
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals.ConditionalColoring Namespace