Class Calculation<TSettings, TResults>

Base class for calculations.

Since

2.0

Type Parameters

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CalculationResults CalculationSettings Context IsAttached IsValid Name NeedsRefresh Transactions TypeId UpdateBehavior Execute SetName

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

CalculationResults

CalculationSettings

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsValid

  • 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

    Since

    2.0

Name

  • get Name(): string

  • Gets the unique name of this calculation instance.

    Returns string

    Since

    2.0

NeedsRefresh

  • 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

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TypeId

UpdateBehavior

Execute

  • Execute(): boolean

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

    Since

    2.0

SetName

  • SetName(suggestedName): string

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

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability