Struct aws_sdk_quicksight::model::SheetDefinition
source · #[non_exhaustive]pub struct SheetDefinition { /* private fields */ }
Expand description
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.
Implementations§
source§impl SheetDefinition
impl SheetDefinition
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the sheet.
sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
sourcepub fn parameter_controls(&self) -> Option<&[ParameterControl]>
pub fn parameter_controls(&self) -> Option<&[ParameterControl]>
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.
sourcepub fn filter_controls(&self) -> Option<&[FilterControl]>
pub fn filter_controls(&self) -> Option<&[FilterControl]>
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.
sourcepub fn visuals(&self) -> Option<&[Visual]>
pub fn visuals(&self) -> Option<&[Visual]>
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
sourcepub fn text_boxes(&self) -> Option<&[SheetTextBox]>
pub fn text_boxes(&self) -> Option<&[SheetTextBox]>
The text boxes that are on a sheet.
sourcepub fn layouts(&self) -> Option<&[Layout]>
pub fn layouts(&self) -> Option<&[Layout]>
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
sourcepub fn sheet_control_layouts(&self) -> Option<&[SheetControlLayout]>
pub fn sheet_control_layouts(&self) -> Option<&[SheetControlLayout]>
The control layouts of the sheet.
sourcepub fn content_type(&self) -> Option<&SheetContentType>
pub fn content_type(&self) -> Option<&SheetContentType>
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.
source§impl SheetDefinition
impl SheetDefinition
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture SheetDefinition
.
Trait Implementations§
source§impl Clone for SheetDefinition
impl Clone for SheetDefinition
source§fn clone(&self) -> SheetDefinition
fn clone(&self) -> SheetDefinition
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SheetDefinition
impl Debug for SheetDefinition
source§impl PartialEq<SheetDefinition> for SheetDefinition
impl PartialEq<SheetDefinition> for SheetDefinition
source§fn eq(&self, other: &SheetDefinition) -> bool
fn eq(&self, other: &SheetDefinition) -> bool
self
and other
values to be equal, and is used
by ==
.