Coloring Methods

 Spotfire 14.3 API Reference

The Coloring type exposes the following members.

Methods
  NameDescription
Public methodAddBottomNRule(Int32, Color)
Adds a bottom N rule to the end of the collection.
Public methodAddBottomNRule(ConditionValue, Color)
Adds a bottom N rule to the end of the collection.
Public methodAddCategoricalColorRule
Adds a new categorical color rule with default configuration to the end of the collection.
Public methodAddContinuousColorRule
Adds a new empty continuous rule to the end of the collection.
Public methodAddExpressionRule
Adds a new expression rule to the end of the collection.
Public methodAddRangeRule
Adds a range rule to the end of the collection.
Public methodAddStringColorRule
Adds a string color rule to the end of the collection.
Public methodAddThresholdColorRule
Adds a threshold color rule to the end of the collection.
Public methodAddTopNRule(Int32, Color)
Adds a top N rule to the end of the collection.
Public methodAddTopNRule(ConditionValue, Color)
Adds a top N rule to the end of the collection.
Public methodApply(String)
Applies the template named templateName from the ColoringTemplateCollection to this Coloring.
Public methodApply(Coloring)
Applies the given Coloring as a template. This will clear the current settings and replace them with the settings from the template.
Public methodClear
Clears this collection, removing all ColorRules.
Public methodContains
Determines whether the collection contains a specified rule.
Public methodGetColorForCategory
Gets the categorical color for the given category. The color is taken from the current CategoricalColorRule, or if no such rule is available the DefaultColor of this Coloring is returned.
Public methodGetEnumerator
Returns an enumerator that iterates through the ColorRules in this Coloring.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Determines the index of a specific rule in the collection.
Public methodMove
Moves a rule at the specified index to another location in the collection.
Public methodRemove
Removes the specified rule from the collection.
Public methodSaveAs(Stream)
Saves the Coloring to a stream.
Public methodSaveAs(LibraryItem, String, IEnumerableString)
Saves the coloring as a new item in the library.
Public methodSetColorForCategory
Sets a color for the given category in this Coloring. This will be set in a CategoricalColorRule in this collection. If no such rule is available when this methods is run, it will be added.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through this collection.
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
See Also

Reference

Coloring Class
Spotfire.Dxp.Application.Visuals.ConditionalColoring Namespace