Class DataSourceOperation

This source operation represents data loaded from a Spotfire.Dxp.Data.DataSource.

Since

2.0

Hierarchy (view full)

DataOperation
- DataSourceOperation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataLoadingBehavior DisplayName Inputs CanReload CanReplaceDataFlow CanReplaceTransformations CanSetDataLoadingBehavior GetDataFlow GetTransformations Reload ReplaceDataFlow ReplaceTransformations TryGetOutputSignatures

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 DataOperation.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 DataOperation.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DataOperation.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

DataLoadingBehavior

get DataLoadingBehavior(): DataLoadingBehavior
Gets or sets the Spotfire.Dxp.Data.DataOperations.DataLoadingBehavior for this operation.

Returns DataLoadingBehavior
Since
2.0

Overrides DataOperation.DataLoadingBehavior
set DataLoadingBehavior(value): void
Gets or sets the Spotfire.Dxp.Data.DataOperations.DataLoadingBehavior for this operation.
Parameters
- value: DataLoadingBehavior
Returns void
Since
2.0

Overrides DataOperation.DataLoadingBehavior

DisplayName

get DisplayName(): string
Gets a localized display name for the operation. This string is for display purposes only.

Returns string
Since
2.0

Overrides DataOperation.DisplayName

Inputs

get Inputs(): System.Collections.Generic.IReadOnlyList<DataOperation>
Gets the inputs, if any, to the operation.

Returns System.Collections.Generic.IReadOnlyList<DataOperation>
Since
2.0

Overrides DataOperation.Inputs

CanReload

CanReload(): boolean
Checks whether the data for this operation can be reloaded.

Returns boolean
true if the data can be reloaded, false otherwise.

Since
2.0

Inherited from DataOperation.CanReload

CanReplaceDataFlow

CanReplaceDataFlow(): boolean
Checks whether it is possible to replace the Spotfire.Dxp.Data.DataFlow by calling ReplaceDataFlow(dataFlow).

Returns boolean
true if replacing the data flow is possible; otherwise false

Since
2.0

CanReplaceTransformations

CanReplaceTransformations(): boolean
Checks whether it is possible to replace transformations.

Returns boolean
true if replacing transformations is possible; otherwise false

Since
2.0

CanSetDataLoadingBehavior

CanSetDataLoadingBehavior(behavior): boolean
Checks whether the specified Spotfire.Dxp.Data.DataOperations.DataLoadingBehavior can be set on this operation.
Parameters
- behavior: DataLoadingBehavior
  The behavior to check.
Returns boolean
true if the specified behavior can be set, false otherwise.

Since
2.0

Inherited from DataOperation.CanSetDataLoadingBehavior

GetDataFlow

GetDataFlow(): DataFlow
Gets a copy of the Spotfire.Dxp.Data.DataFlow.

Returns DataFlow
A copy of the data flow.

Since
2.0

GetTransformations

GetTransformations(): System.Collections.Generic.IList<DataTransformation>
Gets a copy of the Spotfire.Dxp.Data.DataTransformations contained in the data flow.

Returns System.Collections.Generic.IList<DataTransformation>
A list of data transformations.

Since
2.0

Reload

Reload(): void
Reloads the data for this operation.

Returns void
Since
2.0

Inherited from DataOperation.Reload

ReplaceDataFlow

ReplaceDataFlow(dataFlow): void
Replaces the current data flow with the supplied Spotfire.Dxp.Data.DataFlow.
Parameters
- dataFlow: DataFlow
  The new data flow.
Returns void
Since
2.0

ReplaceTransformations

ReplaceTransformations(transformations): void
Replaces the current (if any) Spotfire.Dxp.Data.DataTransformations contained in the Spotfire.Dxp.Data.DataFlow, with the supplied transformations.
Parameters
- transformations: OrExplicit<System.Collections.Generic.IEnumerable<DataTransformation>>
  The new transformations.
Returns void
Since
2.0

TryGetOutputSignatures

TryGetOutputSignatures(outputSignatures): boolean
Tries to get the output Spotfire.Dxp.Data.DataColumnSignatures from this operation.
Parameters
- outputSignatures: OutParam<OrExplicit<System.Collections.Generic.IReadOnlyList<DataColumnSignature>>>
  If the method returns true, then these are the column signatures. (Note that zero columns is possible.)
Returns boolean
true if the column signatures are available, false otherwise.

Since
2.0

Inherited from DataOperation.TryGetOutputSignatures

Class DataSourceOperation

Since

Hierarchy (view full)

Index

Methods

Default capability

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

DataLoadingBehavior

Returns DataLoadingBehavior

Since

Parameters

Returns void

Since

DisplayName

Returns string

Since

Inputs

Returns System.Collections.Generic.IReadOnlyList<DataOperation>

Since

CanReload

Returns boolean

Since

CanReplaceDataFlow

Returns boolean

Since

CanReplaceTransformations

Returns boolean

Since

CanSetDataLoadingBehavior

Parameters

Returns boolean

Since

GetDataFlow

Returns DataFlow

Since

GetTransformations

Returns System.Collections.Generic.IList<DataTransformation>

Since

Reload

Returns void

Since

ReplaceDataFlow

Parameters

Returns void

Since

ReplaceTransformations

Parameters

Returns void

Since

TryGetOutputSignatures

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals