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

Description

Synopsis

data SheetDefinition = SheetDefinition' {
- contentType :: Maybe SheetContentType
- description :: Maybe Text
- filterControls :: Maybe [FilterControl]
- layouts :: Maybe (NonEmpty Layout)
- name :: Maybe Text
- parameterControls :: Maybe [ParameterControl]
- sheetControlLayouts :: Maybe [SheetControlLayout]
- textBoxes :: Maybe [SheetTextBox]
- title :: Maybe Text
- visuals :: Maybe [Visual]
- sheetId :: Text
}
newSheetDefinition :: Text -> SheetDefinition
sheetDefinition_contentType :: Lens' SheetDefinition (Maybe SheetContentType)
sheetDefinition_description :: Lens' SheetDefinition (Maybe Text)
sheetDefinition_filterControls :: Lens' SheetDefinition (Maybe [FilterControl])
sheetDefinition_layouts :: Lens' SheetDefinition (Maybe (NonEmpty Layout))
sheetDefinition_name :: Lens' SheetDefinition (Maybe Text)
sheetDefinition_parameterControls :: Lens' SheetDefinition (Maybe [ParameterControl])
sheetDefinition_sheetControlLayouts :: Lens' SheetDefinition (Maybe [SheetControlLayout])
sheetDefinition_textBoxes :: Lens' SheetDefinition (Maybe [SheetTextBox])
sheetDefinition_title :: Lens' SheetDefinition (Maybe Text)
sheetDefinition_visuals :: Lens' SheetDefinition (Maybe [Visual])
sheetDefinition_sheetId :: Lens' SheetDefinition Text

Documentation

data SheetDefinition Source #

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

See: newSheetDefinition smart constructor.

Constructors

SheetDefinition'

Fields

contentType :: Maybe SheetContentType
The layout content type of the sheet. Choose one of the following options:
- PAGINATED: Creates a sheet for a paginated report.
- INTERACTIVE: Creates a sheet for an interactive dashboard.
description :: Maybe Text
A description of the sheet.
filterControls :: Maybe [FilterControl]
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
layouts :: Maybe (NonEmpty Layout)
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
name :: Maybe Text
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
parameterControls :: Maybe [ParameterControl]
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
sheetControlLayouts :: Maybe [SheetControlLayout]
The control layouts of the sheet.
textBoxes :: Maybe [SheetTextBox]
The text boxes that are on a sheet.
title :: Maybe Text
The title of the sheet.
visuals :: Maybe [Visual]
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
sheetId :: Text
The unique identifier of a sheet.

Instances

Instances details

FromJSON SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods parseJSON :: Value -> Parser SheetDefinition # parseJSONList :: Value -> Parser [SheetDefinition] #
ToJSON SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods toJSON :: SheetDefinition -> Value # toEncoding :: SheetDefinition -> Encoding # toJSONList :: [SheetDefinition] -> Value # toEncodingList :: [SheetDefinition] -> Encoding #
Generic SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Associated Types type Rep SheetDefinition :: Type -> Type # Methods from :: SheetDefinition -> Rep SheetDefinition x # to :: Rep SheetDefinition x -> SheetDefinition #
Show SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods showsPrec :: Int -> SheetDefinition -> ShowS # show :: SheetDefinition -> String # showList :: [SheetDefinition] -> ShowS #
NFData SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods rnf :: SheetDefinition -> () #
Eq SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods (==) :: SheetDefinition -> SheetDefinition -> Bool # (/=) :: SheetDefinition -> SheetDefinition -> Bool #
Hashable SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition Methods hashWithSalt :: Int -> SheetDefinition -> Int # hash :: SheetDefinition -> Int #
type Rep SheetDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.SheetDefinition type Rep SheetDefinition = D1 ('MetaData "SheetDefinition" "Amazonka.QuickSight.Types.SheetDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SheetDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SheetContentType)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filterControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterControl])) :: (S1 ('MetaSel ('Just "layouts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Layout))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "parameterControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterControl])) :: (S1 ('MetaSel ('Just "sheetControlLayouts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SheetControlLayout])) :: S1 ('MetaSel ('Just "textBoxes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SheetTextBox])))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "visuals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Visual])) :: S1 ('MetaSel ('Just "sheetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSheetDefinition Source #

Arguments

:: Text	`$sel:sheetId:SheetDefinition'`
-> SheetDefinition

Create a value of SheetDefinition 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:contentType:SheetDefinition', sheetDefinition_contentType - The layout content type of the sheet. Choose one of the following options:

PAGINATED: Creates a sheet for a paginated report.
INTERACTIVE: Creates a sheet for an interactive dashboard.

$sel:description:SheetDefinition', sheetDefinition_description - A description of the sheet.

$sel:filterControls:SheetDefinition', sheetDefinition_filterControls - The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

$sel:layouts:SheetDefinition', sheetDefinition_layouts - Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

$sel:name:SheetDefinition', sheetDefinition_name - The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

$sel:parameterControls:SheetDefinition', sheetDefinition_parameterControls - The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

$sel:sheetControlLayouts:SheetDefinition', sheetDefinition_sheetControlLayouts - The control layouts of the sheet.

$sel:textBoxes:SheetDefinition', sheetDefinition_textBoxes - The text boxes that are on a sheet.

$sel:title:SheetDefinition', sheetDefinition_title - The title of the sheet.

$sel:visuals:SheetDefinition', sheetDefinition_visuals - A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

$sel:sheetId:SheetDefinition', sheetDefinition_sheetId - The unique identifier of a sheet.

sheetDefinition_contentType :: Lens' SheetDefinition (Maybe SheetContentType) Source #

The layout content type of the sheet. Choose one of the following options:

PAGINATED: Creates a sheet for a paginated report.
INTERACTIVE: Creates a sheet for an interactive dashboard.

sheetDefinition_description :: Lens' SheetDefinition (Maybe Text) Source #

A description of the sheet.

sheetDefinition_filterControls :: Lens' SheetDefinition (Maybe [FilterControl]) Source #

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

sheetDefinition_layouts :: Lens' SheetDefinition (Maybe (NonEmpty Layout)) Source #

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

sheetDefinition_name :: Lens' SheetDefinition (Maybe Text) Source #

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

sheetDefinition_parameterControls :: Lens' SheetDefinition (Maybe [ParameterControl]) Source #

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

sheetDefinition_sheetControlLayouts :: Lens' SheetDefinition (Maybe [SheetControlLayout]) Source #

The control layouts of the sheet.

sheetDefinition_textBoxes :: Lens' SheetDefinition (Maybe [SheetTextBox]) Source #

The text boxes that are on a sheet.

sheetDefinition_title :: Lens' SheetDefinition (Maybe Text) Source #

The title of the sheet.

sheetDefinition_visuals :: Lens' SheetDefinition (Maybe [Visual]) Source #

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

sheetDefinition_sheetId :: Lens' SheetDefinition Text Source #

The unique identifier of a sheet.