About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataColumnCalculationDependencyCollection

A calculation dependency on a group of columns.

Since

2.0

Hierarchy (View Summary)

CalculationDependencyCollection<DataColumnCalculationDependency>
- DataColumnCalculationDependencyCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Columns Context DataTable IsAttached Transactions ForEachNodeInSubTree GetEnumerator

Methods

[iterator]

"[iterator]"(): Iterator<DataColumnCalculationDependency>
Returns Iterator<DataColumnCalculationDependency>
Overrides CalculationDependencyCollection.[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 CalculationDependencyCollection.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 CalculationDependencyCollection.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from CalculationDependencyCollection.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from CalculationDependencyCollection.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 CalculationDependencyCollection.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 CalculationDependencyCollection.Equals

Default capability

Columns

get Columns(): ReadOnlyCollection<DataColumn>
The Spotfire.Dxp.Data.DataColumn objects that this dependency represents.

Returns ReadOnlyCollection<DataColumn>
Remark
Note that these are the existing dependencies. A dependency might be added and be reported here but is subsequently deleted by the user in which case it will not show up here.

Since
2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from CalculationDependencyCollection.Context

DataTable

get DataTable(): DataTable
The datatable in which the columns represented by this dependency resides. Will return a value even if all the columns in the table are deleted and is thus preferable to asking the columns for their ancestor table. Returns null if the datatable no longer exists.

Returns DataTable
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from CalculationDependencyCollection.IsAttached

Transactions

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

Returns ITransactions
Since
2.0

Inherited from CalculationDependencyCollection.Transactions

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 CalculationDependencyCollection.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
DataColumnCalculationDependency,
>
Gets an enumerator over the dependencies in this collection.

Returns System.Collections.Generic.IEnumerator<DataColumnCalculationDependency>
An enumerator.

Since
2.0

Inherited from CalculationDependencyCollection.GetEnumerator