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 full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataLoadingBehavior DisplayName Inputs CanReload CanSetDataLoadingBehavior Reload 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

    Returns T1

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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

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

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

CanSetDataLoadingBehavior

Reload

  • Reload(): void

  • Reloads the data for this operation.

    Returns void

    Since

    2.0

TryGetOutputSignatures

Settings

Member Visibility

On This Page

Methods
Default capability