Skip to main content

LinearGauge

Struct LinearGauge 

Source
pub struct LinearGauge { /* private fields */ }
Expand description

Horizontal meter with optional threshold bands and labels.

Differs from ProgressBar in three ways: threshold zones drive the fill colour (success / warning / danger), faint bands paint behind the fill at zone boundaries, and a thumb marker pins the current position over the bar. Threshold ticks and labels above the bar are opt-in via LinearGauge::threshold_label or LinearGauge::show_zone_labels.

ui.add(
    LinearGauge::new(0.42)
        .zones(GaugeZones::new(0.6, 0.85))
        .show_zone_labels(),
);

Implementations§

Source§

impl LinearGauge

Source

pub fn new(fraction: f32) -> Self

Create a meter at fraction (0..=1). NaN and out-of-range values are clamped.

Source

pub fn height(self, height: f32) -> Self

Bar height in points. Default: 14.

Source

pub fn desired_width(self, width: f32) -> Self

Override the bar width. Defaults to ui.available_width().

Source

pub fn color(self, color: Color32) -> Self

Override the fill colour.

Source

pub fn zones(self, zones: GaugeZones) -> Self

Configure threshold zones. Faint bands paint behind the fill at the boundaries and the fill colour auto-derives from the active zone (success / warning / danger).

Source

pub fn threshold_label(self, position: f32, label: impl Into<String>) -> Self

Add a tick + label above the bar at position (0..=1). Stack multiple calls to register more.

Source

pub fn show_zone_labels(self) -> Self

Convenience: add ticks + labels at the configured zone boundaries, formatting each as a percent. Has no effect unless zones is also set.

Source

pub fn thumb(self, on: bool) -> Self

Whether to draw the thumb marker at the current position. Default: on.

Trait Implementations§

Source§

impl Clone for LinearGauge

Source§

fn clone(&self) -> LinearGauge

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinearGauge

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Widget for LinearGauge

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,