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

Class DataFunctionTransformation

Represents a data transformation that uses an external function as a filter. The external function must take a single table as input and produce a single table as output. Metadata is not handled.

Since

2.0

Hierarchy (view full)

DataTransformation
- DataFunctionTransformation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

FunctionDefinition Name TypeId Connect

Methods

Cast

Cast<T1, T2>(this, type): 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 DataTransformation.Cast

Equals

Equals(obj): 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 DataTransformation.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DataTransformation.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DataTransformation.ToString

TryCast

TryCast<T1, T2>(this, type): 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 DataTransformation.TryCast

`Static`Equals

Equals(objA, objB): 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 DataTransformation.Equals

Default capability

FunctionDefinition

get FunctionDefinition(): DataFunctionDefinition
Gets the function definition used for the tranformation.

Returns DataFunctionDefinition
Since
2.0

Name

get Name(): string
Gets the display name of the transformation.

Returns string
Since
2.0

Inherited from DataTransformation.Name

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for the data source.

Returns TypeIdentifier
Since
2.0

Inherited from DataTransformation.TypeId

Connect

Connect(importContext, input): DataTransformationConnection
Connects to the input reader. A Spotfire.Dxp.Data.DataRowReader can then be retrieved from the Spotfire.Dxp.Data.DataTransformationConnection.
Parameters
- importContext: ImportContext
  The import context.
- input: DataRowReader
  The input reader.
Returns DataTransformationConnection
The connected transformation.

Since
2.0

Inherited from DataTransformation.Connect