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

Class DataRowCursor

Class for sequential scanning through the rows of a data set defined by a collection of columns.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataRowCursor

Index

Methods

Cast Equals GetHashCode MoveNext Reset ToString TryCast [iterator] Equals

Default capability

constructor CurrentIndex ValueCount Dispose

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

MoveNext

MoveNext(): boolean
Advances the enumerator to the next element of the collection.

Returns boolean
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Reset

Reset(): void
Sets the enumerator to its initial position, which is before the first element in the collection.

Returns void

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

[iterator]

[iterator](): Iterator<DataRow, any, undefined>
Returns Iterator<DataRow, any, undefined>

`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 DataRowCursor(rowIndexes, ...values): DataRowCursor
Create a new data row cursor given a number of value cursors and an enumerator indexes.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The indexes to enumerate over.
- Rest...values: DataValueCursor[]
  The value cursors.
Returns DataRowCursor
Since
2.0

Overrides Object.constructor

CurrentIndex

get CurrentIndex(): number
The current row index.

Returns number
Since
2.0

ValueCount

get ValueCount(): number
The number of columns in a row.

Returns number
Since
2.0

Dispose

Dispose(): void
Implements IDisposable.

Returns void
Since
2.0