/AWS1/CL_QSTSHEETDEFINITION¶
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.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_SHEETID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00¶
The unique identifier of a sheet.
Optional arguments:¶
IV_TITLE TYPE /AWS1/QSTSHEETTITLE /AWS1/QSTSHEETTITLE¶
The title of the sheet.
IV_DESCRIPTION TYPE /AWS1/QSTSHEETDESCRIPTION /AWS1/QSTSHEETDESCRIPTION¶
A description of the sheet.
IV_NAME TYPE /AWS1/QSTSHEETNAME /AWS1/QSTSHEETNAME¶
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
IT_PARAMETERCONTROLS TYPE /AWS1/CL_QSTPARAMETERCONTROL=>TT_PARAMETERCONTROLLIST TT_PARAMETERCONTROLLIST¶
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.
IT_FILTERCONTROLS TYPE /AWS1/CL_QSTFILTERCONTROL=>TT_FILTERCONTROLLIST TT_FILTERCONTROLLIST¶
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.
IT_VISUALS TYPE /AWS1/CL_QSTVISUAL=>TT_VISUALLIST TT_VISUALLIST¶
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
IT_TEXTBOXES TYPE /AWS1/CL_QSTSHEETTEXTBOX=>TT_SHEETTEXTBOXLIST TT_SHEETTEXTBOXLIST¶
The text boxes that are on a sheet.
IT_LAYOUTS TYPE /AWS1/CL_QSTLAYOUT=>TT_LAYOUTLIST TT_LAYOUTLIST¶
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
IT_SHEETCONTROLLAYOUTS TYPE /AWS1/CL_QSTSHEETCONTROLLAYOUT=>TT_SHEETCONTROLLAYOUTLIST TT_SHEETCONTROLLAYOUTLIST¶
The control layouts of the sheet.
IV_CONTENTTYPE TYPE /AWS1/QSTSHEETCONTENTTYPE /AWS1/QSTSHEETCONTENTTYPE¶
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.
Queryable Attributes¶
SheetId¶
The unique identifier of a sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHEETID() |
Getter for SHEETID, with configurable default |
ASK_SHEETID() |
Getter for SHEETID w/ exceptions if field has no value |
HAS_SHEETID() |
Determine if SHEETID has a value |
Title¶
The title of the sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
Description¶
A description of the sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Name¶
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARAMETERCONTROLS() |
Getter for PARAMETERCONTROLS, with configurable default |
ASK_PARAMETERCONTROLS() |
Getter for PARAMETERCONTROLS w/ exceptions if field has no v |
HAS_PARAMETERCONTROLS() |
Determine if PARAMETERCONTROLS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILTERCONTROLS() |
Getter for FILTERCONTROLS, with configurable default |
ASK_FILTERCONTROLS() |
Getter for FILTERCONTROLS w/ exceptions if field has no valu |
HAS_FILTERCONTROLS() |
Determine if FILTERCONTROLS has a value |
Visuals¶
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VISUALS() |
Getter for VISUALS, with configurable default |
ASK_VISUALS() |
Getter for VISUALS w/ exceptions if field has no value |
HAS_VISUALS() |
Determine if VISUALS has a value |
TextBoxes¶
The text boxes that are on a sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEXTBOXES() |
Getter for TEXTBOXES, with configurable default |
ASK_TEXTBOXES() |
Getter for TEXTBOXES w/ exceptions if field has no value |
HAS_TEXTBOXES() |
Determine if TEXTBOXES has a value |
Layouts¶
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAYOUTS() |
Getter for LAYOUTS, with configurable default |
ASK_LAYOUTS() |
Getter for LAYOUTS w/ exceptions if field has no value |
HAS_LAYOUTS() |
Determine if LAYOUTS has a value |
SheetControlLayouts¶
The control layouts of the sheet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHEETCONTROLLAYOUTS() |
Getter for SHEETCONTROLLAYOUTS, with configurable default |
ASK_SHEETCONTROLLAYOUTS() |
Getter for SHEETCONTROLLAYOUTS w/ exceptions if field has no |
HAS_SHEETCONTROLLAYOUTS() |
Determine if SHEETCONTROLLAYOUTS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTENTTYPE() |
Getter for CONTENTTYPE, with configurable default |
ASK_CONTENTTYPE() |
Getter for CONTENTTYPE w/ exceptions if field has no value |
HAS_CONTENTTYPE() |
Determine if CONTENTTYPE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SHEETDEFINITIONLIST¶
TYPES TT_SHEETDEFINITIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_QSTSHEETDEFINITION WITH DEFAULT KEY
.