Class DataOperation

This class represents an operation performed to construct a Spotfire.Dxp.Data.DataTable. An operation can have zero or more inputs. Operations with no inputs are typically sources, those with one input perform some form of transformation of the data, and those with more than one input join or add data. The tree structure can be traversed by using the Spotfire.Dxp.Data.DataOperations.DataOperation.Inputs property.

TryGetOutputSignatures(outputSignatures) can be used to check the output of the operation.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataOperation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataLoadingBehavior DisplayName Inputs CanReload CanSetDataLoadingBehavior Reload TryGetOutputSignatures

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 Object.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 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: 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 Object.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 Object.Equals

Default capability

DataLoadingBehavior

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

Returns DataLoadingBehavior
Remark
Before using the set accessor, validate that CanSetDataLoadingBehavior(behavior) is true.

Since
2.0
set DataLoadingBehavior(value: DataLoadingBehavior): void
Parameters
- value: DataLoadingBehavior
Returns void

DisplayName

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

Returns string
Remark
Note: This string should not be used to programmatically check for the presence of any particular setting. The format and content of this string may change between releases. See the various concrete Spotfire.Dxp.Data.DataOperations classes for details on how to read specific settings.

Since
2.0

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

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

CanSetDataLoadingBehavior

CanSetDataLoadingBehavior(behavior: DataLoadingBehavior): 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

Reload

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

Returns void
Since
2.0

TryGetOutputSignatures

TryGetOutputSignatures(
    outputSignatures: OutParam<
        OrExplicit<
            System.Collections.Generic.IReadOnlyList<DataColumnSignature>,
        >,
    >,
): 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.

Remark
If the entire data table was embedded, for example, then column signatures may not be available.

Since
2.0

Class DataOperation

Since

Hierarchy (View Summary)

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

Remark

Since

Parameters

Returns void

DisplayName

Returns string

Remark

Since

Inputs

Returns System.Collections.Generic.IReadOnlyList<DataOperation>

Since

CanReload

Returns boolean

Since

CanSetDataLoadingBehavior

Parameters

Returns boolean

Since

Reload

Returns void

Since

TryGetOutputSignatures

Parameters

Returns boolean

Remark

Since

Settings

On This Page

`Static`Equals