interface ScatterPlotConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDashboard.ScatterPlotConfigurationProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnDashboard.ScatterPlotConfigurationProperty |
 Python | aws_cdk.aws_quicksight.CfnDashboard.ScatterPlotConfigurationProperty |
 TypeScript | @aws-cdk/aws-quicksight » CfnDashboard » ScatterPlotConfigurationProperty |
The configuration of a scatter plot.
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 scatterPlotConfigurationProperty: quicksight.CfnDashboard.ScatterPlotConfigurationProperty = {
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: {
scatterPlotCategoricallyAggregatedFieldWells: {
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',
},
}],
size: [{
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',
},
},
},
},
}],
xAxis: [{
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',
},
},
},
},
}],
yAxis: [{
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',
},
},
},
},
}],
},
scatterPlotUnaggregatedFieldWells: {
size: [{
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',
},
},
},
},
}],
xAxis: [{
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',
},
}],
yAxis: [{
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',
},
}],
},
},
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',
},
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',
},
visualPalette: {
chartColor: 'chartColor',
colorMap: [{
color: 'color',
element: {
fieldId: 'fieldId',
fieldValue: 'fieldValue',
},
// the properties below are optional
timeGranularity: 'timeGranularity',
}],
},
xAxisDisplayOptions: {
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,
},
},
xAxisLabelOptions: {
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',
},
yAxisDisplayOptions: {
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,
},
},
yAxisLabelOptions: {
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',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| data | IResolvable | Data | The options that determine if visual data labels are displayed. |
| field | IResolvable | Scatter | The field wells of the visual. |
| legend? | IResolvable | Legend | The legend display setup of the visual. |
| tooltip? | IResolvable | Tooltip | The legend display setup of the visual. |
| visual | IResolvable | Visual | The palette (chart color) display setup of the visual. |
| x | IResolvable | Axis | The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis. |
| x | IResolvable | Chart | The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis. |
| y | IResolvable | Axis | The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis. |
| y | IResolvable | Chart | The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis. |
dataLabels?
Type:
IResolvable | Data
(optional)
The options that determine if visual data labels are displayed.
fieldWells?
Type:
IResolvable | Scatter
(optional)
The field wells of the visual.
legend?
Type:
IResolvable | Legend
(optional)
The legend display setup of the visual.
tooltip?
Type:
IResolvable | Tooltip
(optional)
The legend display setup of the visual.
visualPalette?
Type:
IResolvable | Visual
(optional)
The palette (chart color) display setup of the visual.
xAxisDisplayOptions?
Type:
IResolvable | Axis
(optional)
The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
xAxisLabelOptions?
Type:
IResolvable | Chart
(optional)
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
yAxisDisplayOptions?
Type:
IResolvable | Axis
(optional)
The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
yAxisLabelOptions?
Type:
IResolvable | Chart
(optional)
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.