Class ChangeNameTransformation

Represents a Spotfire.Dxp.Data.DataTransformation that uses an Spotfire.Dxp.Data.Transformations.ExpressionTransformation to change the name of one or more columns.

Since

2.0

Hierarchy (View Summary)

ExpressionTransformationWrapper
- ChangeNameTransformation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ColumnNameExpression ColumnsToRename Name 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 ChangeNameTransformation(
    columnsToRename: OrExplicit<
        System.Collections.Generic.IEnumerable<DataColumnSignature>,
    >,
    columnNameExpression: string | String,
): ChangeNameTransformation
Initializes a new instance of the Spotfire.Dxp.Data.Transformations.ChangeNameTransformation class.
Parameters
- columnsToRename: OrExplicit<System.Collections.Generic.IEnumerable<DataColumnSignature>>
  The columns that should be renamed.
- columnNameExpression: string | String
  The expression (using Spotfire.Dxp.Data.Transformations.ExpressionTransformation.ColumnNameSymbol) or name to use when naming columns.
Returns ChangeNameTransformation
Since
2.0

Overrides ExpressionTransformationWrapper.constructor

ColumnNameExpression

get ColumnNameExpression(): string
Gets or sets the expression that defines the new name of the columns.

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

ColumnsToRename

get ColumnsToRename(): System.Collections.Generic.IList<DataColumnSignature>
Gets the columns that are renamed using the Spotfire.Dxp.Data.Transformations.ChangeNameTransformation.ColumnNameExpression, as a modifiable list.

Returns System.Collections.Generic.IList<DataColumnSignature>
Since
2.0

Name

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

Returns string
Since
2.0

Inherited from ExpressionTransformationWrapper.Name

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 ChangeNameTransformation

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 ChangeNameTransformation

Since

ColumnNameExpression

Returns string

Since

Parameters

Returns void

ColumnsToRename

Returns System.Collections.Generic.IList<DataColumnSignature>

Since

Name

Returns string

Since

TypeId

Returns TypeIdentifier

Since

AsExpressionTransformation

Returns ExpressionTransformation

Since

Connect

Parameters

Returns DataTransformationConnection

Since

Settings

On This Page

`Static`Equals