AWS CDK Reference

Appearance

v2.274.0

GaugeChartOptionsProperty Struct ​

The options that determine the presentation of the GaugeChartVisual .

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const gaugeChartOptionsProperty: quicksight.CfnDashboard.GaugeChartOptionsProperty = {
  arc: {
    arcAngle: 123,
    arcThickness: 'arcThickness',
  },
  arcAxis: {
    range: {
      max: 123,
      min: 123,
    },
    reserveRange: 123,
  },
  comparison: {
    comparisonFormat: {
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
    comparisonMethod: 'comparisonMethod',
  },
  primaryValueDisplayType: 'primaryValueDisplayType',
  primaryValueFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
};

Properties ​

arcoptionalIResolvable | CfnDashboard.ArcConfigurationPropertyarcoptionaltyping.Union[IResolvable, ArcConfigurationProperty]arcoptionalIResolvableArcoptionalIResolvableArcoptionalinterface{}#
The arc configuration of a `GaugeChartVisual` .
arcAxisoptionalIResolvable | CfnDashboard.ArcAxisConfigurationPropertyarc_axisoptionaltyping.Union[IResolvable, ArcAxisConfigurationProperty]arcAxisoptionalIResolvableArcAxisoptionalIResolvableArcAxisoptionalinterface{}#
The arc axis configuration of a `GaugeChartVisual` .
comparisonoptionalIResolvable | CfnDashboard.ComparisonConfigurationPropertycomparisonoptionaltyping.Union[IResolvable, ComparisonConfigurationProperty]comparisonoptionalIResolvableComparisonoptionalIResolvableComparisonoptionalinterface{}#
The comparison configuration of a `GaugeChartVisual` .
primaryValueDisplayTypeoptionalstringprimary_value_display_typeoptionalstrprimaryValueDisplayTypeoptionalStringPrimaryValueDisplayTypeoptionalstringPrimaryValueDisplayTypeoptional*string#
The options that determine the primary value display type.
primaryValueFontConfigurationoptionalIResolvable | CfnDashboard.FontConfigurationPropertyprimary_value_font_configurationoptionaltyping.Union[IResolvable, FontConfigurationProperty]primaryValueFontConfigurationoptionalIResolvablePrimaryValueFontConfigurationoptionalIResolvablePrimaryValueFontConfigurationoptionalinterface{}#
The options that determine the primary value font configuration.