Class ReplaceSpecificValueTransformation

Represents a Spotfire.Dxp.Data.DataTransformation that replaces values on specific rows, or on a single specific row.

Since

2.0

Hierarchy (View Summary)

ReplaceValuesBaseTransformation
- ReplaceSpecificValueTransformation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Column Name NewValue OriginalValue RowIdentifyingColumnSignatures RowIdentifyingColumnValues TypeId WarnWhenReplacingMultipleValues 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 ReplaceValuesBaseTransformation.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 ReplaceValuesBaseTransformation.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from ReplaceValuesBaseTransformation.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new ReplaceSpecificValueTransformation(
    column: DataColumnSignature,
    originalValue: any,
    newValue: any,
    rowIdentifyingColumns: OrExplicit<
        System.Collections.Generic.IEnumerable<DataColumnSignature>,
    >,
    rowIdentifyingColumnValues:
        | any[]
        | OrExplicit<System.Collections.Generic.IEnumerable<any>>,
    warnWhenReplacingMultipleValues: boolean | Boolean,
): ReplaceSpecificValueTransformation
Initializes a new instance of the Spotfire.Dxp.Data.Transformations.ReplaceSpecificValueTransformation class.
Parameters
- column: DataColumnSignature
  The Spotfire.Dxp.Data.DataColumnSignature for the column to be changed.
- originalValue: any
  The value to be replaced in the column.
- newValue: any
  The new value.
- rowIdentifyingColumns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumnSignature>>
  A list of Spotfire.Dxp.Data.DataColumnSignature for columns used to define the rows which contain the values to be replaced.
- rowIdentifyingColumnValues: any[] | OrExplicit<System.Collections.Generic.IEnumerable<any>>
  The values identifying the rows for the row identifying columns.
- warnWhenReplacingMultipleValues: boolean | Boolean
  A value indicating whether a warning should be shown when the transformation replaces more than one value.
Returns ReplaceSpecificValueTransformation
Since
2.0

Overrides ReplaceValuesBaseTransformation.constructor

Column

get Column(): DataColumnSignature
Gets the column in which values are replaced.

Returns DataColumnSignature
Since
2.0

Inherited from ReplaceValuesBaseTransformation.Column

Name

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

Returns string
Since
2.0

Inherited from ReplaceValuesBaseTransformation.Name

NewValue

get NewValue(): unknown
Gets the new value.

Returns unknown
Since
2.0

Inherited from ReplaceValuesBaseTransformation.NewValue

OriginalValue

get OriginalValue(): unknown
Gets the original value.

Returns unknown
Since
2.0

Inherited from ReplaceValuesBaseTransformation.OriginalValue

RowIdentifyingColumnSignatures

get RowIdentifyingColumnSignatures(): System.Collections.Generic.IList<
DataColumnSignature,
>
Gets a copy of the list of row identifying column signatures.

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

RowIdentifyingColumnValues

get RowIdentifyingColumnValues(): System.Collections.Generic.IList<unknown>
Gets a copy of the list of row identifying column values.

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

TypeId

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

Returns TypeIdentifier
Since
2.0

Inherited from ReplaceValuesBaseTransformation.TypeId

WarnWhenReplacingMultipleValues

get WarnWhenReplacingMultipleValues(): boolean
Gets a value indicating whether a warning should be shown when the transformation replaces more than one value.

Returns boolean
Since
2.0

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 ReplaceValuesBaseTransformation.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 ReplaceValuesBaseTransformation.Connect

Class ReplaceSpecificValueTransformation

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 ReplaceSpecificValueTransformation

Since

Column

Returns DataColumnSignature

Since

Name

Returns string

Since

NewValue

Returns unknown

Since

OriginalValue

Returns unknown

Since

RowIdentifyingColumnSignatures

Returns System.Collections.Generic.IList<DataColumnSignature>

Since

RowIdentifyingColumnValues

Returns System.Collections.Generic.IList<unknown>

Since

TypeId

Returns TypeIdentifier

Since

WarnWhenReplacingMultipleValues

Returns boolean

Since

AsExpressionTransformation

Returns ExpressionTransformation

Since

Connect

Parameters

Returns DataTransformationConnection

Since

Settings

On This Page

`Static`Equals