Class DataFunctionInvocationBuilder

A builder that is used to create a Spotfire.Dxp.Data.DataFunctions.DataFunctionInvocation which is used as a transient object when executing the function defined by a Spotfire.Dxp.Data.DataFunctions.DataFunctionDefinition using the Spotfire.Dxp.Data.DataFunctions.DataFunctionExecutorService.

Since

2.5

Hierarchy (View Summary)

Spotfire.Object
- DataFunctionInvocationBuilder

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor AddInput Build

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new DataFunctionInvocationBuilder(
builtInDataFunction: BuiltInDataFunction,
importContext: ImportContext,
): DataFunctionInvocationBuilder
Initializes a new instance of the Spotfire.Dxp.Data.DataFunctions.DataFunctionInvocationBuilder class.
Parameters
- builtInDataFunction: BuiltInDataFunction
  The built-in data function.
- importContext: ImportContext
  The import context.
Returns DataFunctionInvocationBuilder
Since
2.5

Overrides Object.constructor
new DataFunctionInvocationBuilder(
functionDefinition: DataFunctionDefinition,
importContext: ImportContext,
): DataFunctionInvocationBuilder
Initializes a new instance of the Spotfire.Dxp.Data.DataFunctions.DataFunctionInvocationBuilder class.
Parameters
- functionDefinition: DataFunctionDefinition
  The function definition.
- importContext: ImportContext
  The import context.
Returns DataFunctionInvocationBuilder
Since
2.5

Overrides Object.constructor

AddInput

AddInput(name: string | String, value: DataRowReader): void
Add an input to the function invocation.
Parameters
- name: string | String
  The name of the input.
- value: DataRowReader
  The value of the input.
Returns void
Since
2.5
AddInput<T>(
    typeT: TypeRefParam<T>,
    name: string | String,
    value: DataValueGeneric<T>,
): void
Add a scalar input to the function invocation.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- name: string | String
  The name of the input.
- value: DataValueGeneric<T>
  The value of the input.
Returns void
Since
2.5

Build

Build(): DataFunctionInvocation
Builds a function invocation.

Returns DataFunctionInvocation
The function invocation.

Since
2.5

Class DataFunctionInvocationBuilder

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns DataFunctionInvocationBuilder

Since

Parameters

Returns DataFunctionInvocationBuilder

Since

AddInput

Parameters

Returns void

Since

Type Parameters

Parameters

Returns void

Since

Build

Returns DataFunctionInvocation

Since

Settings

On This Page

`Static`Equals