Action
    Preparing search index...

    Class representing a category on an axis.

    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.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    • 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

      Returns T1

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

      Returns null | T1

    • 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.

    Default capability

    • 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.

      2.0