interface SheetDefinitionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDashboard.SheetDefinitionProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_SheetDefinitionProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnDashboard.SheetDefinitionProperty |
 Python | aws_cdk.aws_quicksight.CfnDashboard.SheetDefinitionProperty |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnDashboard » SheetDefinitionProperty |
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.
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| sheet | string | The unique identifier of a sheet. |
| content | string | The layout content type of the sheet. Choose one of the following options:. |
| description? | string | A description of the sheet. |
| filter | IResolvable | (IResolvable | Filter)[] | The list of filter controls that are on a sheet. |
| images? | IResolvable | (IResolvable | Sheet)[] | A list of images on a sheet. |
| layouts? | IResolvable | (IResolvable | Layout)[] | Layouts define how the components of a sheet are arranged. |
| name? | string | The name of the sheet. |
| parameter | IResolvable | (IResolvable | Parameter)[] | The list of parameter controls that are on a sheet. |
| sheet | IResolvable | (IResolvable | Sheet)[] | The control layouts of the sheet. |
| text | IResolvable | (IResolvable | Sheet)[] | The text boxes that are on a sheet. |
| title? | string | The title of the sheet. |
| visuals? | IResolvable | (IResolvable | Visual)[] | A list of the visuals that are on a sheet. |
sheetId
Type:
string
The unique identifier of a sheet.
contentType?
Type:
string
(optional)
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?
Type:
string
(optional)
A description of the sheet.
filterControls?
Type:
IResolvable | (IResolvable | Filter)[]
(optional)
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide .
images?
Type:
IResolvable | (IResolvable | Sheet)[]
(optional)
A list of images on a sheet.
layouts?
Type:
IResolvable | (IResolvable | Layout)[]
(optional)
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon Quick Suite User Guide .
name?
Type:
string
(optional)
The name of the sheet.
This name is displayed on the sheet's tab in the Amazon QuickSight console.
parameterControls?
Type:
IResolvable | (IResolvable | Parameter)[]
(optional)
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide .
sheetControlLayouts?
Type:
IResolvable | (IResolvable | Sheet)[]
(optional)
The control layouts of the sheet.
textBoxes?
Type:
IResolvable | (IResolvable | Sheet)[]
(optional)
The text boxes that are on a sheet.
title?
Type:
string
(optional)
The title of the sheet.
visuals?
Type:
IResolvable | (IResolvable | Visual)[]
(optional)
A list of the visuals that are on a sheet.
Visual placement is determined by the layout of the sheet.