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

Class DataFunctionExpressionFunctionCollection

This class represents a collection of data function expression functions. These functions calls data functions through the Spotfire expression language.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataFunctionExpressionFunctionCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached Transactions Contains GetEnumerator TryGetValue

Methods

[iterator]

"[iterator]"(): Iterator<DataFunctionExpressionFunction>
Returns Iterator<DataFunctionExpressionFunction>

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

`Readonly`Item

Item: PropertyGet<string | String, DataFunctionExpressionFunction>

Gets the Spotfire.Dxp.Data.DataFunctions.DataFunctionExpressionFunction with the specified name.

Param: name

The name.

Returns

The function with the specified name.

Since

2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

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

Returns number
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.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.DocumentNode.Transactions

Contains

Contains(name: string | String): boolean
Determines whether the collection contains an expression function with the defined name.
Parameters
- name: string | String
  The name.
Returns boolean
True if the expression function exists; false otherwise.

Since
2.0

GetEnumerator

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

Returns System.Collections.Generic.IEnumerator<DataFunctionExpressionFunction>
An System.Collections.Generic.IEnumerator for this collection.

Since
2.0

TryGetValue

TryGetValue(
name: string | String,
value: OutParam<DataFunctionExpressionFunction>,
): boolean
Tries to get an expression function with the given name.
Parameters
- name: string | String
  The name.
- value: OutParam<DataFunctionExpressionFunction>
  The value.
Returns boolean
True if the expression function was found; false otherwise.

Since
2.0