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.LegendOptions

Description

Synopsis

Documentation

data LegendOptions Source #

The options for the legend setup of a visual.

See: newLegendOptions smart constructor.

Constructors

LegendOptions'

Fields

height :: Maybe Text
The height of the legend. If this value is omitted, a default height is used when rendering.
position :: Maybe LegendPosition
The positions for the legend. Choose one of the following options:
- ```
AUTO
```
- ```
RIGHT
```
- ```
BOTTOM
```
- ```
LEFT
```
title :: Maybe LabelOptions
The custom title for the legend.
visibility :: Maybe Visibility
Determines whether or not the legend is visible.
width :: Maybe Text
The width of the legend. If this value is omitted, a default width is used when rendering.

Instances

Instances details

FromJSON LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods parseJSON :: Value -> Parser LegendOptions # parseJSONList :: Value -> Parser [LegendOptions] #
ToJSON LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods toJSON :: LegendOptions -> Value # toEncoding :: LegendOptions -> Encoding # toJSONList :: [LegendOptions] -> Value # toEncodingList :: [LegendOptions] -> Encoding #
Generic LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Associated Types type Rep LegendOptions :: Type -> Type # Methods from :: LegendOptions -> Rep LegendOptions x # to :: Rep LegendOptions x -> LegendOptions #
Read LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods readsPrec :: Int -> ReadS LegendOptions # readList :: ReadS [LegendOptions] # readPrec :: ReadPrec LegendOptions # readListPrec :: ReadPrec [LegendOptions] #
Show LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods showsPrec :: Int -> LegendOptions -> ShowS # show :: LegendOptions -> String # showList :: [LegendOptions] -> ShowS #
NFData LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods rnf :: LegendOptions -> () #
Eq LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods (==) :: LegendOptions -> LegendOptions -> Bool # (/=) :: LegendOptions -> LegendOptions -> Bool #
Hashable LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions Methods hashWithSalt :: Int -> LegendOptions -> Int # hash :: LegendOptions -> Int #
type Rep LegendOptions Source #
Instance details Defined in Amazonka.QuickSight.Types.LegendOptions type Rep LegendOptions = D1 ('MetaData "LegendOptions" "Amazonka.QuickSight.Types.LegendOptions" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "LegendOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LegendPosition))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LabelOptions)) :: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Visibility)) :: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLegendOptions :: LegendOptions Source #

Create a value of LegendOptions 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:height:LegendOptions', legendOptions_height - The height of the legend. If this value is omitted, a default height is used when rendering.

$sel:position:LegendOptions', legendOptions_position - The positions for the legend. Choose one of the following options:

```
AUTO
```
```
RIGHT
```
```
BOTTOM
```
```
LEFT
```

$sel:title:LegendOptions', legendOptions_title - The custom title for the legend.

LegendOptions, legendOptions_visibility - Determines whether or not the legend is visible.

$sel:width:LegendOptions', legendOptions_width - The width of the legend. If this value is omitted, a default width is used when rendering.

legendOptions_height :: Lens' LegendOptions (Maybe Text) Source #

The height of the legend. If this value is omitted, a default height is used when rendering.

legendOptions_position :: Lens' LegendOptions (Maybe LegendPosition) Source #

The positions for the legend. Choose one of the following options:

```
AUTO
```
```
RIGHT
```
```
BOTTOM
```
```
LEFT
```

legendOptions_title :: Lens' LegendOptions (Maybe LabelOptions) Source #

The custom title for the legend.

legendOptions_visibility :: Lens' LegendOptions (Maybe Visibility) Source #

Determines whether or not the legend is visible.

legendOptions_width :: Lens' LegendOptions (Maybe Text) Source #

The width of the legend. If this value is omitted, a default width is used when rendering.