Class CalculationCollection

A collection of calculation instances.

Since

2.0

Hierarchy (View Summary)

DocumentNodeListBase<Spotfire.Dxp.Data.Calculation>
- CalculationCollection

Implements

Index

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Data.Calculation>
Returns Iterator<Spotfire.Dxp.Data.Calculation>
Overrides DocumentNodeListBase.[iterator]

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 DocumentNodeListBase.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 DocumentNodeListBase.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNodeListBase.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNodeListBase.ToString

TryCast

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

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, Spotfire.Dxp.Data.Calculation>

Gets the element at the specified index.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index.

Since

2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Context

Count

get Count(): number
Gets the number of elements contained in this instance.

Returns number
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Count

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Transactions

AddNew

AddNew(typeId: TypeIdentifier): Spotfire.Dxp.Data.Calculation
Adds a new instance of the calculation identified by typeId to this collection.
Parameters
- typeId: TypeIdentifier
  The Spotfire.Dxp.Framework.DocumentModel.TypeIdentifier for the Spotfire.Dxp.Data.Calculation to add
Returns Spotfire.Dxp.Data.Calculation
The calculation object constructed and added to this collection.

Since
2.0
AddNew<TCalculation extends Spotfire.Dxp.Data.Calculation>(
typeTCalculation: TypeRefParam<TCalculation>,
): JsType<TCalculation>
Adds a new instance of the given calculation type to this collection.
Type Parameters
- TCalculation extends Spotfire.Dxp.Data.Calculation
Parameters
- typeTCalculation: TypeRefParam<TCalculation>
  Generic type argument
Returns JsType<TCalculation>
The calculation object constructed and added to this collection.

Since
2.0

Contains

Contains(calculationName: string | String): boolean
Determine if the collection contains the Spotfire.Dxp.Data.Calculation instance identified by calculationName
Parameters
- calculationName: string | String
  The name of the instance to look up
Returns boolean
True if an instance with that name exists false otherwise.

Since
2.0

Overrides DocumentNodeListBase.Contains
Contains(value: Spotfire.Dxp.Data.Calculation): boolean
Determines whether the specified value is in this collection.
Parameters
- value: Spotfire.Dxp.Data.Calculation
  The object to locate in this collection. The value can be null.
Returns boolean
true if value is found in this collection; otherwise, false.

Since
2.0

Overrides Framework.DocumentModel.DocumentNodeListBase.Contains

FindCalculations

FindCalculations(
calculationType: Type,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>
Finds all Calculations of type calculationType
Parameters
- calculationType: Type
  The type of the calculation to look for.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>
All calculations of type calculationType

Since
2.0
FindCalculations(
typeId: TypeIdentifier,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>
Finds all Calculations with Spotfire.Dxp.Framework.DocumentModel.TypeIdentifiertypeId.
Parameters
- typeId: TypeIdentifier
  The typeId to look for.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>
All Calculations with Spotfire.Dxp.Framework.DocumentModel.TypeIdentifiertypeId

Since
2.0
FindCalculations<TCalculation extends Spotfire.Dxp.Data.Calculation>(
typeTCalculation: TypeRefParam<TCalculation>,
): System.Collections.Generic.IEnumerable<TCalculation>
Finds all calculations of type TCalculation
Type Parameters
- TCalculation extends Spotfire.Dxp.Data.Calculation
Parameters
- typeTCalculation: TypeRefParam<TCalculation>
  Generic type argument
Returns System.Collections.Generic.IEnumerable<TCalculation>
All calculations of this type.

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNodeListBase.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Data.Calculation,
>
Returns an enumerator that iterates through this collection.

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.Calculation>
An System.Collections.Generic.IEnumerator for this collection.

Since
2.0

Inherited from DocumentNodeListBase.GetEnumerator

IndexOf

IndexOf(value: Spotfire.Dxp.Data.Calculation): number
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
Parameters
- value: Spotfire.Dxp.Data.Calculation
  The object to locate. The value can be null.
Returns number
The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

Since
2.0

Inherited from DocumentNodeListBase.IndexOf

Remove

Remove(calculation: Spotfire.Dxp.Data.Calculation): boolean
Completely removes the execution and all its results such as tables or columns.
Parameters
- calculation: Spotfire.Dxp.Data.Calculation
  The calculation.
Returns boolean
true if operation succeeded; false otherwise.

Since
2.0

ToArray

ToArray(): TypedArray<Spotfire.Dxp.Data.Calculation>
Copies the elements of the collection to a new array.

Returns TypedArray<Spotfire.Dxp.Data.Calculation>
An array containing the elements.

Since
2.0

Inherited from DocumentNodeListBase.ToArray

TryGetCalculation

TryGetCalculation(
calculationName: string | String,
calculation: OutParam<Spotfire.Dxp.Data.Calculation>,
): boolean
Tries to get a Spotfire.Dxp.Data.Calculation instance by name.
Parameters
- calculationName: string | String
  The name of the calculation.
- calculation: OutParam<Spotfire.Dxp.Data.Calculation>
  The Spotfire.Dxp.Data.Calculation to fill in.
Returns boolean
True if a calculation with calculationName was found, false otherwise.

Since
2.0

Class CalculationCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Data.Calculation>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddNew

Parameters

Returns Spotfire.Dxp.Data.Calculation

Since

Type Parameters

Parameters

Returns JsType<TCalculation>

Since

Contains

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

FindCalculations

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>

Since

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.Calculation>

Since

Type Parameters

Parameters

Returns System.Collections.Generic.IEnumerable<TCalculation>

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.Calculation>

Since

IndexOf

`Static`Equals

`Readonly`Item