Struct TickLabels 

#[non_exhaustive]
pub struct TickLabels<XY: Tick> {
    pub min_chars: RwSignal<usize>,
    pub format: RwSignal<Arc<dyn Fn(&XY, &dyn Format<Tick = XY>) -> String + Send + Sync>>,
    pub generator: RwSignal<Arc<dyn TickGen<Tick = XY> + Send + Sync>>,
}

Builds tick labels for an axis.

Note that ticks lack an identity resulting in generators and labels not being reactive.

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.

min_chars: RwSignal<usize>

Minimum number of characters to display for each tick label.

Helpful for giving a fixed width to labels e.g., if your graph can display 0-100 then it might show a shorter label on “0” or “42” to “100”. Needed to have the same inner chart ratio when using an outer chart ratio. Can also be useful for aligning a list of charts.

format: RwSignal<Arc<dyn Fn(&XY, &dyn Format<Tick = XY>) -> String + Send + Sync>>

Format function for the tick labels. See TickLabels::with_format for details.

generator: RwSignal<Arc<dyn TickGen<Tick = XY> + Send + Sync>>

Tick generator for the labels.

Implementations

impl TickLabels<f64>

pub fn aligned_floats() -> Self

Creates a new tick label generator for floating point numbers. See AlignedFloats for details.

impl<Tz> TickLabels<DateTime<Tz>>

where Tz: TimeZone + Send + Sync + 'static, Tz::Offset: Display + Send + Sync,

pub fn timestamps() -> Self

Creates a new tick label generator for timestamps. See Timestamps for details.

impl<XY: Tick> TickLabels<XY>

pub fn from_generator(gen: impl TickGen<Tick = XY> + 'static) -> Self

Creates a new tick label generator from a tick generator. Use AlignedFloats or Timestamps for available generators.

pub fn with_min_chars(self, min_chars: usize) -> Self

Sets the minimum number of characters to display for each tick label.

pub fn with_format( self, format: impl Fn(&XY, &dyn TickFormat<Tick = XY>) -> String + Send + Sync + 'static, ) -> Self

Sets the format function for the tick labels.

This is a function that takes a Tick and a formatter and returns a String. It gives an opportunity to customise tick label format. The formatter is the resulting state of the tick generator and does the default aciton. For example if aligned floats decides to use “1000s” then the formatter will use that.

Trait Implementations

impl<XY: Tick> Clone for TickLabels<XY>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<XY: Debug + Tick> Debug for TickLabels<XY>

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

Formats the value using the given formatter.

impl<XY: Tick> Default for TickLabels<XY>

fn default() -> Self

Returns the “default value” for a type.

impl<Gen, XY> From<Gen> for TickLabels<XY>

where Gen: TickGen<Tick = XY> + 'static, XY: Tick,

fn from(gen: Gen) -> Self

Converts to this type from the input type.

impl<XY: Tick> From<TickLabels<XY>> for EdgeLayout<XY>

fn from(inner: TickLabels<XY>) -> Self

Converts to this type from the input type.

impl<XY: Tick> From<TickLabels<XY>> for Vec<EdgeLayout<XY>>

fn from(inner: TickLabels<XY>) -> Self

Converts to this type from the input type.

impl<XY: Tick> IntoEdge<XY> for TickLabels<XY>

fn into_edge(self) -> EdgeLayout<XY>

Create an edge layout from the type. See IntoEdge for details.

impl<XY: PartialEq + Tick> PartialEq for TickLabels<XY>

fn eq(&self, other: &TickLabels<XY>) -> 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<XY: PartialEq + Tick> StructuralPartialEq for TickLabels<XY>