CategoryKey Class TIBCO Spotfire 7.6 API Reference
Class representing a category on an axis.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.VisualsCategoryKey

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

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

The CategoryKey type exposes the following members.

Constructors

  NameDescription
Public methodCategoryKey
Initializes a new instance of the CategoryKey class.
Top
Methods

  NameDescription
Public methodCompareTo
Compares the current object with another object of the same type.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Top
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.

Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference