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