CategoricalColorRule Class

Spotfire 14.3 API Reference

Represents a color rule for categorical coloring.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColorRule
        Spotfire.Dxp.Application.Visuals.ConditionalColoringCategoricalColorRule

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

[SerializableAttribute]
[PersistenceVersionAttribute(10, 10)]
public sealed class CategoricalColorRule : ColorRule

The CategoricalColorRule type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of explicitly mapped categories.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemObject	Gets or sets the color for a category.
	ItemCategoryKey	Gets or sets the color for a category.
	ManualDisplayName	Gets or sets the display name. If set to null, the ColorRule will be represented with an auto-generated name. (Inherited from ColorRule.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Methods

	Name	Description
	GetExplicitCategories	Gets all explicitly mapped categories.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetColors	Sets the colors to be used in this categorical color rule. This resets this CategoricalColorRule to only use the given colors.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Explicit Interface Implementations

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

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