Struct WidgetConditionalFormat

#[non_exhaustive]
pub struct WidgetConditionalFormat {
    pub comparator: WidgetComparator,
    pub custom_bg_color: Option<String>,
    pub custom_fg_color: Option<String>,
    pub hide_value: Option<bool>,
    pub image_url: Option<String>,
    pub metric: Option<String>,
    pub palette: WidgetPalette,
    pub timeframe: Option<String>,
    pub value: f64,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

Define a conditional format for the widget.

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.

comparator: WidgetComparator

Comparator to apply.

custom_bg_color: Option<String>

Color palette to apply to the background, same values available as palette.

custom_fg_color: Option<String>

Color palette to apply to the foreground, same values available as palette.

hide_value: Option<bool>

True hides values.

image_url: Option<String>

Displays an image as the background.

metric: Option<String>

Metric from the request to correlate this conditional format with.

palette: WidgetPalette

Color palette to apply.

timeframe: Option<String>

Defines the displayed timeframe.

value: f64

Value for the comparator.

additional_properties: BTreeMap<String, Value>

Implementations

impl WidgetConditionalFormat

pub fn new( comparator: WidgetComparator, palette: WidgetPalette, value: f64, ) -> WidgetConditionalFormat

pub fn custom_bg_color(self, value: String) -> Self

pub fn custom_fg_color(self, value: String) -> Self

pub fn hide_value(self, value: bool) -> Self

pub fn image_url(self, value: String) -> Self

pub fn metric(self, value: String) -> Self

pub fn timeframe(self, value: String) -> Self

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for WidgetConditionalFormat

fn clone(&self) -> WidgetConditionalFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetConditionalFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetConditionalFormat

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WidgetConditionalFormat

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for WidgetConditionalFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WidgetConditionalFormat