Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.BarChartConfiguration

Description

Synopsis

Documentation

data BarChartConfiguration Source #

The configuration of a BarChartVisual.

See: newBarChartConfiguration smart constructor.

Constructors

BarChartConfiguration'

Fields

barsArrangement :: Maybe BarsArrangement
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
categoryAxis :: Maybe AxisDisplayOptions
The label display options (grid line, range, scale, axis step) for bar chart category.
categoryLabelOptions :: Maybe ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart.
colorLabelOptions :: Maybe ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
contributionAnalysisDefaults :: Maybe (NonEmpty ContributionAnalysisDefault)
The contribution analysis (anomaly configuration) setup of the visual.
dataLabels :: Maybe DataLabelOptions
The options that determine if visual data labels are displayed.
fieldWells :: Maybe BarChartFieldWells
The field wells of the visual.
legend :: Maybe LegendOptions
The legend display setup of the visual.
orientation :: Maybe BarChartOrientation
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 :: Maybe [ReferenceLine]
The reference line setup of the visual.
smallMultiplesOptions :: Maybe SmallMultiplesOptions
The small multiples setup for the visual.
sortConfiguration :: Maybe BarChartSortConfiguration
The sort configuration of a BarChartVisual.
tooltip :: Maybe TooltipOptions
The tooltip display setup of the visual.
valueAxis :: Maybe AxisDisplayOptions
The label display options (grid line, range, scale, axis step) for a bar chart value.
valueLabelOptions :: Maybe ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
visualPalette :: Maybe VisualPalette
The palette (chart color) display setup of the visual.

Instances

Instances details

FromJSON BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods parseJSON :: Value -> Parser BarChartConfiguration # parseJSONList :: Value -> Parser [BarChartConfiguration] #
ToJSON BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods toJSON :: BarChartConfiguration -> Value # toEncoding :: BarChartConfiguration -> Encoding # toJSONList :: [BarChartConfiguration] -> Value # toEncodingList :: [BarChartConfiguration] -> Encoding #
Generic BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Associated Types type Rep BarChartConfiguration :: Type -> Type # Methods from :: BarChartConfiguration -> Rep BarChartConfiguration x # to :: Rep BarChartConfiguration x -> BarChartConfiguration #
Show BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods showsPrec :: Int -> BarChartConfiguration -> ShowS # show :: BarChartConfiguration -> String # showList :: [BarChartConfiguration] -> ShowS #
NFData BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods rnf :: BarChartConfiguration -> () #
Eq BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods (==) :: BarChartConfiguration -> BarChartConfiguration -> Bool # (/=) :: BarChartConfiguration -> BarChartConfiguration -> Bool #
Hashable BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration Methods hashWithSalt :: Int -> BarChartConfiguration -> Int # hash :: BarChartConfiguration -> Int #
type Rep BarChartConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.BarChartConfiguration type Rep BarChartConfiguration = D1 ('MetaData "BarChartConfiguration" "Amazonka.QuickSight.Types.BarChartConfiguration" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "BarChartConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "barsArrangement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BarsArrangement)) :: S1 ('MetaSel ('Just "categoryAxis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AxisDisplayOptions))) :: (S1 ('MetaSel ('Just "categoryLabelOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChartAxisLabelOptions)) :: S1 ('MetaSel ('Just "colorLabelOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChartAxisLabelOptions)))) :: ((S1 ('MetaSel ('Just "contributionAnalysisDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ContributionAnalysisDefault))) :: S1 ('MetaSel ('Just "dataLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataLabelOptions))) :: (S1 ('MetaSel ('Just "fieldWells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BarChartFieldWells)) :: S1 ('MetaSel ('Just "legend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LegendOptions))))) :: (((S1 ('MetaSel ('Just "orientation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BarChartOrientation)) :: S1 ('MetaSel ('Just "referenceLines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReferenceLine]))) :: (S1 ('MetaSel ('Just "smallMultiplesOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmallMultiplesOptions)) :: S1 ('MetaSel ('Just "sortConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BarChartSortConfiguration)))) :: ((S1 ('MetaSel ('Just "tooltip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TooltipOptions)) :: S1 ('MetaSel ('Just "valueAxis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AxisDisplayOptions))) :: (S1 ('MetaSel ('Just "valueLabelOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChartAxisLabelOptions)) :*: S1 ('MetaSel ('Just "visualPalette") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisualPalette)))))))

newBarChartConfiguration :: BarChartConfiguration Source #

Create a value of BarChartConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:barsArrangement:BarChartConfiguration', barChartConfiguration_barsArrangement - Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

$sel:categoryAxis:BarChartConfiguration', barChartConfiguration_categoryAxis - The label display options (grid line, range, scale, axis step) for bar chart category.

$sel:categoryLabelOptions:BarChartConfiguration', barChartConfiguration_categoryLabelOptions - The label options (label text, label visibility and sort icon visibility) for a bar chart.

$sel:colorLabelOptions:BarChartConfiguration', barChartConfiguration_colorLabelOptions - The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

$sel:contributionAnalysisDefaults:BarChartConfiguration', barChartConfiguration_contributionAnalysisDefaults - The contribution analysis (anomaly configuration) setup of the visual.

$sel:dataLabels:BarChartConfiguration', barChartConfiguration_dataLabels - The options that determine if visual data labels are displayed.

$sel:fieldWells:BarChartConfiguration', barChartConfiguration_fieldWells - The field wells of the visual.

$sel:legend:BarChartConfiguration', barChartConfiguration_legend - The legend display setup of the visual.

$sel:orientation:BarChartConfiguration', barChartConfiguration_orientation - 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.

$sel:referenceLines:BarChartConfiguration', barChartConfiguration_referenceLines - The reference line setup of the visual.

$sel:smallMultiplesOptions:BarChartConfiguration', barChartConfiguration_smallMultiplesOptions - The small multiples setup for the visual.

$sel:sortConfiguration:BarChartConfiguration', barChartConfiguration_sortConfiguration - The sort configuration of a BarChartVisual.

$sel:tooltip:BarChartConfiguration', barChartConfiguration_tooltip - The tooltip display setup of the visual.

$sel:valueAxis:BarChartConfiguration', barChartConfiguration_valueAxis - The label display options (grid line, range, scale, axis step) for a bar chart value.

$sel:valueLabelOptions:BarChartConfiguration', barChartConfiguration_valueLabelOptions - The label options (label text, label visibility and sort icon visibility) for a bar chart value.

$sel:visualPalette:BarChartConfiguration', barChartConfiguration_visualPalette - The palette (chart color) display setup of the visual.

barChartConfiguration_barsArrangement :: Lens' BarChartConfiguration (Maybe BarsArrangement) Source #

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

barChartConfiguration_categoryAxis :: Lens' BarChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) for bar chart category.

barChartConfiguration_categoryLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a bar chart.

barChartConfiguration_colorLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

barChartConfiguration_contributionAnalysisDefaults :: Lens' BarChartConfiguration (Maybe (NonEmpty ContributionAnalysisDefault)) Source #

The contribution analysis (anomaly configuration) setup of the visual.

barChartConfiguration_dataLabels :: Lens' BarChartConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

barChartConfiguration_fieldWells :: Lens' BarChartConfiguration (Maybe BarChartFieldWells) Source #

The field wells of the visual.

barChartConfiguration_legend :: Lens' BarChartConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

barChartConfiguration_orientation :: Lens' BarChartConfiguration (Maybe BarChartOrientation) Source #

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.

barChartConfiguration_referenceLines :: Lens' BarChartConfiguration (Maybe [ReferenceLine]) Source #

The reference line setup of the visual.

barChartConfiguration_smallMultiplesOptions :: Lens' BarChartConfiguration (Maybe SmallMultiplesOptions) Source #

The small multiples setup for the visual.

barChartConfiguration_sortConfiguration :: Lens' BarChartConfiguration (Maybe BarChartSortConfiguration) Source #

The sort configuration of a BarChartVisual.

barChartConfiguration_tooltip :: Lens' BarChartConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

barChartConfiguration_valueAxis :: Lens' BarChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) for a bar chart value.

barChartConfiguration_valueLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

barChartConfiguration_visualPalette :: Lens' BarChartConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.