#[non_exhaustive]pub struct CustomContentVisualBuilder { /* private fields */ }
Expand description
A builder for CustomContentVisual
.
Implementations§
Source§impl CustomContentVisualBuilder
impl CustomContentVisualBuilder
Sourcepub fn visual_id(self, input: impl Into<String>) -> Self
pub fn visual_id(self, input: impl Into<String>) -> Self
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
This field is required.Sourcepub fn set_visual_id(self, input: Option<String>) -> Self
pub fn set_visual_id(self, input: Option<String>) -> Self
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
Sourcepub fn get_visual_id(&self) -> &Option<String>
pub fn get_visual_id(&self) -> &Option<String>
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
Sourcepub fn title(self, input: VisualTitleLabelOptions) -> Self
pub fn title(self, input: VisualTitleLabelOptions) -> Self
The title that is displayed on the visual.
Sourcepub fn set_title(self, input: Option<VisualTitleLabelOptions>) -> Self
pub fn set_title(self, input: Option<VisualTitleLabelOptions>) -> Self
The title that is displayed on the visual.
Sourcepub fn get_title(&self) -> &Option<VisualTitleLabelOptions>
pub fn get_title(&self) -> &Option<VisualTitleLabelOptions>
The title that is displayed on the visual.
Sourcepub fn subtitle(self, input: VisualSubtitleLabelOptions) -> Self
pub fn subtitle(self, input: VisualSubtitleLabelOptions) -> Self
The subtitle that is displayed on the visual.
Sourcepub fn set_subtitle(self, input: Option<VisualSubtitleLabelOptions>) -> Self
pub fn set_subtitle(self, input: Option<VisualSubtitleLabelOptions>) -> Self
The subtitle that is displayed on the visual.
Sourcepub fn get_subtitle(&self) -> &Option<VisualSubtitleLabelOptions>
pub fn get_subtitle(&self) -> &Option<VisualSubtitleLabelOptions>
The subtitle that is displayed on the visual.
Sourcepub fn chart_configuration(self, input: CustomContentConfiguration) -> Self
pub fn chart_configuration(self, input: CustomContentConfiguration) -> Self
The configuration of a CustomContentVisual
.
Sourcepub fn set_chart_configuration(
self,
input: Option<CustomContentConfiguration>,
) -> Self
pub fn set_chart_configuration( self, input: Option<CustomContentConfiguration>, ) -> Self
The configuration of a CustomContentVisual
.
Sourcepub fn get_chart_configuration(&self) -> &Option<CustomContentConfiguration>
pub fn get_chart_configuration(&self) -> &Option<CustomContentConfiguration>
The configuration of a CustomContentVisual
.
Sourcepub fn actions(self, input: VisualCustomAction) -> Self
pub fn actions(self, input: VisualCustomAction) -> Self
Appends an item to actions
.
To override the contents of this collection use set_actions
.
The list of custom actions that are configured for a visual.
Sourcepub fn set_actions(self, input: Option<Vec<VisualCustomAction>>) -> Self
pub fn set_actions(self, input: Option<Vec<VisualCustomAction>>) -> Self
The list of custom actions that are configured for a visual.
Sourcepub fn get_actions(&self) -> &Option<Vec<VisualCustomAction>>
pub fn get_actions(&self) -> &Option<Vec<VisualCustomAction>>
The list of custom actions that are configured for a visual.
Sourcepub fn data_set_identifier(self, input: impl Into<String>) -> Self
pub fn data_set_identifier(self, input: impl Into<String>) -> Self
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
This field is required.Sourcepub fn set_data_set_identifier(self, input: Option<String>) -> Self
pub fn set_data_set_identifier(self, input: Option<String>) -> Self
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
Sourcepub fn get_data_set_identifier(&self) -> &Option<String>
pub fn get_data_set_identifier(&self) -> &Option<String>
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
Sourcepub fn visual_content_alt_text(self, input: impl Into<String>) -> Self
pub fn visual_content_alt_text(self, input: impl Into<String>) -> Self
The alt text for the visual.
Sourcepub fn set_visual_content_alt_text(self, input: Option<String>) -> Self
pub fn set_visual_content_alt_text(self, input: Option<String>) -> Self
The alt text for the visual.
Sourcepub fn get_visual_content_alt_text(&self) -> &Option<String>
pub fn get_visual_content_alt_text(&self) -> &Option<String>
The alt text for the visual.
Sourcepub fn build(self) -> Result<CustomContentVisual, BuildError>
pub fn build(self) -> Result<CustomContentVisual, BuildError>
Consumes the builder and constructs a CustomContentVisual
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CustomContentVisualBuilder
impl Clone for CustomContentVisualBuilder
Source§fn clone(&self) -> CustomContentVisualBuilder
fn clone(&self) -> CustomContentVisualBuilder
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 CustomContentVisualBuilder
impl Debug for CustomContentVisualBuilder
Source§impl Default for CustomContentVisualBuilder
impl Default for CustomContentVisualBuilder
Source§fn default() -> CustomContentVisualBuilder
fn default() -> CustomContentVisualBuilder
Source§impl PartialEq for CustomContentVisualBuilder
impl PartialEq for CustomContentVisualBuilder
Source§fn eq(&self, other: &CustomContentVisualBuilder) -> bool
fn eq(&self, other: &CustomContentVisualBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CustomContentVisualBuilder
Auto Trait Implementations§
impl Freeze for CustomContentVisualBuilder
impl RefUnwindSafe for CustomContentVisualBuilder
impl Send for CustomContentVisualBuilder
impl Sync for CustomContentVisualBuilder
impl Unpin for CustomContentVisualBuilder
impl UnwindSafe for CustomContentVisualBuilder
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);