Coloring Methods TIBCO Spotfire 7.11 API Reference

The Coloring type exposes the following members.

Methods

  Name Description
Public method AddBottomNRule(Int32, Color)
Adds a bottom N rule to the end of the collection.
Public method AddBottomNRule(ConditionValue, Color)
Adds a bottom N rule to the end of the collection.
Public method AddCategoricalColorRule
Adds a new categorical color rule with default configuration to the end of the collection.
Public method AddContinuousColorRule
Adds a new empty continuous rule to the end of the collection.
Public method AddExpressionRule
Adds a new expression rule to the end of the collection.
Public method AddRangeRule
Adds a range rule to the end of the collection.
Public method AddStringColorRule
Adds a string color rule to the end of the collection.
Public method AddThresholdColorRule
Adds a threshold color rule to the end of the collection.
Public method AddTopNRule(Int32, Color)
Adds a top N rule to the end of the collection.
Public method AddTopNRule(ConditionValue, Color)
Adds a top N rule to the end of the collection.
Public method Apply(String)
Applies the template named templateName from the ColoringTemplateCollection to this Coloring.
Public method Apply(Coloring)
Applies the given Coloring as a template. This will clear the current settings and replace them with the settings from the template.
Public method Clear
Clears this collection, removing all ColorRules.
Public method Contains
Determines whether the collection contains a specified rule.
Public method GetColorForCategory
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 method GetEnumerator
Returns an enumerator that iterates through the ColorRules in this Coloring.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method IndexOf
Determines the index of a specific rule in the collection.
Public method Move
Moves a rule at the specified index to another location in the collection.
Public method Remove
Removes the specified rule from the collection.
Public method SaveAs(Stream)
Saves the Coloring to a stream.
Public method SaveAs(LibraryItem, String, IEnumerableString)
Saves the coloring as a new item in the library.
Public method SetColorForCategory
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.
Top
Explicit Interface Implementations

  Name Description
Explicit interface implementation Private method IEnumerableGetEnumerator
Returns an enumerator that iterates through this collection.
Explicit interface implementation Private method IServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementation Private method INodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
See Also

Reference