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

Description

Synopsis

Documentation

data FilterListControl Source #

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

See: newFilterListControl smart constructor.

Constructors

FilterListControl'

Fields

cascadingControlConfiguration :: Maybe CascadingControlConfiguration
The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
displayOptions :: Maybe ListControlDisplayOptions
The display options of a control.
selectableValues :: Maybe FilterSelectableValues
A list of selectable values that are used in a control.
type' :: Maybe SheetControlListType
The type of FilterListControl. Choose one of the following options:
- MULTI_SELECT: The user can select multiple entries from the list.
- SINGLE_SELECT: The user can select a single entry from the list.
filterControlId :: Text
The ID of the FilterListControl.
title :: Text
The title of the FilterListControl.
sourceFilterId :: Text
The source filter ID of the FilterListControl.

Instances

Instances details

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

newFilterListControl Source #

Arguments

:: Text	`$sel:filterControlId:FilterListControl'`
-> Text	`$sel:title:FilterListControl'`
-> Text	`$sel:sourceFilterId:FilterListControl'`
-> FilterListControl

Create a value of FilterListControl 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:cascadingControlConfiguration:FilterListControl', filterListControl_cascadingControlConfiguration - The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

$sel:displayOptions:FilterListControl', filterListControl_displayOptions - The display options of a control.

$sel:selectableValues:FilterListControl', filterListControl_selectableValues - A list of selectable values that are used in a control.

$sel:type':FilterListControl', filterListControl_type - The type of FilterListControl. Choose one of the following options:

MULTI_SELECT: The user can select multiple entries from the list.
SINGLE_SELECT: The user can select a single entry from the list.

$sel:filterControlId:FilterListControl', filterListControl_filterControlId - The ID of the FilterListControl.

$sel:title:FilterListControl', filterListControl_title - The title of the FilterListControl.

$sel:sourceFilterId:FilterListControl', filterListControl_sourceFilterId - The source filter ID of the FilterListControl.

filterListControl_cascadingControlConfiguration :: Lens' FilterListControl (Maybe CascadingControlConfiguration) Source #

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

filterListControl_displayOptions :: Lens' FilterListControl (Maybe ListControlDisplayOptions) Source #

The display options of a control.

filterListControl_selectableValues :: Lens' FilterListControl (Maybe FilterSelectableValues) Source #

A list of selectable values that are used in a control.

filterListControl_type :: Lens' FilterListControl (Maybe SheetControlListType) Source #

The type of FilterListControl. Choose one of the following options:

MULTI_SELECT: The user can select multiple entries from the list.
SINGLE_SELECT: The user can select a single entry from the list.

filterListControl_filterControlId :: Lens' FilterListControl Text Source #

The ID of the FilterListControl.

filterListControl_title :: Lens' FilterListControl Text Source #

The title of the FilterListControl.

filterListControl_sourceFilterId :: Lens' FilterListControl Text Source #

The source filter ID of the FilterListControl.