ColoringCollection.GetColoringForCategory Method

ColoringCollection GetColoringForCategory Method

TIBCO Spotfire 6.0 API Reference

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.

Namespace: Spotfire.Dxp.Application.Visuals.ConditionalColoring
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public Coloring GetColoringForCategory(
	CategoryKey category
)

public Coloring GetColoringForCategory(
	CategoryKey category
)

Parameters

category: Type: Spotfire.Dxp.Application.Visuals CategoryKey
The category.

Return Value

Type: Coloring
The mapped Coloring instance, the default, or null when no default can be established.

Exceptions

Exception	Condition
System ArgumentNullException	Thrown if category is null.