#[non_exhaustive]pub struct SheetDefinition {Show 13 fields
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 images: Option<Vec<SheetImage>>,
pub layouts: Option<Vec<Layout>>,
pub sheet_control_layouts: Option<Vec<SheetControlLayout>>,
pub content_type: Option<SheetContentType>,
pub custom_action_defaults: Option<VisualCustomActionDefaults>,
}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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.sheet_id: StringThe 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.
images: Option<Vec<SheetImage>>A list of images 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.
custom_action_defaults: Option<VisualCustomActionDefaults>A list of visual custom actions for the 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) -> &[ParameterControl]
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().
Sourcepub fn filter_controls(&self) -> &[FilterControl]
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().
Sourcepub fn visuals(&self) -> &[Visual]
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().
Sourcepub fn text_boxes(&self) -> &[SheetTextBox]
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().
Sourcepub fn images(&self) -> &[SheetImage]
pub fn images(&self) -> &[SheetImage]
A list of images 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 .images.is_none().
Sourcepub fn layouts(&self) -> &[Layout]
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().
Sourcepub fn sheet_control_layouts(&self) -> &[SheetControlLayout]
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().
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.
Sourcepub fn custom_action_defaults(&self) -> Option<&VisualCustomActionDefaults>
pub fn custom_action_defaults(&self) -> Option<&VisualCustomActionDefaults>
A list of visual custom actions for the sheet.
Source§impl SheetDefinition
impl SheetDefinition
Sourcepub fn builder() -> SheetDefinitionBuilder
pub fn builder() -> SheetDefinitionBuilder
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§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SheetDefinition
impl Debug for SheetDefinition
Source§impl PartialEq for SheetDefinition
impl PartialEq for SheetDefinition
impl StructuralPartialEq for SheetDefinition
Auto Trait Implementations§
impl Freeze for SheetDefinition
impl RefUnwindSafe for SheetDefinition
impl Send for SheetDefinition
impl Sync for SheetDefinition
impl Unpin for SheetDefinition
impl UnwindSafe for SheetDefinition
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);