Skip to content
v2.273.0

SheetDefinitionProperty Struct ​

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 ​

ts
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties ​

contentTypestringcontent_typestrcontentTypeStringContentTypestringContentType*string#
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.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description of the sheet.
filterControlsIResolvable | IResolvable | CfnAnalysis.FilterControlProperty[]filter_controlstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FilterControlProperty]]]filterControlsIResolvableFilterControlsIResolvableFilterControlsinterface{}#
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 .

imagesIResolvable | IResolvable | CfnAnalysis.SheetImageProperty[]imagestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetImageProperty]]]imagesIResolvableImagesIResolvableImagesinterface{}#
A list of images on a sheet.
layoutsIResolvable | IResolvable | CfnAnalysis.LayoutProperty[]layoutstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LayoutProperty]]]layoutsIResolvableLayoutsIResolvableLayoutsinterface{}#
Layouts define how the components of a sheet are arranged.

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

namestringnamestrnameStringNamestringName*string#
The name of the sheet.

This name is displayed on the sheet's tab in the Quick Suite console.

parameterControlsIResolvable | IResolvable | CfnAnalysis.ParameterControlProperty[]parameter_controlstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ParameterControlProperty]]]parameterControlsIResolvableParameterControlsIResolvableParameterControlsinterface{}#
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 .

sheetControlLayoutsIResolvable | IResolvable | CfnAnalysis.SheetControlLayoutProperty[]sheet_control_layoutstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetControlLayoutProperty]]]sheetControlLayoutsIResolvableSheetControlLayoutsIResolvableSheetControlLayoutsinterface{}#
The control layouts of the sheet.
sheetIdstringsheet_idstrsheetIdStringSheetIdstringSheetId*stringrequired#
The unique identifier of a sheet.
textBoxesIResolvable | IResolvable | CfnAnalysis.SheetTextBoxProperty[]text_boxestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetTextBoxProperty]]]textBoxesIResolvableTextBoxesIResolvableTextBoxesinterface{}#
The text boxes that are on a sheet.
titlestringtitlestrtitleStringTitlestringTitle*string#
The title of the sheet.
visualsIResolvable | IResolvable | CfnAnalysis.VisualProperty[]visualstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VisualProperty]]]visualsIResolvableVisualsIResolvableVisualsinterface{}#
A list of the visuals that are on a sheet.

Visual placement is determined by the layout of the sheet.