interface ColumnHierarchyProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnAnalysis.ColumnHierarchyProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_ColumnHierarchyProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnAnalysis.ColumnHierarchyProperty |
![]() | aws_cdk.aws_quicksight.CfnAnalysis.ColumnHierarchyProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnAnalysis » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const columnHierarchyProperty: quicksight.CfnAnalysis.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 |
---|---|---|
date | IResolvable | Date | The option that determines the hierarchy of any DateTime fields. |
explicit | IResolvable | Explicit | The option that determines the hierarchy of the fields that are built within a visual's field wells. |
predefined | IResolvable | Predefined | The option that determines the hierarchy of the fields that are defined during data preparation. |
dateTimeHierarchy?
Type:
IResolvable
|
Date
(optional)
The option that determines the hierarchy of any DateTime
fields.
explicitHierarchy?
Type:
IResolvable
|
Explicit
(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
|
Predefined
(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.