Class TextFileDataSource

Data Source for delimited text files. Used when loading and saving linked data. Provides handle to a TextDataReader for text data retrieval.

Since

2.0

Hierarchy (View Summary)

FileDataSource
- TextFileDataSource

Index

Accessors

DocumentTitle

get DocumentTitle(): string
Gets a document title for the data returned from this data source with the current configuration.

Returns string
Inherited from FileDataSource.DocumentTitle

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 FileDataSource.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 FileDataSource.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from FileDataSource.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from FileDataSource.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 FileDataSource.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 FileDataSource.Equals

Default capability

constructor

new TextFileDataSource(stream: Stream): TextFileDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.TextFileDataSource class.
Parameters
- stream: Stream
  The stream.
Returns TextFileDataSource
Since
2.0

Overrides FileDataSource.constructor
new TextFileDataSource(
stream: Stream,
settings: Spotfire.Dxp.Data.Import.TextDataReaderSettings,
): TextFileDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.TextFileDataSource class.
Parameters
- stream: Stream
  The stream.
- settings: Spotfire.Dxp.Data.Import.TextDataReaderSettings
  The settings.
Returns TextFileDataSource
Since
2.0

Overrides FileDataSource.constructor

DataOriginIsStream

get DataOriginIsStream(): boolean
Gets a value indicating whether the data origin is a stream.

Returns boolean
Since
2.1

Inherited from FileDataSource.DataOriginIsStream

IsLinkable

get IsLinkable(): boolean
Gets a value indicating whether this instance supports linked data mode.

Returns boolean
Remark
A file data source is linkable if the origin is a file, not a stream.

Since
2.1

Inherited from FileDataSource.IsLinkable

IsPromptingAllowed

get IsPromptingAllowed(): boolean
Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.

Returns boolean
Since
2.0

Inherited from FileDataSource.IsPromptingAllowed
set IsPromptingAllowed(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FileDataSource.IsPromptingAllowed

Name

get Name(): string
Gets the display name of the data source. Same as the document title by default.

Returns string
Since
2.0

Inherited from FileDataSource.Name

ReuseSettingsWithoutPrompting

get ReuseSettingsWithoutPrompting(): boolean
Gets or sets a value indicating whether settings should be reused without prompting or not. Determines if the data source should be opened in silent mode, prompting the user only when necessary, or if the user should get a chance to modify the settings even if they are valid.

Returns boolean
Since
2.0

Inherited from FileDataSource.ReuseSettingsWithoutPrompting
set ReuseSettingsWithoutPrompting(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FileDataSource.ReuseSettingsWithoutPrompting

Settings

get Settings(): Spotfire.Dxp.Data.Import.TextDataReaderSettings
Gets or sets the settings.

Returns Spotfire.Dxp.Data.Import.TextDataReaderSettings
Since
2.0
set Settings(value: Spotfire.Dxp.Data.Import.TextDataReaderSettings): void
Parameters
- value: Spotfire.Dxp.Data.Import.TextDataReaderSettings
Returns void

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for the data source.

Returns TypeIdentifier
Since
2.0

Inherited from FileDataSource.TypeId

Connect

Connect(
serviceProvider: OrExplicit<IServiceProvider>,
promptMode: DataSourcePromptMode,
): DataSourceConnection
Creates a Spotfire.Dxp.Data.DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings.
Parameters
- serviceProvider: OrExplicit<IServiceProvider>
  The service provider.
- promptMode: DataSourcePromptMode
  The prompt mode.
Returns DataSourceConnection
A new DataSourceConnection instance.

Remark
The internal state of this data source object is not changed by this call. The returned connection will include a cloned and updated copy of this data source.

Since
2.0

Inherited from FileDataSource.Connect

ConnectWithDelayedPrompting

ConnectWithDelayedPrompting(
serviceProvider: OrExplicit<IServiceProvider>,
promptMode: DataSourcePromptMode,
): DataSourceConnection
Creates a Spotfire.Dxp.Data.DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings.
Parameters
- serviceProvider: OrExplicit<IServiceProvider>
  The service provider.
- promptMode: DataSourcePromptMode
  The prompt mode.
Returns DataSourceConnection
A new DataSourceConnection instance.

Remark
The caller of this method MUST retrieve the prompt models using the GetPromptModels() call on the connection and iterate over the entire collection of prompt models before the query is executed.

The internal state of this data source object is not changed by this call. The returned connection will include a cloned and updated copy of this data source.

Since
2.0

Inherited from FileDataSource.ConnectWithDelayedPrompting

Class TextFileDataSource

Since

Hierarchy (View Summary)

Index

Accessors

Methods

Default capability

Accessors

DocumentTitle

Returns string

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 TextFileDataSource

Since

Parameters

Returns TextFileDataSource

Since

DataOriginIsStream

Returns boolean

Since

IsLinkable

Returns boolean

Remark

Since

IsPromptingAllowed

Returns boolean

Since

Parameters

Returns void

Name

Returns string

Since

ReuseSettingsWithoutPrompting

Returns boolean

Since

Parameters

Returns void

Settings

Returns Spotfire.Dxp.Data.Import.TextDataReaderSettings

Since

Parameters

Returns void

TypeId

Returns TypeIdentifier

Since

Connect

Parameters

Returns DataSourceConnection

Remark

Since

ConnectWithDelayedPrompting

Parameters

Returns DataSourceConnection

Remark

Since

Settings

On This Page

`Static`Equals