Class InformationLinkDataSource

Data source for information links.

Since

2.0

Hierarchy (View Summary)

DataSource
- InformationLinkDataSource

Index

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.

Inherited from 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

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

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

Extended capability 'LibraryRead'

constructor

new InformationLinkDataSource(): InformationLinkDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.InformationLinkDataSource class.

Returns InformationLinkDataSource
Since
2.0

Overrides DataSource.constructor
new InformationLinkDataSource(
informationLinkId: Guid,
): InformationLinkDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.InformationLinkDataSource class.
Parameters
- informationLinkId: Guid
  The unique identifier for the information link.
Returns InformationLinkDataSource
Since
2.0

Overrides DataSource.constructor
new InformationLinkDataSource(
informationLinkLibraryItem: LibraryItem,
): InformationLinkDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.InformationLinkDataSource class.
Parameters
- informationLinkLibraryItem: LibraryItem
  The LibraryItem representing the information link.
Returns InformationLinkDataSource
Since
2.0

Overrides DataSource.constructor
new InformationLinkDataSource(
    informationLinkId: Guid,
    parameters: OrExplicit<
        System.Collections.Generic.IEnumerable<InformationLinkParameter>,
    >,
): InformationLinkDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.InformationLinkDataSource class.
Parameters
- informationLinkId: Guid
  The unique identifier for the information link.
- parameters: OrExplicit<System.Collections.Generic.IEnumerable<InformationLinkParameter>>
  A list of parameters that are applied when executing the information link. Parameters for elements that are not included in the information link will be ignored. If prompting is enabled a parameter is used as default value in a prompt step if the target element is the same. If prompting is not enabled, the parameters will be applied unchanged, unless prompt values were saved in the document previously. Parameters for other elements not included in any prompt steps are applied unchanged (also in the prompt steps). The parameters are persisted with the data source when saving an analysis, and are re-applied when opening the same analysis. See Spotfire.Dxp.Data.Import.InformationLinkParameter for a description on how to create a parameter. This argument is optional and may be set to null.
Returns InformationLinkDataSource
Since
2.0

Overrides DataSource.constructor
new InformationLinkDataSource(
    informationLinkId: Guid,
    parameters: OrExplicit<
        System.Collections.Generic.IEnumerable<InformationLinkParameter>,
    >,
    documentTitle: string | String,
): InformationLinkDataSource
Initializes a new instance of the Spotfire.Dxp.Data.Import.InformationLinkDataSource class.
Parameters
- informationLinkId: Guid
  The unique identifier for the information link.
- parameters: OrExplicit<System.Collections.Generic.IEnumerable<InformationLinkParameter>>
  A list of parameters that are applied when executing the information link. Parameters for elements that are not included in the information link will be ignored. If prompting is enabled a parameter is used as default value in a prompt step if the target element is the same. If prompting is not enabled, the parameters will be applied unchanged, unless prompt values were saved in the document previously. Parameters for other elements not included in any prompt steps are applied unchanged (also in the prompt steps). The parameters are persisted with the data source when saving an analysis, and are re-applied when opening the same analysis. See Spotfire.Dxp.Data.Import.InformationLinkParameter for a description on how to create a parameter. This argument is optional and may be set to null.
- documentTitle: string | String
  The document title, overriding the default derived from the name of the information link,
Returns InformationLinkDataSource
Since
2.0

Overrides DataSource.constructor

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

Overrides DataSource.DocumentTitle

Id

get Id(): Guid
Gets or sets the id of a referenced information link stored on the server.

Returns Guid
Since
2.0
set Id(value: Guid): void
Parameters
- value: Guid
Returns void

IsLinkable

get IsLinkable(): boolean
Returns true to indicate that this instance supports linked data mode.

Returns boolean
Since
2.0

Overrides DataSource.IsLinkable

Parameters

get Parameters(): System.Collections.Generic.IList<InformationLinkParameter>
Gets or sets a list of parameters that are applied when executing the information link. Parameters for elements that are not included in the information link will be ignored. If prompting is enabled a parameter is used as default value in a prompt step if the target element is the same. If prompting is not enabled, the parameters will be applied unchanged, unless prompt values were saved in the document previously. Parameters for elements not included in any prompt steps are applied unchanged (also in the prompt steps). The parameters are persisted with the data source when saving an analysis, and are re-applied when opening the same analysis. See Spotfire.Dxp.Data.Import.InformationLinkParameter for a description on how to create a parameter. This argument is optional and may be set to null.

Returns System.Collections.Generic.IList<InformationLinkParameter>
Since
2.0
set Parameters(
    value: OrExplicit<
        System.Collections.Generic.IList<InformationLinkParameter>,
    >,
): void
Parameters
- value: OrExplicit<System.Collections.Generic.IList<InformationLinkParameter>>
Returns void

`Static`BrowseForInformationLink

BrowseForInformationLink(): InformationLinkDescriptor
Lets the user browse or search for an information link.

Returns InformationLinkDescriptor
The selected information link, or null if no selection was done.

Since
2.0

`Static`FindAll

FindAll(searchExpression: string | String): InformationLinkDescriptorCollection
Call this method with a search expression to get a collection of InformationLinkDescriptors matching the expression.
Parameters
- searchExpression: string | String
  A search expression for matching metadata of InformationLinks in the form property:value (matching begining of words) or property::value (exact match) e.g. name::baseball.
Returns InformationLinkDescriptorCollection
Information link descriptors representing the elements matching the expression. If no match, the list is empty.

Since
2.0

`Static`GetInformationLinkDescriptor

GetInformationLinkDescriptor(informationLinkId: Guid): InformationLinkDescriptor
Get an Spotfire.Dxp.Data.Import.InformationLinkDescriptor corresponding to given identifier.
Parameters
- informationLinkId: Guid
  The unique identifier for the information link.
Returns InformationLinkDescriptor
Information link descriptors or null (if not eavailable).

Since
2.0

Class InformationLinkDataSource

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Extended capability 'LibraryRead'

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

IsPromptingAllowed

Returns boolean

Since

Parameters

Returns void

Name

Returns string

Since

ReuseSettingsWithoutPrompting

Returns boolean

Since

Parameters

Returns void

TypeId

Returns TypeIdentifier

Since

Connect

Parameters

Returns DataSourceConnection

Remark

Since

ConnectWithDelayedPrompting

Parameters

Returns DataSourceConnection

Remark

Since

Extended capability 'LibraryRead'

constructor

Returns InformationLinkDataSource

Since

Parameters

Returns InformationLinkDataSource

Since

Parameters

Returns InformationLinkDataSource

Since

Parameters

Returns InformationLinkDataSource

Since

Parameters

Returns InformationLinkDataSource

Since

DocumentTitle

Returns string

Since

Id

Returns Guid

Since

Parameters

Returns void

IsLinkable

Returns boolean

Since

`Static`Equals

`Static`BrowseForInformationLink

`Static`FindAll

`Static`GetInformationLinkDescriptor