Class CalculationUpdateBehavior

Specifies the update behavior for calculations.

Since

2.0

Hierarchy (View Summary)

System.Enum
- CalculationUpdateBehavior

Index

Properties

`Static` `Readonly`Calculate

Calculate: Spotfire.Dxp.Data.CalculationUpdateBehavior

Specifies that a calculation should be automatically recalculated when changes occur.

Remark

This does not apply to dependencies on filtering selections, 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.

`Static` `Readonly`Invalidate

Invalidate: Spotfire.Dxp.Data.CalculationUpdateBehavior

Specifies that a calculation should be invalidated when changes occur, that is, not automatically recalculated.

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Enum.Cast

Equals

Equals(obj: any): 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.

Inherited from Enum.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Enum.GetHashCode

HasFlag

HasFlag(flag: System.Enum): boolean
Determines whether one or more bit fields are set in the current instance.
Parameters
- flag: System.Enum
  An enumeration value.
Returns boolean
true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

Inherited from Enum.HasFlag

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Enum.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from Enum.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from Enum.Equals

Default capability

And

And(...rest: System.Enum[]): this
Perform And operation on enum values.
Parameters
- ...rest: System.Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.And

Or

Or(...rest: System.Enum[]): this
Perform Or operation on enum values.
Parameters
- ...rest: System.Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.Or

Xor

Xor(...rest: System.Enum[]): this
Perform Xor operation on enum values.
Parameters
- ...rest: System.Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.Xor

Class CalculationUpdateBehavior

Since

Hierarchy (View Summary)

Index

Properties

Methods

Default capability

Properties

Static ReadonlyCalculate

Remark

Static ReadonlyInvalidate

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

HasFlag

Parameters

Returns boolean

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

And

Parameters

Returns this

Since

Or

Parameters

Returns this

Since

Xor

Parameters

Returns this

Since

Settings

On This Page

`Static` `Readonly`Calculate

`Static` `Readonly`Invalidate

`Static`Equals