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

Class ColumnReplacement

Represents a replacement of one or several columns with a column formed from an expression in the expression transformation.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ColumnReplacement

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ColumnNameExpression ColumnSelection Expression Formatter

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

Default capability

ColumnNameExpression

get ColumnNameExpression(): string
The expression that defines the name of the column.

Returns string
Since
2.0

ColumnSelection

get ColumnSelection(): ColumnSelection
The columns that will be replaced by the calculated column.

Returns ColumnSelection
Since
2.0

Expression

get Expression(): string
The expression that defines the column.

Returns string
Since
2.0

Formatter

get Formatter(): IDataFormatter
The formatter that will be used for the column. If it is null, the default formatter for the data type of the result will be used.

Returns IDataFormatter
Since
2.0