#[non_exhaustive]pub struct SheetDefinitionBuilder { /* private fields */ }
Expand description
A builder for SheetDefinition
.
Implementations§
Source§impl SheetDefinitionBuilder
impl SheetDefinitionBuilder
Sourcepub fn sheet_id(self, input: impl Into<String>) -> Self
pub fn sheet_id(self, input: impl Into<String>) -> Self
The unique identifier of a sheet.
This field is required.Sourcepub fn set_sheet_id(self, input: Option<String>) -> Self
pub fn set_sheet_id(self, input: Option<String>) -> Self
The unique identifier of a sheet.
Sourcepub fn get_sheet_id(&self) -> &Option<String>
pub fn get_sheet_id(&self) -> &Option<String>
The unique identifier of a sheet.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the sheet.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the sheet.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the sheet.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Sourcepub fn parameter_controls(self, input: ParameterControl) -> Self
pub fn parameter_controls(self, input: ParameterControl) -> Self
Appends an item to parameter_controls
.
To override the contents of this collection use set_parameter_controls
.
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 set_parameter_controls(
self,
input: Option<Vec<ParameterControl>>,
) -> Self
pub fn set_parameter_controls( self, input: Option<Vec<ParameterControl>>, ) -> Self
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 get_parameter_controls(&self) -> &Option<Vec<ParameterControl>>
pub fn get_parameter_controls(&self) -> &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.
Sourcepub fn filter_controls(self, input: FilterControl) -> Self
pub fn filter_controls(self, input: FilterControl) -> Self
Appends an item to filter_controls
.
To override the contents of this collection use set_filter_controls
.
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 set_filter_controls(self, input: Option<Vec<FilterControl>>) -> Self
pub fn set_filter_controls(self, input: Option<Vec<FilterControl>>) -> Self
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 get_filter_controls(&self) -> &Option<Vec<FilterControl>>
pub fn get_filter_controls(&self) -> &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.
Sourcepub fn visuals(self, input: Visual) -> Self
pub fn visuals(self, input: Visual) -> Self
Appends an item to visuals
.
To override the contents of this collection use set_visuals
.
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
Sourcepub fn set_visuals(self, input: Option<Vec<Visual>>) -> Self
pub fn set_visuals(self, input: Option<Vec<Visual>>) -> Self
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
Sourcepub fn get_visuals(&self) -> &Option<Vec<Visual>>
pub fn get_visuals(&self) -> &Option<Vec<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, input: SheetTextBox) -> Self
pub fn text_boxes(self, input: SheetTextBox) -> Self
Appends an item to text_boxes
.
To override the contents of this collection use set_text_boxes
.
The text boxes that are on a sheet.
Sourcepub fn set_text_boxes(self, input: Option<Vec<SheetTextBox>>) -> Self
pub fn set_text_boxes(self, input: Option<Vec<SheetTextBox>>) -> Self
The text boxes that are on a sheet.
Sourcepub fn get_text_boxes(&self) -> &Option<Vec<SheetTextBox>>
pub fn get_text_boxes(&self) -> &Option<Vec<SheetTextBox>>
The text boxes that are on a sheet.
Sourcepub fn images(self, input: SheetImage) -> Self
pub fn images(self, input: SheetImage) -> Self
Appends an item to images
.
To override the contents of this collection use set_images
.
A list of images on a sheet.
Sourcepub fn set_images(self, input: Option<Vec<SheetImage>>) -> Self
pub fn set_images(self, input: Option<Vec<SheetImage>>) -> Self
A list of images on a sheet.
Sourcepub fn get_images(&self) -> &Option<Vec<SheetImage>>
pub fn get_images(&self) -> &Option<Vec<SheetImage>>
A list of images on a sheet.
Sourcepub fn layouts(self, input: Layout) -> Self
pub fn layouts(self, input: Layout) -> Self
Appends an item to layouts
.
To override the contents of this collection use set_layouts
.
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 set_layouts(self, input: Option<Vec<Layout>>) -> Self
pub fn set_layouts(self, input: Option<Vec<Layout>>) -> Self
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 get_layouts(&self) -> &Option<Vec<Layout>>
pub fn get_layouts(&self) -> &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.
Sourcepub fn sheet_control_layouts(self, input: SheetControlLayout) -> Self
pub fn sheet_control_layouts(self, input: SheetControlLayout) -> Self
Appends an item to sheet_control_layouts
.
To override the contents of this collection use set_sheet_control_layouts
.
The control layouts of the sheet.
Sourcepub fn set_sheet_control_layouts(
self,
input: Option<Vec<SheetControlLayout>>,
) -> Self
pub fn set_sheet_control_layouts( self, input: Option<Vec<SheetControlLayout>>, ) -> Self
The control layouts of the sheet.
Sourcepub fn get_sheet_control_layouts(&self) -> &Option<Vec<SheetControlLayout>>
pub fn get_sheet_control_layouts(&self) -> &Option<Vec<SheetControlLayout>>
The control layouts of the sheet.
Sourcepub fn content_type(self, input: SheetContentType) -> Self
pub fn content_type(self, input: SheetContentType) -> Self
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 set_content_type(self, input: Option<SheetContentType>) -> Self
pub fn set_content_type(self, input: Option<SheetContentType>) -> Self
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 get_content_type(&self) -> &Option<SheetContentType>
pub fn get_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, input: VisualCustomActionDefaults) -> Self
pub fn custom_action_defaults(self, input: VisualCustomActionDefaults) -> Self
A list of visual custom actions for the sheet.
Sourcepub fn set_custom_action_defaults(
self,
input: Option<VisualCustomActionDefaults>,
) -> Self
pub fn set_custom_action_defaults( self, input: Option<VisualCustomActionDefaults>, ) -> Self
A list of visual custom actions for the sheet.
Sourcepub fn get_custom_action_defaults(&self) -> &Option<VisualCustomActionDefaults>
pub fn get_custom_action_defaults(&self) -> &Option<VisualCustomActionDefaults>
A list of visual custom actions for the sheet.
Sourcepub fn build(self) -> Result<SheetDefinition, BuildError>
pub fn build(self) -> Result<SheetDefinition, BuildError>
Consumes the builder and constructs a SheetDefinition
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for SheetDefinitionBuilder
impl Clone for SheetDefinitionBuilder
Source§fn clone(&self) -> SheetDefinitionBuilder
fn clone(&self) -> SheetDefinitionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SheetDefinitionBuilder
impl Debug for SheetDefinitionBuilder
Source§impl Default for SheetDefinitionBuilder
impl Default for SheetDefinitionBuilder
Source§fn default() -> SheetDefinitionBuilder
fn default() -> SheetDefinitionBuilder
Source§impl PartialEq for SheetDefinitionBuilder
impl PartialEq for SheetDefinitionBuilder
impl StructuralPartialEq for SheetDefinitionBuilder
Auto Trait Implementations§
impl Freeze for SheetDefinitionBuilder
impl RefUnwindSafe for SheetDefinitionBuilder
impl Send for SheetDefinitionBuilder
impl Sync for SheetDefinitionBuilder
impl Unpin for SheetDefinitionBuilder
impl UnwindSafe for SheetDefinitionBuilder
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);