Class DataFlow

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

Since

2.0

Hierarchy (view full)

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, 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

    Returns T1

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.

  • Equals(other): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

DataSource

DocumentTitle

  • get DocumentTitle(): string

  • Gets a document title for the data returned from this data source with the current configuration.

    Returns string

    Since

    2.0

IsLinkable

  • get IsLinkable(): boolean

  • Gets a value indicating whether this instance supports linked data mode.

    Returns boolean

    Since

    2.0

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

  • set IsPromptingAllowed(value): void

  • Parameters

    • value: boolean

    Returns void

Name

  • get Name(): string

  • Gets the display name of the data source. Same as the document title by default.

    Returns string

    Since

    2.0

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

  • set ReuseSettingsWithoutPrompting(value): void

  • Parameters

    • value: boolean

    Returns void

Transformations

TypeId

Connect

ConnectWithDelayedPrompting

Settings

Member Visibility

On This Page

Methods
Default capability