Class ColumnsOutput

Represents the settings for the handling of a Spotfire.Dxp.Data.DataFunctions.OutputParameter of a Spotfire.Dxp.Data.DataFunctions.DataFunction. This class will add columns to an existing table when first executed and when updated it will either update those column or add new columns depending on the settings.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AddNewColumnsWhenUpdating Context DataTableReference InputToAdaptSelectionFrom IsAttached ResultColumns Transactions Transformations

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

AddNewColumnsWhenUpdating

  • get AddNewColumnsWhenUpdating(): boolean

  • Gets a value indicating whether the columns produced the first time should be replaced when executing a second time. If false the old columns will become embedded and the new rows added.

    Returns boolean

    Since

    2.0

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataTableReference

  • get DataTableReference(): DataTable

  • Gets the reference to table where the columns are added.

    Returns DataTable

    Since

    2.0

InputToAdaptSelectionFrom

  • get InputToAdaptSelectionFrom(): InputParameter

  • Gets the input whose selections should be used to map output rows back into the application.

    Returns InputParameter

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ResultColumns

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Transformations

Settings

Member Visibility

On This Page

Methods
Default capability