aws-cdk-lib.aws_quicksight.CfnDashboard.SheetDefinitionProperty

interface SheetDefinitionProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.SheetDefinitionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_SheetDefinitionProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.SheetDefinitionProperty
Pythonaws_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

NameTypeDescription
sheetIdstringThe unique identifier of a sheet.
contentType?stringThe layout content type of the sheet. Choose one of the following options:.
description?stringA description of the sheet.
filterControls?IResolvable | IResolvable | FilterControlProperty[]The list of filter controls that are on a sheet.
layouts?IResolvable | IResolvable | LayoutProperty[]Layouts define how the components of a sheet are arranged.
name?stringThe name of the sheet.
parameterControls?IResolvable | IResolvable | ParameterControlProperty[]The list of parameter controls that are on a sheet.
sheetControlLayouts?IResolvable | IResolvable | SheetControlLayoutProperty[]The control layouts of the sheet.
textBoxes?IResolvable | IResolvable | SheetTextBoxProperty[]The text boxes that are on a sheet.
title?stringThe title of the sheet.
visuals?IResolvable | IResolvable | VisualProperty[]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 | FilterControlProperty[] (optional)

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?

Type: IResolvable | IResolvable | LayoutProperty[] (optional)

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight 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 | ParameterControlProperty[] (optional)

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?

Type: IResolvable | IResolvable | SheetControlLayoutProperty[] (optional)

The control layouts of the sheet.


textBoxes?

Type: IResolvable | IResolvable | SheetTextBoxProperty[] (optional)

The text boxes that are on a sheet.


title?

Type: string (optional)

The title of the sheet.


visuals?

Type: IResolvable | IResolvable | VisualProperty[] (optional)

A list of the visuals that are on a sheet.

Visual placement is determined by the layout of the sheet.