About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class CategoryKey

Class representing a category on an axis.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- CategoryKey

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor CompareTo

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

constructor

new CategoryKey(...parts): CategoryKey
Initializes a new instance of the Spotfire.Dxp.Application.Visuals.CategoryKey class.
Parameters
- Rest...parts: any[]
  Values for each level in the hierarchy this CategoryKey refers to.
Returns CategoryKey
Since
2.0

Overrides Object.constructor

CompareTo

CompareTo(other): number
Compares the current object with another object of the same type.
Parameters
- other: CategoryKey
  An object to compare with this object.
Returns number
A 32-bit signed integer that indicates the relative order of the objects being compared. If it is zero, the objects are equal. If it is less than zero, this object is less than other. If greater than zero, this object is greater than other.

Since
2.0