Class DataWriter

Represents a class capable of exporting data from a Spotfire.Dxp.Data.DataTable to a Stream given a set of ordered row indexes and a enumerable of column names.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataWriter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CanWriteFromReader Write

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

CanWriteFromReader

get CanWriteFromReader(): boolean
Gets a value indicating whether this instance can write from reader.

Returns boolean
Since
2.0

Write

Write(stream, dataRowReader): void
Writes data from Spotfire.Dxp.Data.DataRowReader to the specified stream.
Parameters
- stream: Stream
  The opened writable stream.
- dataRowReader: DataRowReader
  The data row reader.
Returns void
Since
2.0
Write(stream, dataRowReader, columns): void
Writes data from Spotfire.Dxp.Data.DataRowReader to the specified stream.
Parameters
- stream: Stream
  The opened writable stream.
- dataRowReader: DataRowReader
  The data row reader.
- columns: DataRowReaderColumnCollection
  The columns in the data row reader that should be exported.
Returns void
Since
2.0
Write(stream, dataTable, rowIndexes, columnNames): void
Writes data from a Spotfire.Dxp.Data.DataTable to the specified stream.
Parameters
- stream: Stream
  The opened writable stream.
- dataTable: DataTable
  The data table.
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The ordered row indexes that should be used to export the data.
- columnNames: OrExplicit<System.Collections.Generic.IEnumerable<string | String>>
  The column names in the table that should be exported.
Returns void
Since
2.0

Class DataWriter

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

CanWriteFromReader

Returns boolean

Since

Write

Parameters

Returns void

Since

Parameters

Returns void

Since

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals