Class DataFunctionCollection

Represents a list of Spotfire.Dxp.Data.DataFunctions.DataFunction instances.

Remark

There is only one instance of this collection and it can be retrieved from the Spotfire.Dxp.Data.DataManager.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataFunctionCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached Transactions AddNew Contains CreateUniqueName ForEachNodeInSubTree GetEnumerator IsValidName Remove RemoveAll

Methods

[iterator]

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

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<number | Int32, DataFunction>

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

AddNew

AddNew(
suggestedName: string | String,
builtInDataFunction: BuiltInDataFunction,
): DataFunction
Adds a new Spotfire.Dxp.Data.DataFunctions.DataFunction from a Spotfire.Dxp.Data.DataFunctions.BuiltInDataFunction.
Parameters
- suggestedName: string | String
  The suggested name.
- builtInDataFunction: BuiltInDataFunction
  The built-in data function.
Returns DataFunction
The newly added Spotfire.Dxp.Data.DataFunctions.DataFunction.

Since
2.1
AddNew(
suggestedName: string | String,
dataFunctionDefinition: DataFunctionDefinition,
): DataFunction
Adds a new Spotfire.Dxp.Data.DataFunctions.DataFunction from a Spotfire.Dxp.Data.DataFunctions.DataFunctionDefinition.
Parameters
- suggestedName: string | String
  The suggested name of the function.
- dataFunctionDefinition: DataFunctionDefinition
  The function definition.
Returns DataFunction
The newly added Spotfire.Dxp.Data.DataFunctions.DataFunction.

Since
2.1

Contains

Contains(value: DataFunction): boolean
Determines whether the specified value is in this collection.
Parameters
- value: DataFunction
  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

CreateUniqueName

CreateUniqueName(functionName: string | String): string
Create a new unique function name from a suggestion. The suggested name is used if possible.
Parameters
- functionName: string | String
  The suggested function name.
Returns string
A function functionName which is unique in the collection.

Since
2.1

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

GetEnumerator

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

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

Since
2.0

IsValidName

IsValidName(suggestedName: string | String): boolean
Check if the suggested name is a valid name.
Parameters
- suggestedName: string | String
  The suggested name.
Returns boolean
True if the name is valid and not already used; false otherwise.

Since
2.1

Remove

Remove(_function: DataFunction): boolean
Remove a function.
Parameters
- _function: DataFunction
  The function to remove.
Returns boolean
True if the function was part of the collection and could be removed, false otherwise.

Since
2.1

RemoveAll

RemoveAll(predicate: Predicate<DataFunction>): void
Remove all functions matching the predicate.
Parameters
- predicate: Predicate<DataFunction>
  The predicate.
Returns void
Since
2.1

Class DataFunctionCollection

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<DataFunction>

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 DataFunction

Since

Parameters

Returns DataFunction

Since

Contains

Parameters

Returns boolean

Since

CreateUniqueName

Parameters

Returns string

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<DataFunction>

Since

IsValidName

Parameters

Returns boolean

Since

Remove

Parameters

Returns boolean

Since

RemoveAll

Parameters

Returns void

`Static`Equals

`Readonly`Item