Class DataFunction

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

Since

2.0

Hierarchy (view full)

Implements

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

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataFunctionDefinition

Inputs

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Name

  • get Name(): string

  • Gets or sets the name of the function.

    Returns string

    Since

    2.0

  • set Name(value): void

  • Parameters

    • value: string

    Returns void

NeedsRefresh

  • get NeedsRefresh(): boolean

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

    Returns boolean

    Since

    2.0

Outputs

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

UpdateBehavior

Visible

  • get Visible(): boolean

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

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

Execute

  • Execute(): void

  • Asynchronously executes the data function.

    Returns void

    Since

    2.0

ExecuteSynchronously

  • ExecuteSynchronously(): boolean

  • Updates the function synchronously.

    Returns boolean

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

    Since

    2.0

Extended capability 'LibraryRead'

SynchronizeWithLibrary

  • SynchronizeWithLibrary(): boolean

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

    Returns boolean

    True if it successfully synchronized; False otherwise.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryRead'