Struct aws_sdk_quicksight::types::SheetDefinition

#[non_exhaustive]
pub struct SheetDefinition {
    pub sheet_id: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub name: Option<String>,
    pub parameter_controls: Option<Vec<ParameterControl>>,
    pub filter_controls: Option<Vec<FilterControl>>,
    pub visuals: Option<Vec<Visual>>,
    pub text_boxes: Option<Vec<SheetTextBox>>,
    pub layouts: Option<Vec<Layout>>,
    pub sheet_control_layouts: Option<Vec<SheetControlLayout>>,
    pub content_type: Option<SheetContentType>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sheet_id: String

The unique identifier of a sheet.

title: Option<String>

The title of the sheet.

description: Option<String>

A description of the sheet.

name: Option<String>

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

parameter_controls: Option<Vec<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.

filter_controls: Option<Vec<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.

visuals: Option<Vec<Visual>>

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

text_boxes: Option<Vec<SheetTextBox>>

The text boxes that are on a sheet.

layouts: Option<Vec<Layout>>

Layouts define how the components of a sheet are arranged.

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

sheet_control_layouts: Option<Vec<SheetControlLayout>>

The control layouts of the sheet.

content_type: 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.

Implementations

impl SheetDefinition

pub fn sheet_id(&self) -> &str

The unique identifier of a sheet.

pub fn title(&self) -> Option<&str>

The title of the sheet.

pub fn description(&self) -> Option<&str>

A description of the sheet.

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.

pub fn parameter_controls(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameter_controls.is_none().

pub fn filter_controls(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filter_controls.is_none().

pub fn visuals(&self) -> &[Visual]

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .visuals.is_none().

pub fn text_boxes(&self) -> &[SheetTextBox]

The text boxes that are on a sheet.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .text_boxes.is_none().

pub fn layouts(&self) -> &[Layout]

Layouts define how the components of a sheet are arranged.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .layouts.is_none().

pub fn sheet_control_layouts(&self) -> &[SheetControlLayout]

The control layouts of the sheet.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sheet_control_layouts.is_none().

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.

impl SheetDefinition

pub fn builder() -> SheetDefinitionBuilder

Creates a new builder-style object to manufacture SheetDefinition.

Trait Implementations

impl Clone for SheetDefinition

fn clone(&self) -> SheetDefinition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SheetDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SheetDefinition

fn eq(&self, other: &SheetDefinition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SheetDefinition