About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataSourceConnection

Represents an open connection to a data source.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataSourceConnection

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ConnectedUserName DataSource DocumentTitle HasUserDependentData IsLinkable ServiceProvider Close Dispose ExecuteQuery2

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

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.

Inherited from Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

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.

Inherited from Object.Equals

Default capability

ConnectedUserName

get ConnectedUserName(): string
Gets or sets the name of the connected user.

Returns string
Since
2.0
set ConnectedUserName(value): void
Parameters
- value: string
Returns void

DataSource

get DataSource(): DataSource
Gets the data source.

Returns DataSource
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
Since
2.0

HasUserDependentData

get HasUserDependentData(): boolean
Gets or sets a value indicating whether the data depends on the current user or not.

Returns boolean
Since
2.0
set HasUserDependentData(value): void
Parameters
- value: boolean
Returns void

IsLinkable

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

Returns boolean
Since
2.0

ServiceProvider

get ServiceProvider(): IServiceProvider
Gets access to services.

Returns IServiceProvider
Since
2.0

Close

Close(): void
Synonym for Dispose.

Returns void
Since
2.0

Dispose

Dispose(): void
Disposes of the connection.

Returns void
Since
2.0

ExecuteQuery2

ExecuteQuery2(): DataRowReader
Executes the query with the current data source settings and returns the resulting Spotfire.Dxp.Data.DataRowReader.

Returns DataRowReader
A new Spotfire.Dxp.Data.DataRowReader instance.

Since
2.0