Class DataValueCursor

Non-generic cursor class for efficient enumeration of data values.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataValueCursor
  - DataValueCursorGeneric

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CurrentDataValue IsCurrentValueValid Create CreateFormatted CreateNumeric CreateTime

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

CurrentDataValue

get CurrentDataValue(): DataValue
Gets the data value.

Returns DataValue
Since
2.0

IsCurrentValueValid

get IsCurrentValueValid(): boolean
Gets a value indicating whether the current value is valid or not.

Returns boolean
Since
2.0

`Static`Create

Create(column): DataValueCursor
Creates a non-generic value cursor for a given column.
Parameters
- column: DataColumn
  The column.
Returns DataValueCursor
A value cursor.

Since
2.0
Create<T>(typeT, column): DataValueCursorGeneric<T>
Creates a generic value cursor for a given column.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- column: IDataColumn
  The column.
Returns DataValueCursorGeneric<T>
A value cursor.

Since
2.0
Create<T>(typeT, column, checkValidity): DataValueCursorGeneric<T>
Creates a generic value cursor for a given column.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- column: IDataColumn
  The column.
- checkValidity: boolean | Boolean
  True if a validity check should be performed.
Returns DataValueCursorGeneric<T>
A value cursor.

Since
2.0

`Static`CreateFormatted

CreateFormatted(column): DataValueCursorGeneric<string>
Creates a value cursor for the formatted values of a given column.
Parameters
- column: IDataColumn
  The column.
Returns DataValueCursorGeneric<string>
A value cursor.

Since
2.0
CreateFormatted(column, formatter): DataValueCursorGeneric<string>
Creates a value cursor for the formatted values of a given column.
Parameters
- column: IDataColumn
  The column.
- formatter: IDataFormatter
  The formatter to use. Note that this is useless if column is a hierarchy since the individual level formatters are used then.
Returns DataValueCursorGeneric<string>
A value cursor.

Since
2.0

`Static`CreateNumeric

CreateNumeric(column): DataValueCursorGeneric<number>
Creates a value cursor for the numeric values of a given column.
Parameters
- column: IDataColumn
  The column.
Returns DataValueCursorGeneric<number>
A value cursor.

Since
2.0
CreateNumeric(column, checkValidity): DataValueCursorGeneric<number>
Creates a value cursor for the numeric values of a given column.
Parameters
- column: IDataColumn
  The column.
- checkValidity: boolean | Boolean
  True if a check for validity should be performed.
Returns DataValueCursorGeneric<number>
A value cursor.

Since
2.0

`Static`CreateTime

CreateTime(column): DataValueCursorGeneric<DateTime>
Creates a value cursor for DateTime values of a given column.
Parameters
- column: IDataColumn
  The column.
Returns DataValueCursorGeneric<DateTime>
A value cursor.

Since
2.0

Class DataValueCursor

Since

Hierarchy (view full)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

CurrentDataValue

Returns DataValue

Since

IsCurrentValueValid

Returns boolean

Since

StaticCreate

Parameters

Returns DataValueCursor

Since

Type Parameters

Parameters

Returns DataValueCursorGeneric<T>

Since

Type Parameters

Parameters

Returns DataValueCursorGeneric<T>

Since

StaticCreateFormatted

Parameters

Returns DataValueCursorGeneric<string>

Since

Parameters

Returns DataValueCursorGeneric<string>

Since

StaticCreateNumeric

Parameters

Returns DataValueCursorGeneric<number>

Since

Parameters

Returns DataValueCursorGeneric<number>

Since

StaticCreateTime

Parameters

Returns DataValueCursorGeneric<DateTime>

Since

Settings

On This Page

`Static`Equals

`Static`Create

`Static`CreateFormatted

`Static`CreateNumeric

`Static`CreateTime