Class DataRowReaderColumn

Represents a column returned by a Spotfire.Dxp.Data.DataRowReader.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Cursor DataType Name Properties GetFormattedCursor

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

Cursor

DataType

  • get DataType(): DataType

  • Gets the data type of the column.

    Returns DataType

    Since

    2.0

Name

  • get Name(): string

  • Gets the name of the column.

    Returns string

    Since

    2.0

Properties

GetFormattedCursor

  • GetFormattedCursor(): DataValueCursorGeneric<string>

  • Get a formatted cursor for retrieving the formatted values from this column. The formatted used is the formatter defined in the properties of this class, if no formatted is defined in the properties then the default formatter for the specified data type is used. The cursor will contain the formatted value in the current row after Spotfire.Dxp.Data.DataRowReader.MoveNext has been called.

    Returns DataValueCursorGeneric<string>

    A cursor which can be used to retrieve the formatted values for the current row.

    Since

    2.0

  • GetFormattedCursor(formatter): DataValueCursorGeneric<string>

  • Get a formatted cursor for retrieving the formatted values from this column with a specified formatter. The cursor will contain the formatted value in the current row after Spotfire.Dxp.Data.DataRowReader.MoveNext has been called.

    Parameters

    • formatter: IDataFormatter

      The formatter that should be used to format the values.

    Returns DataValueCursorGeneric<string>

    A cursor which can be used to retrieve the formatted values for the current row.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability