CategoryKey Class

TIBCO Spotfire 6.0 API Reference

Class representing a category on an axis.

Inheritance Hierarchy

System Object
Spotfire.Dxp.Application.Visuals CategoryKey

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
[ImmutableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class CategoryKey : ISerializable, 
	IComparable<CategoryKey>, ICategoryKey, IComparable<ICategoryKey>, 
	ILibraryXmlSerializable

[SerializableAttribute]
[ImmutableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class CategoryKey : ISerializable, 
	IComparable<CategoryKey>, ICategoryKey, IComparable<ICategoryKey>, 
	ILibraryXmlSerializable

Remarks

This class is primarily used when mapping categories to aestetic attributes like color and shape.

Since categorical axes are hierarchical, a CategoryKey is made from the values of each level in the hierarchy. For instance, if an axis has an expression that nests an integer column within a string column, a category key would be defined by a string value and an integer.