Class CfnTemplate.PivotFieldSortOptionsProperty

The field sort options for a pivot table sort configuration.

Inheritance

object

CfnTemplate.PivotFieldSortOptionsProperty

Implements

CfnTemplate.IPivotFieldSortOptionsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTemplate.PivotFieldSortOptionsProperty : CfnTemplate.IPivotFieldSortOptionsProperty

Syntax (vb)

Public Class CfnTemplate.PivotFieldSortOptionsProperty Implements CfnTemplate.IPivotFieldSortOptionsProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var pivotFieldSortOptionsProperty = new PivotFieldSortOptionsProperty {
                 FieldId = "fieldId",
                 SortBy = new PivotTableSortByProperty {
                     Column = new ColumnSortProperty {
                         Direction = "direction",
                         SortBy = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },

                         // the properties below are optional
                         AggregationFunction = new AggregationFunctionProperty {
                             AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                 SimpleAttributeAggregation = "simpleAttributeAggregation",
                                 ValueForMultipleValues = "valueForMultipleValues"
                             },
                             CategoricalAggregationFunction = "categoricalAggregationFunction",
                             DateAggregationFunction = "dateAggregationFunction",
                             NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                 PercentileAggregation = new PercentileAggregationProperty {
                                     PercentileValue = 123
                                 },
                                 SimpleNumericalAggregation = "simpleNumericalAggregation"
                             }
                         }
                     },
                     DataPath = new DataPathSortProperty {
                         Direction = "direction",
                         SortPaths = new [] { new DataPathValueProperty {
                             DataPathType = new DataPathTypeProperty {
                                 PivotTableDataPathType = "pivotTableDataPathType"
                             },
                             FieldId = "fieldId",
                             FieldValue = "fieldValue"
                         } }
                     },
                     Field = new FieldSortProperty {
                         Direction = "direction",
                         FieldId = "fieldId"
                     }
                 }
             };

Synopsis

Constructors

PivotFieldSortOptionsProperty()

The field sort options for a pivot table sort configuration.

Properties

FieldId	The field ID for the field sort options.
SortBy	The sort by field for the field sort options.

Constructors

PivotFieldSortOptionsProperty()

The field sort options for a pivot table sort configuration.

public PivotFieldSortOptionsProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var pivotFieldSortOptionsProperty = new PivotFieldSortOptionsProperty {
                 FieldId = "fieldId",
                 SortBy = new PivotTableSortByProperty {
                     Column = new ColumnSortProperty {
                         Direction = "direction",
                         SortBy = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },

                         // the properties below are optional
                         AggregationFunction = new AggregationFunctionProperty {
                             AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                 SimpleAttributeAggregation = "simpleAttributeAggregation",
                                 ValueForMultipleValues = "valueForMultipleValues"
                             },
                             CategoricalAggregationFunction = "categoricalAggregationFunction",
                             DateAggregationFunction = "dateAggregationFunction",
                             NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                 PercentileAggregation = new PercentileAggregationProperty {
                                     PercentileValue = 123
                                 },
                                 SimpleNumericalAggregation = "simpleNumericalAggregation"
                             }
                         }
                     },
                     DataPath = new DataPathSortProperty {
                         Direction = "direction",
                         SortPaths = new [] { new DataPathValueProperty {
                             DataPathType = new DataPathTypeProperty {
                                 PivotTableDataPathType = "pivotTableDataPathType"
                             },
                             FieldId = "fieldId",
                             FieldValue = "fieldValue"
                         } }
                     },
                     Field = new FieldSortProperty {
                         Direction = "direction",
                         FieldId = "fieldId"
                     }
                 }
             };

Properties

FieldId

The field ID for the field sort options.

public string FieldId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html#cfn-quicksight-template-pivotfieldsortoptions-fieldid

SortBy

The sort by field for the field sort options.

public object SortBy { get; set; }