Coloring Class

Spotfire 14.3 API Reference

Represents a color scheme used to color a visualization. The Coloring class is a list of ColorRules. A Coloring will assign colors to values using first its rules, and if none of them match either the DefaultColor or EmptyColor will be used.

Inheritance Hierarchy

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

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(49, 0)]
public sealed class Coloring : DocumentNode, 
	IEnumerable<ColorRule>, IEnumerable

The Coloring type exposes the following members.

Properties

	Name	Description
	ColorByOther	Gets an object that enables coloring by another expression than the default.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of ColorRule instances in this Coloring.
	DefaultColor	Gets or sets the default color. This color is used for values that are non-empty and are not colored by any ColorRule.
	DisplayName	Gets or sets the display name of this Coloring.
	EmptyColor	Gets or sets color used for empty values.
	EvaluatePerColumn	Gets or sets a value indicating whether this Coloring should be evaluated per column.
	EvaluatePerTrellis	Gets or sets a value indicating whether this Coloring should be evaluated per trellis panel.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the ColorRule at the specified index.
	SetColorOnText	Gets or sets a value indicating whether to set color on cell text or on cell background. This property is used by tabular visualizations.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

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

Top

Explicit Interface Implementations

	Name	Description
	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