Class ReplaceColumnTransformation

Represents a Spotfire.Dxp.Data.DataTransformation that uses an Spotfire.Dxp.Data.Transformations.ExpressionTransformation to replace an existing column with a calculated column.

Since

2.0

Hierarchy (View Summary)

ExpressionTransformationWrapper
- ReplaceColumnTransformation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ColumnToReplace Expression Formatter Name ResultColumnName TypeId AsExpressionTransformation Connect

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from ExpressionTransformationWrapper.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new ReplaceColumnTransformation(
    columnToReplace: DataColumnSignature,
    resultColumnName: string | String,
    expression: string | String,
): ReplaceColumnTransformation
Initializes a new instance of the Spotfire.Dxp.Data.Transformations.ReplaceColumnTransformation class.
Parameters
- columnToReplace: DataColumnSignature
  The column to replace.
- resultColumnName: string | String
  The name of the resulting column. Can be null or empty, in which case the original column name is kept.
- expression: string | String
  The expression to use.
Returns ReplaceColumnTransformation
Since
2.0

Overrides ExpressionTransformationWrapper.constructor
new ReplaceColumnTransformation(
    columnToReplace: DataColumnSignature,
    resultColumnName: string | String,
    expression: string | String,
    formatter: IDataFormatter,
): ReplaceColumnTransformation
Initializes a new instance of the Spotfire.Dxp.Data.Transformations.ReplaceColumnTransformation class.
Parameters
- columnToReplace: DataColumnSignature
  The column to replace.
- resultColumnName: string | String
  The name of the resulting column. Can be null or empty, in which case the original column name is kept.
- expression: string | String
  The expression to use.
- formatter: IDataFormatter
  The formatter to use.
Returns ReplaceColumnTransformation
Since
2.0

Overrides ExpressionTransformationWrapper.constructor

ColumnToReplace

get ColumnToReplace(): DataColumnSignature
Gets or sets the column to replace.

Returns DataColumnSignature
Since
2.0
set ColumnToReplace(value: DataColumnSignature): void
Parameters
- value: DataColumnSignature
Returns void

Expression

get Expression(): string
Gets or sets the expression that defines the resulting column.

Returns string
Since
2.0
set Expression(value: string): void
Parameters
- value: string
Returns void

Formatter

get Formatter(): IDataFormatter
Gets or sets the formatter.

Returns IDataFormatter
Remark
Can be null, indicating that the default formatter for the Spotfire.Dxp.Data.DataType of the Spotfire.Dxp.Data.Transformations.ReplaceColumnTransformation.Expression result will be used.

Since
2.0
set Formatter(value: IDataFormatter): void
Parameters
- value: IDataFormatter
Returns void

Name

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

Returns string
Since
2.0

Inherited from ExpressionTransformationWrapper.Name

ResultColumnName

get ResultColumnName(): string
Gets or sets the name of the resulting column.

Returns string
Remark
Can be null or empty, in which case the original name is kept.

Since
2.0
set ResultColumnName(value: string): void
Parameters
- value: string
Returns void

TypeId

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

Returns TypeIdentifier
Since
2.0

Inherited from ExpressionTransformationWrapper.TypeId

AsExpressionTransformation

AsExpressionTransformation(): ExpressionTransformation
Gets a copy of the underlying Spotfire.Dxp.Data.Transformations.ExpressionTransformation.

Returns ExpressionTransformation
A copy of the expression transformation.

Since
2.0

Inherited from ExpressionTransformationWrapper.AsExpressionTransformation

Connect

Connect(
importContext: ImportContext,
input: DataRowReader,
): 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 ExpressionTransformationWrapper.Connect

Class ReplaceColumnTransformation

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 null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns ReplaceColumnTransformation

Since

Parameters

Returns ReplaceColumnTransformation

Since

ColumnToReplace

Returns DataColumnSignature

Since

Parameters

Returns void

Expression

Returns string

Since

Parameters

Returns void

Formatter

Returns IDataFormatter

Remark

Since

Parameters

Returns void

Name

Returns string

Since

ResultColumnName

Returns string

Remark

Since

Parameters

Returns void

TypeId

Returns TypeIdentifier

Since

AsExpressionTransformation

Returns ExpressionTransformation

Since

Connect

Parameters

Returns DataTransformationConnection

Since

Settings

On This Page

`Static`Equals