PivotTransformation Class

Spotfire 14.3 API Reference
Pivots tall-skinny data into short-wide data.
Pivot is based on identity columns and category columns, where each distinct identity denotes a row, and each distinct category, together with an aggregation method and a value column, denotes a column, in a result matrix of data cells. Each cell is the aggregated result of all data values having the same identity and category. Additional transfer columns may exist, holding values aggregated by identity only, and not by category.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataTransformation
    Spotfire.Dxp.Data.TransformationsPivotTransformation

Namespace:  Spotfire.Dxp.Data.Transformations
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class PivotTransformation : DataTransformation

The PivotTransformation type exposes the following members.

Constructors

  NameDescription
Public methodPivotTransformation
Public constructor.
Top
Properties

  NameDescription
Public propertyCategoryColumns
Category columns values are used for grouping data into result columns. There will be an aggregated result data column for each distinct combined value of the Category columns.
Public propertyCategorySeparator
The category separator to be used when combining category values for value column names.
Public propertyIdentityColumns
Identity columns are passed through and identify each row of the result data.
Public propertyLoadReport
Gets the PartialDataLoadReport that can be used to report errors during connection.
(Inherited from DataTransformation.)
Public propertyName
Gets the display name of the transformation.
(Inherited from DataTransformation.)
Public propertyResultNamingExpression
Naming expression for the aggregated result data columns. This naming expression is a string containing a placeholder to be replaced with values during Pivot as follows:
%M is replaced with the aggregation method name (empty string for None).
%V is replaced with the value column name.
%C is replaced with a concatenated list of category values separated by Category separator.
Public propertySortRules
Rules for how result columns should be sorted. See SortRule.
Public propertyTransferColumns
TransferColumns are aggregated over the identity columns and stored into result transfer columns. See ColumnAggregation.
Public propertyTransferNamingExpression
Naming expression for the aggregated transfer result columns. This naming expression is a string containing a placeholder to be replaced with values during Pivot as follows:
%A is replaced with the aggregation method name (empty string for None).
%T is replaced with the transfer value column name.
Public propertyTypeId
Gets the type identifier for the data source.
(Inherited from DataTransformation.)
Public propertyValueColumns
Each value column data is aggregated over identity columns and category columns and stored into the result data columns. See ColumnAggregation.
Top
Methods

  NameDescription
Public methodConnect
Connects to the input reader. A DataRowReader can then be retrieved from the DataTransformationConnection.
(Inherited from DataTransformation.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodISerializableGetObjectData
Implements ISerializable.
(Inherited from DataTransformation.)
Top
Remarks

If nothing but identity columns are specified, the result of this Pivot transformation will be the distinct values of the identity columns.

If nothing but identity and transfer columns are specified, the result of this Pivot transformation will be an aggregation of the transfer columns over the identity columns.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference