interface ColumnHierarchyProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.ColumnHierarchyProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.ColumnHierarchyProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.ColumnHierarchyProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » ColumnHierarchyProperty

The option that determines the hierarchy of the fields for a visual element.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const columnHierarchyProperty: quicksight.CfnTemplate.ColumnHierarchyProperty = {
  dateTimeHierarchy: {
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      categoryFilter: {
        categoryValues: ['categoryValues'],
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
      },
      numericEqualityFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        value: 123,
      },
      timeRangeFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        rangeMaximum: 'rangeMaximum',
        rangeMinimum: 'rangeMinimum',
        timeGranularity: 'timeGranularity',
      },
    }],
  },
  explicitHierarchy: {
    columns: [{
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    }],
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      categoryFilter: {
        categoryValues: ['categoryValues'],
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
      },
      numericEqualityFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        value: 123,
      },
      timeRangeFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        rangeMaximum: 'rangeMaximum',
        rangeMinimum: 'rangeMinimum',
        timeGranularity: 'timeGranularity',
      },
    }],
  },
  predefinedHierarchy: {
    columns: [{
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    }],
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      categoryFilter: {
        categoryValues: ['categoryValues'],
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
      },
      numericEqualityFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        value: 123,
      },
      timeRangeFilter: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        rangeMaximum: 'rangeMaximum',
        rangeMinimum: 'rangeMinimum',
        timeGranularity: 'timeGranularity',
      },
    }],
  },
};

Properties

Name	Type	Description
dateTimeHierarchy?	IResolvable | DateTimeHierarchyProperty	The option that determines the hierarchy of any DateTime fields.
explicitHierarchy?	IResolvable | ExplicitHierarchyProperty	The option that determines the hierarchy of the fields that are built within a visual's field wells.
predefinedHierarchy?	IResolvable | PredefinedHierarchyProperty	The option that determines the hierarchy of the fields that are defined during data preparation.

---

dateTimeHierarchy?

Type: IResolvable | DateTimeHierarchyProperty (optional)

The option that determines the hierarchy of any DateTime fields.

---

explicitHierarchy?

Type: IResolvable | ExplicitHierarchyProperty (optional)

The option that determines the hierarchy of the fields that are built within a visual's field wells.

These fields can't be duplicated to other visuals.

---

predefinedHierarchy?

Type: IResolvable | PredefinedHierarchyProperty (optional)

The option that determines the hierarchy of the fields that are defined during data preparation.

These fields are available to use in any analysis that uses the data source.