#[non_exhaustive]pub struct ParameterControl {
pub date_time_picker: Option<ParameterDateTimePickerControl>,
pub list: Option<ParameterListControl>,
pub dropdown: Option<ParameterDropDownControl>,
pub text_field: Option<ParameterTextFieldControl>,
pub text_area: Option<ParameterTextAreaControl>,
pub slider: Option<ParameterSliderControl>,
}
Expand description
The control of a parameter that users can interact with in a dashboard or an analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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.date_time_picker: Option<ParameterDateTimePickerControl>
A control from a date parameter that specifies date and time.
list: Option<ParameterListControl>
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
dropdown: Option<ParameterDropDownControl>
A control to display a dropdown list with buttons that are used to select a single value.
text_field: Option<ParameterTextFieldControl>
A control to display a text box that is used to enter a single entry.
text_area: Option<ParameterTextAreaControl>
A control to display a text box that is used to enter multiple entries.
slider: Option<ParameterSliderControl>
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
Implementations§
Source§impl ParameterControl
impl ParameterControl
Sourcepub fn date_time_picker(&self) -> Option<&ParameterDateTimePickerControl>
pub fn date_time_picker(&self) -> Option<&ParameterDateTimePickerControl>
A control from a date parameter that specifies date and time.
Sourcepub fn list(&self) -> Option<&ParameterListControl>
pub fn list(&self) -> Option<&ParameterListControl>
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
Sourcepub fn dropdown(&self) -> Option<&ParameterDropDownControl>
pub fn dropdown(&self) -> Option<&ParameterDropDownControl>
A control to display a dropdown list with buttons that are used to select a single value.
Sourcepub fn text_field(&self) -> Option<&ParameterTextFieldControl>
pub fn text_field(&self) -> Option<&ParameterTextFieldControl>
A control to display a text box that is used to enter a single entry.
Sourcepub fn text_area(&self) -> Option<&ParameterTextAreaControl>
pub fn text_area(&self) -> Option<&ParameterTextAreaControl>
A control to display a text box that is used to enter multiple entries.
Sourcepub fn slider(&self) -> Option<&ParameterSliderControl>
pub fn slider(&self) -> Option<&ParameterSliderControl>
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
Source§impl ParameterControl
impl ParameterControl
Sourcepub fn builder() -> ParameterControlBuilder
pub fn builder() -> ParameterControlBuilder
Creates a new builder-style object to manufacture ParameterControl
.
Trait Implementations§
Source§impl Clone for ParameterControl
impl Clone for ParameterControl
Source§fn clone(&self) -> ParameterControl
fn clone(&self) -> ParameterControl
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 ParameterControl
impl Debug for ParameterControl
Source§impl PartialEq for ParameterControl
impl PartialEq for ParameterControl
impl StructuralPartialEq for ParameterControl
Auto Trait Implementations§
impl Freeze for ParameterControl
impl RefUnwindSafe for ParameterControl
impl Send for ParameterControl
impl Sync for ParameterControl
impl Unpin for ParameterControl
impl UnwindSafe for ParameterControl
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);