Action
    Preparing search index...

    Class DataFunction

    Represents an execution of a data function defined from a Spotfire.Dxp.Data.DataFunctions.DataFunction.DataFunctionDefinition.

    This class describes how inputs and outputs should be handled from the function.

    Instances of this class are created in the Spotfire.Dxp.Data.DataFunctions.DataFunctionCollection on the Spotfire.Dxp.Data.DataManager.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context DataFunctionDefinition Inputs IsAttached Name NeedsRefresh Outputs Transactions UpdateBehavior Visible Execute ExecuteSynchronously

    Extended capability 'LibraryRead'

    SynchronizeWithLibrary

    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 IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get NeedsRefresh(): boolean

      Gets a value indicating whether the data function needs to be refreshed.

      Returns boolean

      This occurs when the input to the function have changed since it was previously executed.

      This value may be expensive to calculated.

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visible(): boolean

      Gets or sets a value indicating whether the function is visible in the UI or not.

      Returns boolean

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • Asynchronously executes the data function.

      Returns void

      There is no guarantee regarding timing when the function will be executed and when it has finished executing.

      If you need to know when the execute has finished then use the overload with a callback instead.

      2.0

    • Updates the function synchronously.

      Returns boolean

      True if the data function ran to completion and updated the document; otherwise false.

      2.0

    Extended capability 'LibraryRead'

    • Synchronize the function definition with the function definition stored in the library.

      Returns boolean

      True if it successfully synchronized; False otherwise.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability
    Extended capability 'LibraryRead'