Action
    Preparing search index...

    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.

    Instance of this class is created in the Spotfire.Dxp.Data.DataFunctions.DataFunctionOutputCollection.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    AddNewColumnsWhenUpdating Context DataTableReference InputToAdaptSelectionFrom IsAttached ResultColumns Transactions Transformations

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • 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

      2.0

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DataTableReference(): DataTable

      Gets the reference to table where the columns are added.

      Returns DataTable

      2.0

    • get InputToAdaptSelectionFrom(): InputParameter

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

      Returns InputParameter

      May be null.

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability