Action
    Preparing search index...

    Class DataSource

    Abstract class for data sources. Used when loading and saving linked data.

    Implementors of this class must be serializable.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    DocumentTitle IsLinkable IsPromptingAllowed Name ReuseSettingsWithoutPrompting TypeId Connect ConnectWithDelayedPrompting

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get DocumentTitle(): string

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

      Returns string

      The default implementation returns string.Empty.

      2.0

    • get IsLinkable(): boolean

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

      Returns boolean

      2.0

    • get IsPromptingAllowed(): boolean

      Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.

      Returns boolean

      2.0

    • set IsPromptingAllowed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Name(): string

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

      Returns string

      2.0

    • 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

      2.0

    • set ReuseSettingsWithoutPrompting(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      Returns DataSourceConnection

      A new DataSourceConnection instance.

      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.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability