ColoringCollection Methods

Spotfire 14.3 API Reference

The ColoringCollection type exposes the following members.

Methods

  NameDescription
Public methodAddCopy
Adds a copy of the given color rule collection with a new display name.
Public methodAddMapping
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.
Public methodAddNew
Adds a new Coloring instance to this ColoringCollection.
Public methodAddNew(String)
Adds a new Coloring instance to this ColoringCollection.
Public methodClear
Clears all Coloring instances and mappings in this ColoringCollection.
Public methodContains
Determines whether the given coloring exists in this collection.
Public methodGetCategories
Gets all CategoryKey values that are currently mapped to any Coloring managed by this ColoringCollection.
Public methodGetCategoriesForColoring
Gets the CategoryKey values that are mapped to the specified Coloring, otherwise an empty list.
Public methodGetColoringForCategory
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.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes the specified Coloring instance and any mappings to it.
Public methodRemoveAt
Removes the item at the given index.
Public methodRemoveMapping
Removes the mapping between the specified Coloring instance and the specified CategoryKey value.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIEnumerableColoringGetEnumerator
Returns an enumerator that iterates through this collection.
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through this collection.
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
See Also

Reference