interface WaterfallVisualProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnTemplate.WaterfallVisualProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnTemplate.WaterfallVisualProperty |
 Python | aws_cdk.aws_quicksight.CfnTemplate.WaterfallVisualProperty |
 TypeScript | @aws-cdk/aws-quicksight » CfnTemplate » WaterfallVisualProperty |
A waterfall chart.
For more information, see Using waterfall charts 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';
declare const dataDriven: any;
const waterfallVisualProperty: quicksight.CfnTemplate.WaterfallVisualProperty = {
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: {
categoryAxisDisplayOptions: {
axisLineVisibility: 'axisLineVisibility',
axisOffset: 'axisOffset',
dataOptions: {
dateAxisOptions: {
missingDateVisibility: 'missingDateVisibility',
},
numericAxisOptions: {
range: {
dataDriven: dataDriven,
minMax: {
maximum: 123,
minimum: 123,
},
},
scale: {
linear: {
stepCount: 123,
stepSize: 123,
},
logarithmic: {
base: 123,
},
},
},
},
gridLineVisibility: 'gridLineVisibility',
scrollbarOptions: {
visibility: 'visibility',
visibleRange: {
percentRange: {
from: 123,
to: 123,
},
},
},
tickLabelOptions: {
labelOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
rotationAngle: 123,
},
},
categoryAxisLabelOptions: {
axisLabelOptions: [{
applyTo: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
},
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
}],
sortIconVisibility: 'sortIconVisibility',
visibility: 'visibility',
},
dataLabels: {
categoryLabelVisibility: 'categoryLabelVisibility',
dataLabelTypes: [{
dataPathLabelType: {
fieldId: 'fieldId',
fieldValue: 'fieldValue',
visibility: 'visibility',
},
fieldLabelType: {
fieldId: 'fieldId',
visibility: 'visibility',
},
maximumLabelType: {
visibility: 'visibility',
},
minimumLabelType: {
visibility: 'visibility',
},
rangeEndsLabelType: {
visibility: 'visibility',
},
}],
labelColor: 'labelColor',
labelContent: 'labelContent',
labelFontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
measureLabelVisibility: 'measureLabelVisibility',
overlap: 'overlap',
position: 'position',
visibility: 'visibility',
},
fieldWells: {
waterfallChartAggregatedFieldWells: {
breakdowns: [{
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',
},
}],
categories: [{
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',
},
},
},
},
}],
},
},
legend: {
height: 'height',
position: 'position',
title: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
visibility: 'visibility',
width: 'width',
},
primaryYAxisDisplayOptions: {
axisLineVisibility: 'axisLineVisibility',
axisOffset: 'axisOffset',
dataOptions: {
dateAxisOptions: {
missingDateVisibility: 'missingDateVisibility',
},
numericAxisOptions: {
range: {
dataDriven: dataDriven,
minMax: {
maximum: 123,
minimum: 123,
},
},
scale: {
linear: {
stepCount: 123,
stepSize: 123,
},
logarithmic: {
base: 123,
},
},
},
},
gridLineVisibility: 'gridLineVisibility',
scrollbarOptions: {
visibility: 'visibility',
visibleRange: {
percentRange: {
from: 123,
to: 123,
},
},
},
tickLabelOptions: {
labelOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
rotationAngle: 123,
},
},
primaryYAxisLabelOptions: {
axisLabelOptions: [{
applyTo: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
fieldId: 'fieldId',
},
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
}],
sortIconVisibility: 'sortIconVisibility',
visibility: 'visibility',
},
sortConfiguration: {
breakdownItemsLimit: {
itemsLimit: 123,
otherCategories: 'otherCategories',
},
categorySort: [{
columnSort: {
direction: 'direction',
sortBy: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
// the properties below are optional
aggregationFunction: {
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
},
fieldSort: {
direction: 'direction',
fieldId: 'fieldId',
},
}],
},
visualPalette: {
chartColor: 'chartColor',
colorMap: [{
color: 'color',
element: {
fieldId: 'fieldId',
fieldValue: 'fieldValue',
},
// the properties below are optional
timeGranularity: 'timeGranularity',
}],
},
waterfallChartOptions: {
totalBarLabel: 'totalBarLabel',
},
},
columnHierarchies: [{
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',
},
}],
},
}],
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 | Waterfall | The configuration for a waterfall visual. |
| column | IResolvable | IResolvable | Column[] | The column hierarchy that is used during drill-downs and drill-ups. |
| 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 | Waterfall
(optional)
The configuration for a waterfall visual.
columnHierarchies?
Type:
IResolvable | IResolvable | Column[]
(optional)
The column hierarchy that is used during drill-downs and drill-ups.
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.