Skip to main content

ContourLabelConfig

Struct ContourLabelConfig 

Source
pub struct ContourLabelConfig {
    pub visible: bool,
    pub font_size: f32,
    pub color: Color,
    pub format: LabelFormat,
    pub significant_digits: u8,
    pub spacing_px: f32,
    pub anchors: Vec<ContourLabelAnchor>,
    pub bg_color: Option<Color>,
    pub bg_padding_px: f32,
}
Expand description

Inline level labels on contour lines.

Fields§

§visible: bool§font_size: f32§color: Color

Text colour, independent of the contour stroke and any per-level ramp colours. Labels are annotations; changing a line palette must not make their typography unreadable.

§format: LabelFormat§significant_digits: u8§spacing_px: f32

Target minimum screen distance between labels selected by the normal automatic sweep. Must be finite and greater than zero even when labels are hidden or explicit anchors override automatic placement.

Read by the anchor pass, which seeds a lattice at this pitch over the data area, projects each seed onto its level’s isoline, and keeps the ones that stay this far apart. A per-level fallback may keep a closer candidate rather than omit that level. Labels are not arc-length-even: the seed lattice is even, the curve is not. Ignored when the resolved override is non-empty.

§anchors: Vec<ContourLabelAnchor>

Where the labels go — an override.

Empty is the normal case: the GPU projects a seed lattice onto each level’s isoline and selects a separated subset. For an explicit list, the renderer removes anchors whose level_index is outside levels, keeps at most 1024 in input order, and uses that resolved list as the override. If resolution leaves it empty, automatic placement remains active. Automatic and explicit placement share the same 1024-label draw capacity. Either way the same anchor record reaches the same draw.

§bg_color: Option<Color>

Fill painted behind the text, so a label over a line stays readable.

None draws the text alone. This is a property of the label, not of the chart — which is why it can live here at all: the renderer composites the chrome over the data and does not know what colour is behind it, but the label knows what it wants behind itself.

§bg_padding_px: f32

Space around the text. This pads bg_color when one is present and is also the contour-line gap around a transparent label.

Implementations§

Source§

impl ContourLabelConfig

Source

pub const INVALID_SPACING_REASON: &'static str = "contour label spacing_px must be finite and greater than zero"

Source

pub fn validate(&self) -> Result<(), &'static str>

Validate invariants owned by the label configuration itself.

Trait Implementations§

Source§

impl Clone for ContourLabelConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContourLabelConfig

Source§

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

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

impl<'de> Deserialize<'de> for ContourLabelConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ContourLabelConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ContourLabelConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ContourLabelConfig

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.