interface PeriodToDateComputationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDashboard.PeriodToDateComputationProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnDashboard.PeriodToDateComputationProperty |
 Python | aws_cdk.aws_quicksight.CfnDashboard.PeriodToDateComputationProperty |
 TypeScript | @aws-cdk/aws-quicksight » CfnDashboard » PeriodToDateComputationProperty |
The period to date computation configuration.
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 periodToDateComputationProperty: quicksight.CfnDashboard.PeriodToDateComputationProperty = {
computationId: 'computationId',
time: {
categoricalDimensionField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
formatConfiguration: {
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numericFormatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
hierarchyId: 'hierarchyId',
},
dateDimensionField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
dateGranularity: 'dateGranularity',
formatConfiguration: {
dateTimeFormat: 'dateTimeFormat',
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numericFormatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
hierarchyId: 'hierarchyId',
},
numericalDimensionField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
formatConfiguration: {
formatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
hierarchyId: 'hierarchyId',
},
},
// the properties below are optional
name: 'name',
periodTimeGranularity: 'periodTimeGranularity',
value: {
calculatedMeasureField: {
expression: 'expression',
fieldId: 'fieldId',
},
categoricalMeasureField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
aggregationFunction: 'aggregationFunction',
formatConfiguration: {
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numericFormatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
},
dateMeasureField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
aggregationFunction: 'aggregationFunction',
formatConfiguration: {
dateTimeFormat: 'dateTimeFormat',
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numericFormatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
},
numericalMeasureField: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
// the properties below are optional
aggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
formatConfiguration: {
formatConfiguration: {
currencyDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
symbol: 'symbol',
},
numberDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
numberScale: 'numberScale',
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
percentageDisplayFormatConfiguration: {
decimalPlacesConfiguration: {
decimalPlaces: 123,
},
negativeValueConfiguration: {
displayMode: 'displayMode',
},
nullValueFormatConfiguration: {
nullString: 'nullString',
},
prefix: 'prefix',
separatorConfiguration: {
decimalSeparator: 'decimalSeparator',
thousandsSeparator: {
symbol: 'symbol',
visibility: 'visibility',
},
},
suffix: 'suffix',
},
},
},
},
},
};
Properties
| Name | Type | Description |
|---|---|---|
| computation | string | The ID for a computation. |
| time | IResolvable | Dimension | The time field that is used in a computation. |
| name? | string | The name of a computation. |
| period | string | The time granularity setup of period to date computation. Choose from the following options:. |
| value? | IResolvable | Measure | The value field that is used in a computation. |
computationId
Type:
string
The ID for a computation.
time
Type:
IResolvable | Dimension
The time field that is used in a computation.
name?
Type:
string
(optional)
The name of a computation.
periodTimeGranularity?
Type:
string
(optional)
The time granularity setup of period to date computation. Choose from the following options:.
- YEAR: Year to date.
- MONTH: Month to date.
value?
Type:
IResolvable | Measure
(optional)
The value field that is used in a computation.