Action
    Preparing search index...

    Class Calculation

    Abstract class representing a calculation.

    This class cannot be extended through inheritance. See Spotfire.Dxp.Application.Extension.CustomCalculation instead

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context IsAttached IsValid Name NeedsRefresh Transactions TypeId UpdateBehavior Execute ForEachNodeInSubTree SetName

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

      Gets a value indicating whether or not this calculation can be calculated. A calculation may for example be invalid when vital dependencies are missing.

      Returns boolean

      2.0

    • get Name(): string

      Gets the unique name of this calculation instance.

      Returns string

      2.0

    • get NeedsRefresh(): boolean

      Gets a value indicating whether or not this calculation needs refreshing (through a call to Execute) to make sure that its results are up-to-date.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get UpdateBehavior(): CalculationUpdateBehavior

      Gets the Spotfire.Dxp.Data.CalculationUpdateBehavior of the calculation.

      Returns CalculationUpdateBehavior

      This determines whether the calculation should be reexecuted immediately when dependencies change or just indicate their need of refresh. Note that columns residing in a normal table will also be asked to recalculate themselves when the rowcount of their table changes regardless of their normal UpdateBehavior. Note that automatic update behavior does not apply to filterdependencies which will never cause an automatic update. If filterdependencies are used it is recommended to use Invalidate behavior instead to ensure a smooth user experience when filtering.

      2.0

    • Execute the calculation. If the results exists they will updated - otherwise they will be created.

      Returns boolean

      True if the execution was successfully performed; otherwise false.

      This is equal to calling Execute(CalculationExecutionPromptMode.Always)

      2.0

    • Set the unique (within the CalculationCollection) name of this Spotfire.Dxp.Data.Calculation instance.

      Parameters

      • suggestedName: string | String

        The name suggestion

      Returns string

      If suggestedName is unique it is used and returned, otherwise it is first made unique by adding (2), (3) etc.

      Always use the returned value rather than the suggestedName to refer to the calculation

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability