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

Class DataFunctionInvocation

Represents an invocation of a data function.

Since

2.5

Hierarchy (View Summary)

Spotfire.Object
- DataFunctionInvocation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataFunctionDefinition ImportContext GetInput GetOutput HasInput SetOutput TryGetInput TryGetOutput

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

DataFunctionDefinition

get DataFunctionDefinition(): DataFunctionDefinition
Gets the function definition.

Returns DataFunctionDefinition
Since
2.5

ImportContext

get ImportContext(): ImportContext
Gets the import context.

Returns ImportContext
Since
2.5

GetInput

GetInput(name: string | String): DataRowReader
Get an input value.
Parameters
- name: string | String
  The name of the input parameter.
Returns DataRowReader
The row reader containing the values.

Since
2.5

GetOutput

GetOutput(name: string | String): DataRowReader
Get the output value.
Parameters
- name: string | String
  The name of the output parameter.
Returns DataRowReader
The resulting reader containing the output value.

Since
2.5

HasInput

HasInput(name: string | String): boolean
Gets a value indicating whether the input parameter exists or not.
Parameters
- name: string | String
  The name of the input parameter.
Returns boolean
True if the input parameter exists; false otherwise.

Since
2.5

SetOutput

SetOutput(name: string | String, value: DataRowReader): void
Set the output result.
Parameters
- name: string | String
  The name of the result.
- value: DataRowReader
  The value.
Returns void
Since
2.5

TryGetInput

TryGetInput(name: string | String, value: OutParam<DataRowReader>): boolean
Try to get an input value.
Parameters
- name: string | String
  The name of the input parameter.
- value: OutParam<DataRowReader>
  The row reader containing the values.
Returns boolean
True if it was possible to retrieve the input parameter value.

Since
2.5

TryGetOutput

TryGetOutput(name: string | String, value: OutParam<DataRowReader>): boolean
Try to get an output value.
Parameters
- name: string | String
  The name of the output parameter.
- value: OutParam<DataRowReader>
  The row reader containing the values.
Returns boolean
True if it was possible to retrieve the output value.

Since
2.5