Action
    Preparing search index...

    Class DataFunctionInput

    Defines how to retrieve the input for an Spotfire.Dxp.Data.DataFunctions.InputParameter in a Spotfire.Dxp.Data.DataFunctions.DataFunction.

    An input to a data function is an expression representing a list of columns and optionally a set of selections that can be used to define the rows that the expression should be calculated on. The expression is calculated on the intersection of all the included selections.

    Instances of this class is created in the Spotfire.Dxp.Data.DataFunctions.DataFunctionInputCollection class.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context Expression IncludeActiveFiltering IsAttached Selections Transactions ForEachNodeInSubTree

    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 Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Expression(): string

      Gets the expression that describes how to retrieve values for the input argument.

      Returns string

      The expression is a comma separated list of column expressions.

      2.0

    • get IncludeActiveFiltering(): boolean

      Gets a value indicating whether active filtering should be included in the selections as well.

      Returns boolean

      The expression is calculated on the intersection of all the included selections.

      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