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
contentTypeoptionalstringcontent_typeoptionalstrcontentTypeoptionalStringContentTypeoptionalstringContentTypeoptional*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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the sheet.
filterControlsoptionalIResolvable | IResolvable | CfnAnalysis.FilterControlProperty[]filter_controlsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FilterControlProperty]]]filterControlsoptionalIResolvableFilterControlsoptionalIResolvableFilterControlsoptionalinterface{}#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 .
imagesoptionalIResolvable | IResolvable | CfnAnalysis.SheetImageProperty[]imagesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetImageProperty]]]imagesoptionalIResolvableImagesoptionalIResolvableImagesoptionalinterface{}#A list of images on a sheet.
layoutsoptionalIResolvable | IResolvable | CfnAnalysis.LayoutProperty[]layoutsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LayoutProperty]]]layoutsoptionalIResolvableLayoutsoptionalIResolvableLayoutsoptionalinterface{}#Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon Quick Suite User Guide .
The name of the sheet.
This name is displayed on the sheet's tab in the Quick Suite console.
parameterControlsoptionalIResolvable | IResolvable | CfnAnalysis.ParameterControlProperty[]parameter_controlsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ParameterControlProperty]]]parameterControlsoptionalIResolvableParameterControlsoptionalIResolvableParameterControlsoptionalinterface{}#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 .
sheetControlLayoutsoptionalIResolvable | IResolvable | CfnAnalysis.SheetControlLayoutProperty[]sheet_control_layoutsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetControlLayoutProperty]]]sheetControlLayoutsoptionalIResolvableSheetControlLayoutsoptionalIResolvableSheetControlLayoutsoptionalinterface{}#The control layouts of the sheet.
The unique identifier of a sheet.
textBoxesoptionalIResolvable | IResolvable | CfnAnalysis.SheetTextBoxProperty[]text_boxesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetTextBoxProperty]]]textBoxesoptionalIResolvableTextBoxesoptionalIResolvableTextBoxesoptionalinterface{}#The text boxes that are on a sheet.
The title of the sheet.
visualsoptionalIResolvable | IResolvable | CfnAnalysis.VisualProperty[]visualsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VisualProperty]]]visualsoptionalIResolvableVisualsoptionalIResolvableVisualsoptionalinterface{}#A list of the visuals that are on a sheet.
Visual placement is determined by the layout of the sheet.