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

Class DataRowReader

Represents a resettable iterator of rows values. It is used to retrieve data from a Spotfire.Dxp.Data.DataSource or Spotfire.Dxp.Data.DataTransformation.

Remark

Instances of this class can be retrieved from a Spotfire.Dxp.Data.DataSourceConnection or a Spotfire.Dxp.Data.DataTransformationConnection.

It is not possible to inherit directly from this class, this should be done through the CustomDataRowReader class.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataRowReader

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Columns IsClosed ResultProperties Close Dispose MoveNext Reset

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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: any): 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: T2, type: TypeRef<T1>): 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: any, objB: any): 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

Columns

get Columns(): DataRowReaderColumnCollection
Represents a collection of the columns that the reader returns.

Returns DataRowReaderColumnCollection
Since
2.0

IsClosed

get IsClosed(): boolean
Gets a value indicating whether the data reader is closed.

Returns boolean
Since
2.0

ResultProperties

get ResultProperties(): ResultProperties
Gets a read-only copy of the result properties, this is properties for the entire reader result and not for a specific column.

Returns ResultProperties
Since
2.0

Close

Close(): void
Closes the data reader.

Returns void
Since
2.0

Dispose

Dispose(): void
Dispose method.

Returns void
Since
2.0

MoveNext

MoveNext(): boolean
Advances the reader to the next row.

Returns boolean
true if there are more rows; otherwise, false.

Remark
The Spotfire.Dxp.Data.DataValueCursors in the Spotfire.Dxp.Data.DataRowReaderColumns now have the new values.

Since
2.0

Reset

Reset(): void
Resets the reader so that the next time Spotfire.Dxp.Data.DataRowReader.MoveNext is called the first row will be returned.

Returns void
Since
2.0