interface SparklinesOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.SparklinesOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_SparklinesOptionsProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.SparklinesOptionsProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.SparklinesOptionsProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnAnalysis » SparklinesOptionsProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html

Example

// 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 sparklinesOptionsProperty: quicksight.CfnAnalysis.SparklinesOptionsProperty = {
  fieldId: 'fieldId',
  xAxisField: {
    categoricalDimensionField: {
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      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: {
                groupingStyle: 'groupingStyle',
                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: {
                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',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
    dateDimensionField: {
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      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: {
                groupingStyle: 'groupingStyle',
                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: {
                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',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
    numericalDimensionField: {
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      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: {
                groupingStyle: 'groupingStyle',
                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: {
                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',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
  },

  // the properties below are optional
  allPointsMarker: {
    markerColor: 'markerColor',
    markerShape: 'markerShape',
    markerSize: 'markerSize',
    markerVisibility: 'markerVisibility',
  },
  lineColor: 'lineColor',
  lineInterpolation: 'lineInterpolation',
  maxValueMarker: {
    markerColor: 'markerColor',
    markerShape: 'markerShape',
    markerSize: 'markerSize',
    markerVisibility: 'markerVisibility',
  },
  minValueMarker: {
    markerColor: 'markerColor',
    markerShape: 'markerShape',
    markerSize: 'markerSize',
    markerVisibility: 'markerVisibility',
  },
  visualType: 'visualType',
  yAxisBehavior: 'yAxisBehavior',
};

Properties

Name	Type	Description
fieldId	string
xAxisField	IResolvable | DimensionFieldProperty
allPointsMarker?	IResolvable | LineChartMarkerStyleSettingsProperty
lineColor?	string
lineInterpolation?	string
maxValueMarker?	IResolvable | LineChartMarkerStyleSettingsProperty
minValueMarker?	IResolvable | LineChartMarkerStyleSettingsProperty
visualType?	string
yAxisBehavior?	string

---

fieldId

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-fieldid

---

xAxisField

Type: IResolvable | DimensionFieldProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-xaxisfield

---

allPointsMarker?

Type: IResolvable | LineChartMarkerStyleSettingsProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-allpointsmarker

---

lineColor?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-linecolor

---

lineInterpolation?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-lineinterpolation

---

maxValueMarker?

Type: IResolvable | LineChartMarkerStyleSettingsProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-maxvaluemarker

---

minValueMarker?

Type: IResolvable | LineChartMarkerStyleSettingsProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-minvaluemarker

---

visualType?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-visualtype

---

yAxisBehavior?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sparklinesoptions.html#cfn-quicksight-analysis-sparklinesoptions-yaxisbehavior