Class DistinctDataValue

A wrapper class that holds a value that can occur in the column of a data table. The class provides equality and an ordering of the values even if they are of different underlying types. Values of the class can therefore be used in UndoableList and UndoableDictionary.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Value 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

    Returns T1

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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

constructor

Value

  • get Value(): unknown

  • Gets the value.

    Returns unknown

    Since

    2.0

CompareTo

  • CompareTo(other): number

  • Compares the current object to another Spotfire.Dxp.Data.DistinctDataValue.

    Parameters

    Returns number

    A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: A Value Less than zero; This object is less than the other parameter. Zero; This object is equal to other. Greater than zero; This object is greater than other.

    DistinctDataValues constructed from objects of different type will not be considered equal and never return zero.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability