Class DataFlow

Represents a flow of data from the Spotfire.Dxp.Data.DataFlow.DataSource through an ordered set of Spotfire.Dxp.Data.DataTransformation's.

Remark

This class is immutable with no public constructor; use a Spotfire.Dxp.Data.DataFlowBuilder to create an instance of this class.

Since

2.0

Hierarchy (View Summary)

DataSource
- DataFlow

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataSource DocumentTitle IsLinkable IsPromptingAllowed Name ReuseSettingsWithoutPrompting Transformations TypeId Connect ConnectWithDelayedPrompting

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 DataSource.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.

Overrides DataSource.Equals
Equals(other: DataFlow): boolean
Indicates whether the current object is equal to another object of the same type.
Parameters
- other: DataFlow
  An object to compare with this object.
Returns boolean
true if the current object is equal to the other parameter; otherwise, false.

Overrides DataSource.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DataSource.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

DataSource

get DataSource(): DataSource
Gets a copy of the Spotfire.Dxp.Data.DataFlow.DataSource that this flow is based on.

Returns DataSource
Remark
The Spotfire.Dxp.Data.DataFlow.DataSource is used as input to the first Spotfire.Dxp.Data.DataTransformation. If no transformations are added then the Spotfire.Dxp.Data.DataFlow.DataSource is the output of the flow.

Since
2.0

DocumentTitle

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

Returns string
Remark
The default implementation returns string.Empty.

Since
2.0

Inherited from DataSource.DocumentTitle

IsLinkable

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

Returns boolean
Since
2.0

Inherited from DataSource.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 DataSource.IsPromptingAllowed
set IsPromptingAllowed(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from DataSource.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 DataSource.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 DataSource.ReuseSettingsWithoutPrompting
set ReuseSettingsWithoutPrompting(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from DataSource.ReuseSettingsWithoutPrompting

Transformations

get Transformations(): System.Collections.Generic.IList<DataTransformation>
Get a read-only copy of the list of Spotfire.Dxp.Data.DataTransformation's.

Returns System.Collections.Generic.IList<DataTransformation>
Since
2.0

TypeId

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

Returns TypeIdentifier
Since
2.0

Inherited from DataSource.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 DataSource.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 DataSource.ConnectWithDelayedPrompting

Class DataFlow

Remark

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

DataSource

Returns DataSource

Remark

Since

DocumentTitle

Returns string

Remark

Since

IsLinkable

Returns boolean

Since

IsPromptingAllowed

Returns boolean

Since

Parameters

Returns void

Name

Returns string

Since

ReuseSettingsWithoutPrompting

Returns boolean

Since

Parameters

Returns void

Transformations

Returns System.Collections.Generic.IList<DataTransformation>

Since

TypeId

Returns TypeIdentifier

Since

Connect

Parameters

Returns DataSourceConnection

Remark

Since

ConnectWithDelayedPrompting

Parameters

Returns DataSourceConnection

Remark

Since

Settings

On This Page

`Static`Equals