interface BarChartConfigurationProperty
This page is available in another version. Click here for the v2 documentation.
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnTemplate.BarChartConfigurationProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnTemplate.BarChartConfigurationProperty |
 Python | aws_cdk.aws_quicksight.CfnTemplate.BarChartConfigurationProperty |
 TypeScript | @aws-cdk/aws-quicksight » CfnTemplate » BarChartConfigurationProperty |
The configuration of a BarChartVisual .
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 barChartConfigurationProperty: quicksight.CfnTemplate.BarChartConfigurationProperty = {
barsArrangement: 'barsArrangement',
categoryAxis: {
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,
},
},
categoryLabelOptions: {
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',
},
colorLabelOptions: {
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',
},
contributionAnalysisDefaults: [{
contributorDimensions: [{
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
}],
measureFieldId: 'measureFieldId',
}],
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: {
barChartAggregatedFieldWells: {
category: [{
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',
},
}],
colors: [{
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',
},
}],
smallMultiples: [{
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',
},
orientation: 'orientation',
referenceLines: [{
dataConfiguration: {
axisBinding: 'axisBinding',
dynamicConfiguration: {
calculation: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
measureAggregationFunction: {
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
},
staticConfiguration: {
value: 123,
},
},
// the properties below are optional
labelConfiguration: {
customLabelConfiguration: {
customLabel: 'customLabel',
},
fontColor: 'fontColor',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
horizontalPosition: 'horizontalPosition',
valueLabelConfiguration: {
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',
},
},
relativePosition: 'relativePosition',
},
verticalPosition: 'verticalPosition',
},
status: 'status',
styleConfiguration: {
color: 'color',
pattern: 'pattern',
},
}],
smallMultiplesOptions: {
maxVisibleColumns: 123,
maxVisibleRows: 123,
panelConfiguration: {
backgroundColor: 'backgroundColor',
backgroundVisibility: 'backgroundVisibility',
borderColor: 'borderColor',
borderStyle: 'borderStyle',
borderThickness: 'borderThickness',
borderVisibility: 'borderVisibility',
gutterSpacing: 'gutterSpacing',
gutterVisibility: 'gutterVisibility',
title: {
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
horizontalTextAlignment: 'horizontalTextAlignment',
visibility: 'visibility',
},
},
},
sortConfiguration: {
categoryItemsLimit: {
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',
},
}],
colorItemsLimit: {
itemsLimit: 123,
otherCategories: 'otherCategories',
},
colorSort: [{
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',
},
}],
smallMultiplesLimitConfiguration: {
itemsLimit: 123,
otherCategories: 'otherCategories',
},
smallMultiplesSort: [{
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',
},
}],
},
tooltip: {
fieldBasedTooltip: {
aggregationVisibility: 'aggregationVisibility',
tooltipFields: [{
columnTooltipItem: {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
// the properties below are optional
aggregation: {
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
label: 'label',
visibility: 'visibility',
},
fieldTooltipItem: {
fieldId: 'fieldId',
// the properties below are optional
label: 'label',
visibility: 'visibility',
},
}],
tooltipTitleType: 'tooltipTitleType',
},
selectedTooltipType: 'selectedTooltipType',
tooltipVisibility: 'tooltipVisibility',
},
valueAxis: {
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,
},
},
valueLabelOptions: {
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',
},
visualPalette: {
chartColor: 'chartColor',
colorMap: [{
color: 'color',
element: {
fieldId: 'fieldId',
fieldValue: 'fieldValue',
},
// the properties below are optional
timeGranularity: 'timeGranularity',
}],
},
};
Properties
| Name | Type | Description |
|---|---|---|
| bars | string | Determines the arrangement of the bars. |
| category | IResolvable | Axis | The label display options (grid line, range, scale, axis step) for bar chart category. |
| category | IResolvable | Chart | The label options (label text, label visibility and sort icon visibility) for a bar chart. |
| color | IResolvable | Chart | The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart. |
| contribution | IResolvable | IResolvable | Contribution[] | The contribution analysis (anomaly configuration) setup of the visual. |
| data | IResolvable | Data | The options that determine if visual data labels are displayed. |
| field | IResolvable | Bar | The field wells of the visual. |
| legend? | IResolvable | Legend | The legend display setup of the visual. |
| orientation? | string | The orientation of the bars in a bar chart visual. There are two valid values in this structure:. |
| reference | IResolvable | IResolvable | Reference[] | The reference line setup of the visual. |
| small | IResolvable | Small | The small multiples setup for the visual. |
| sort | IResolvable | Bar | The sort configuration of a BarChartVisual . |
| tooltip? | IResolvable | Tooltip | The tooltip display setup of the visual. |
| value | IResolvable | Axis | The label display options (grid line, range, scale, axis step) for a bar chart value. |
| value | IResolvable | Chart | The label options (label text, label visibility and sort icon visibility) for a bar chart value. |
| visual | IResolvable | Visual | The palette (chart color) display setup of the visual. |
barsArrangement?
Type:
string
(optional)
Determines the arrangement of the bars.
The orientation and arrangement of bars determine the type of bar that is used in the visual.
categoryAxis?
Type:
IResolvable | Axis
(optional)
The label display options (grid line, range, scale, axis step) for bar chart category.
categoryLabelOptions?
Type:
IResolvable | Chart
(optional)
The label options (label text, label visibility and sort icon visibility) for a bar chart.
colorLabelOptions?
Type:
IResolvable | Chart
(optional)
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
contributionAnalysisDefaults?
Type:
IResolvable | IResolvable | Contribution[]
(optional)
The contribution analysis (anomaly configuration) setup of the visual.
dataLabels?
Type:
IResolvable | Data
(optional)
The options that determine if visual data labels are displayed.
fieldWells?
Type:
IResolvable | Bar
(optional)
The field wells of the visual.
legend?
Type:
IResolvable | Legend
(optional)
The legend display setup of the visual.
orientation?
Type:
string
(optional)
The orientation of the bars in a bar chart visual. There are two valid values in this structure:.
HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
referenceLines?
Type:
IResolvable | IResolvable | Reference[]
(optional)
The reference line setup of the visual.
smallMultiplesOptions?
Type:
IResolvable | Small
(optional)
The small multiples setup for the visual.
sortConfiguration?
Type:
IResolvable | Bar
(optional)
The sort configuration of a BarChartVisual .
tooltip?
Type:
IResolvable | Tooltip
(optional)
The tooltip display setup of the visual.
valueAxis?
Type:
IResolvable | Axis
(optional)
The label display options (grid line, range, scale, axis step) for a bar chart value.
valueLabelOptions?
Type:
IResolvable | Chart
(optional)
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
visualPalette?
Type:
IResolvable | Visual
(optional)
The palette (chart color) display setup of the visual.