interface PivotTableVisualProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnTemplate.PivotTableVisualProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnTemplate.PivotTableVisualProperty |
 Python | aws_cdk.aws_quicksight.CfnTemplate.PivotTableVisualProperty |
 TypeScript | @aws-cdk/aws-quicksight » CfnTemplate » PivotTableVisualProperty |
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide .
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 pivotTableVisualProperty: quicksight.CfnTemplate.PivotTableVisualProperty = {
visualId: 'visualId',
// the properties below are optional
actions: [{
actionOperations: [{
filterOperation: {
selectedFieldsConfiguration: {
selectedFieldOptions: 'selectedFieldOptions',
selectedFields: ['selectedFields'],
},
targetVisualsConfiguration: {
sameSheetTargetVisualConfiguration: {
targetVisualOptions: 'targetVisualOptions',
targetVisuals: ['targetVisuals'],
},
},
},
navigationOperation: {
localNavigationConfiguration: {
targetSheetId: 'targetSheetId',
},
},
setParametersOperation: {
parameterValueConfigurations: [{
destinationParameterName: 'destinationParameterName',
value: {
customValuesConfiguration: {
customValues: {
dateTimeValues: ['dateTimeValues'],
decimalValues: [123],
integerValues: [123],
stringValues: ['stringValues'],
},
// the properties below are optional
includeNullValue: false,
},
selectAllValueOptions: 'selectAllValueOptions',
sourceField: 'sourceField',
sourceParameterName: 'sourceParameterName',
},
}],
},
urlOperation: {
urlTarget: 'urlTarget',
urlTemplate: 'urlTemplate',
},
}],
customActionId: 'customActionId',
name: 'name',
trigger: 'trigger',
// the properties below are optional
status: 'status',
}],
chartConfiguration: {
fieldOptions: {
dataPathOptions: [{
dataPathList: [{
fieldId: 'fieldId',
fieldValue: 'fieldValue',
}],
// the properties below are optional
width: 'width',
}],
selectedFieldOptions: [{
fieldId: 'fieldId',
// the properties below are optional
customLabel: 'customLabel',
visibility: 'visibility',
}],
},
fieldWells: {
pivotTableAggregatedFieldWells: {
columns: [{
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',
},
}],
rows: [{
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',
},
}],
values: [{
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',
},
},
},
},
}],
},
},
paginatedReportOptions: {
overflowColumnHeaderVisibility: 'overflowColumnHeaderVisibility',
verticalOverflowVisibility: 'verticalOverflowVisibility',
},
sortConfiguration: {
fieldSortOptions: [{
fieldId: 'fieldId',
sortBy: {
column: {
direction: 'direction',
sortBy: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
// the properties below are optional
aggregationFunction: {
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
},
dataPath: {
direction: 'direction',
sortPaths: [{
fieldId: 'fieldId',
fieldValue: 'fieldValue',
}],
},
field: {
direction: 'direction',
fieldId: 'fieldId',
},
},
}],
},
tableOptions: {
cellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
columnHeaderStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
columnNamesVisibility: 'columnNamesVisibility',
metricPlacement: 'metricPlacement',
rowAlternateColorOptions: {
rowAlternateColors: ['rowAlternateColors'],
status: 'status',
},
rowFieldNamesStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
rowHeaderStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
singleMetricVisibility: 'singleMetricVisibility',
toggleButtonsVisibility: 'toggleButtonsVisibility',
},
totalOptions: {
columnSubtotalOptions: {
customLabel: 'customLabel',
fieldLevel: 'fieldLevel',
fieldLevelOptions: [{
fieldId: 'fieldId',
}],
metricHeaderCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalsVisibility: 'totalsVisibility',
valueCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
},
columnTotalOptions: {
customLabel: 'customLabel',
metricHeaderCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
placement: 'placement',
scrollStatus: 'scrollStatus',
totalCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalsVisibility: 'totalsVisibility',
valueCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
},
rowSubtotalOptions: {
customLabel: 'customLabel',
fieldLevel: 'fieldLevel',
fieldLevelOptions: [{
fieldId: 'fieldId',
}],
metricHeaderCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalsVisibility: 'totalsVisibility',
valueCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
},
rowTotalOptions: {
customLabel: 'customLabel',
metricHeaderCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
placement: 'placement',
scrollStatus: 'scrollStatus',
totalCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
totalsVisibility: 'totalsVisibility',
valueCellStyle: {
backgroundColor: 'backgroundColor',
border: {
sideSpecificBorder: {
bottom: {
color: 'color',
style: 'style',
thickness: 123,
},
innerHorizontal: {
color: 'color',
style: 'style',
thickness: 123,
},
innerVertical: {
color: 'color',
style: 'style',
thickness: 123,
},
left: {
color: 'color',
style: 'style',
thickness: 123,
},
right: {
color: 'color',
style: 'style',
thickness: 123,
},
top: {
color: 'color',
style: 'style',
thickness: 123,
},
},
uniformBorder: {
color: 'color',
style: 'style',
thickness: 123,
},
},
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
height: 123,
horizontalTextAlignment: 'horizontalTextAlignment',
textWrap: 'textWrap',
verticalTextAlignment: 'verticalTextAlignment',
visibility: 'visibility',
},
},
},
},
conditionalFormatting: {
conditionalFormattingOptions: [{
cell: {
fieldId: 'fieldId',
// the properties below are optional
scope: {
role: 'role',
},
textFormat: {
backgroundColor: {
gradient: {
color: {
stops: [{
gradientOffset: 123,
// the properties below are optional
color: 'color',
dataValue: 123,
}],
},
expression: 'expression',
},
solid: {
expression: 'expression',
// the properties below are optional
color: 'color',
},
},
icon: {
customCondition: {
expression: 'expression',
iconOptions: {
icon: 'icon',
unicodeIcon: 'unicodeIcon',
},
// the properties below are optional
color: 'color',
displayConfiguration: {
iconDisplayOption: 'iconDisplayOption',
},
},
iconSet: {
expression: 'expression',
// the properties below are optional
iconSetType: 'iconSetType',
},
},
textColor: {
gradient: {
color: {
stops: [{
gradientOffset: 123,
// the properties below are optional
color: 'color',
dataValue: 123,
}],
},
expression: 'expression',
},
solid: {
expression: 'expression',
// the properties below are optional
color: 'color',
},
},
},
},
}],
},
subtitle: {
formatText: {
plainText: 'plainText',
richText: 'richText',
},
visibility: 'visibility',
},
title: {
formatText: {
plainText: 'plainText',
richText: 'richText',
},
visibility: 'visibility',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| visual | string | The unique identifier of a visual. |
| actions? | IResolvable | IResolvable | Visual[] | The list of custom actions that are configured for a visual. |
| chart | IResolvable | Pivot | The configuration settings of the visual. |
| conditional | IResolvable | Pivot | The conditional formatting for a PivotTableVisual . |
| subtitle? | IResolvable | Visual | The subtitle that is displayed on the visual. |
| title? | IResolvable | Visual | The title that is displayed on the visual. |
visualId
Type:
string
The unique identifier of a visual.
This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
actions?
Type:
IResolvable | IResolvable | Visual[]
(optional)
The list of custom actions that are configured for a visual.
chartConfiguration?
Type:
IResolvable | Pivot
(optional)
The configuration settings of the visual.
conditionalFormatting?
Type:
IResolvable | Pivot
(optional)
The conditional formatting for a PivotTableVisual .
subtitle?
Type:
IResolvable | Visual
(optional)
The subtitle that is displayed on the visual.
title?
Type:
IResolvable | Visual
(optional)
The title that is displayed on the visual.