Class StdfTableWriter

This class provides a simple interface for writing data to the STDF format.

Since

2.1

Hierarchy (View Summary)

Spotfire.Object
- StdfTableWriter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Close Dispose Flush WriteLine WriteValue

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

constructor

new StdfTableWriter(
outputStream: Stream,
metadata: StdfTableMetadata,
): StdfTableWriter
Initializes a new instance of the Spotfire.Dxp.Data.Formats.Stdf.StdfTableWriter class.
Parameters
- outputStream: Stream
  The output stream. The StdfTableWriter will close the stream when it is disposed. By default, an UTF8 encoding with a BOM will be used.
- metadata: StdfTableMetadata
  The table metadata, which must include metadata for all columns.
Returns StdfTableWriter
Since
2.1

Overrides Object.constructor
new StdfTableWriter(
    outputStream: Stream,
    metadata: StdfTableMetadata,
    encoding: Encoding,
    formatVersion: string | String,
): StdfTableWriter
Initializes a new instance of the Spotfire.Dxp.Data.Formats.Stdf.StdfTableWriter class.
Parameters
- outputStream: Stream
  The output stream. The StdfTableWriter will close the stream when it is disposed.
- metadata: StdfTableMetadata
  The table metadata, which must include metadata for all columns.
- encoding: Encoding
  The character encoding, which must be UTF8 with or without a byte order mark.
- formatVersion: string | String
  The STDF version to be used, either "1.0" or "2.0".
Returns StdfTableWriter
Since
2.1

Overrides Object.constructor

Close

Close(): void
Closes this TableWrite instance and the underlying stream.

Returns void
Since
2.1

Dispose

Dispose(): void
Disposes of this StdfTableWriter instance. Will flush and close the output stream.

Returns void
Since
2.1

Flush

Flush(): void
Flushes all buffered output to the underlying output stream.

Returns void
Since
2.1

WriteLine

WriteLine(): void
Writes the STDF end-of-line character sequence to the output stream.

Returns void
Since
2.1

WriteValue

WriteValue(value: any): void
Adds a value to the table. Values are added in a row-based manner, round-robin. For each row values must be provided for all columns. A null argument is interpreted as a null/missing value.
Parameters
- value: any
  The new value. The object's type has to match the current column.
Returns void
Since
2.1

Class StdfTableWriter

Since

Hierarchy (View Summary)

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

constructor

Parameters

Returns StdfTableWriter

Since

Parameters

Returns StdfTableWriter

Since

Close

Returns void

Since

Dispose

Returns void

Since

Flush

Returns void

Since

WriteLine

Returns void

Since

WriteValue

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals