Class UnpivotTransformation

Transforms short-wide data into tall-skinny data. Unpivot merges data from multiple value columns into one result column. Data in identity columns is repeated for each value column and the name of the value column is placed into a category column.

Since

2.0

Hierarchy (View Summary)

DataTransformation
- UnpivotTransformation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor CategoryName CategoryType IdentityColumns Name RemoveNull ResultName ResultType TypeId ValueColumns 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 DataTransformation.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 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: 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 DataTransformation.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 DataTransformation.Equals

Default capability

constructor

new UnpivotTransformation(): UnpivotTransformation
Public constructor.

Returns UnpivotTransformation
Since
2.0

Overrides DataTransformation.constructor

CategoryName

get CategoryName(): string
Name of the category column for merged column names.

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

CategoryType

get CategoryType(): DataType
Spotfire.Dxp.Data.DataType of the category column.

Returns DataType
Since
2.0
set CategoryType(value: DataType): void
Parameters
- value: DataType
Returns void

IdentityColumns

get IdentityColumns(): System.Collections.Generic.IList<DataColumnSignature>
Identity columns are passed through and repeated for each unpivoted value.

Returns System.Collections.Generic.IList<DataColumnSignature>
Since
2.0
set IdentityColumns(
value: OrExplicit<System.Collections.Generic.IList<DataColumnSignature>>,
): void
Parameters
- value: OrExplicit<System.Collections.Generic.IList<DataColumnSignature>>
Returns void

Name

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

Returns string
Since
2.0

Inherited from DataTransformation.Name

RemoveNull

get RemoveNull(): boolean
Gets or sets whether null values shall be removed or not.

Returns boolean
Since
2.0
set RemoveNull(value: boolean): void
Parameters
- value: boolean
Returns void

ResultName

get ResultName(): string
Name of the result column holding the merged value column data.

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

ResultType

get ResultType(): DataType
Spotfire.Dxp.Data.DataType of the result column.

Returns DataType
Since
2.0
set ResultType(value: DataType): void
Parameters
- value: DataType
Returns void

TypeId

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

Returns TypeIdentifier
Since
2.0

Inherited from DataTransformation.TypeId

ValueColumns

get ValueColumns(): System.Collections.Generic.IList<DataColumnSignature>
Value column data is merged into one result column of data.
Column names are merged into a category column.

Returns System.Collections.Generic.IList<DataColumnSignature>
Since
2.0
set ValueColumns(
value: OrExplicit<System.Collections.Generic.IList<DataColumnSignature>>,
): void
Parameters
- value: OrExplicit<System.Collections.Generic.IList<DataColumnSignature>>
Returns void

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

Class UnpivotTransformation

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

Returns UnpivotTransformation

Since

CategoryName

Returns string

Since

Parameters

Returns void

CategoryType

Returns DataType

Since

Parameters

Returns void

IdentityColumns

Returns System.Collections.Generic.IList<DataColumnSignature>

Since

Parameters

Returns void

Name

Returns string

Since

RemoveNull

Returns boolean

Since

Parameters

Returns void

ResultName

Returns string

Since

Parameters

Returns void

ResultType

Returns DataType

Since

Parameters

Returns void

TypeId

Returns TypeIdentifier

Since

ValueColumns

Returns System.Collections.Generic.IList<DataColumnSignature>

Since

Parameters

Returns void

Connect

Parameters

Returns DataTransformationConnection

Since

Settings

On This Page

`Static`Equals