Skip to main content

ScaleContinuous

Struct ScaleContinuous 

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

Continuous linear scale.

Implementations§

Source§

impl ScaleContinuous

Source

pub fn new() -> Self

Source

pub fn for_aesthetic(self, aes: Aesthetic) -> Self

Source

pub fn with_name(self, name: &str) -> Self

Source

pub fn with_limits(self, min: f64, max: f64) -> Self

Source

pub fn with_transform(self, transform: ScaleTransform) -> Self

Source

pub fn with_breaks(self, breaks: Vec<f64>) -> Self

Set custom break positions (data values where ticks appear).

Source

pub fn with_labels(self, labels: Vec<String>) -> Self

Set custom labels for breaks. Must match the number of breaks.

Source

pub fn with_localized_labels<F>(self, f: F) -> Self
where F: Fn(Option<&Locale>) -> Vec<String> + Send + Sync + 'static,

Labels for the custom breaks that depend on the locale (month or weekday names): f gets the scale’s locale — the plot’s GGPlot::locale unless set on the scale — or None. Takes precedence over with_labels.

Source

pub fn with_expand(self, mult: f64, add: f64) -> Self

Set the expansion multiplier and additive constant. Like R’s expand = c(mult, add), applied symmetrically. Default (0.05, 0.0).

Source

pub fn with_expand_sides( self, mult_lower: f64, add_lower: f64, mult_upper: f64, add_upper: f64, ) -> Self

Per-side expansion (R’s expansion(mult = c(l, u), add = c(l, u))): separate multiplicative/additive expansion for the lower and upper ends.

Source

pub fn with_position_opposite(self) -> Self

Place this axis on the opposite side (x → top, y → right).

Source

pub fn with_label_formatter<F>(self, f: F) -> Self
where F: Fn(f64) -> String + Send + Sync + 'static,

Set a label formatter. Accepts a plain fn (e.g. label_comma) or a configurable formatter such as label_si() / label_number(...).

Source

pub fn with_value_formatter<F>(self, f: F) -> Self
where F: Fn(f64) -> String + Send + Sync + 'static,

Set a formatter for format_value — a per-mark data-fvalue or tooltip-template value — distinct from with_label_formatter, which only affects axis break labels. Falls back to the label formatter, then the locale default, when unset.

Source

pub fn with_locale(self, locale: Locale) -> Self

Render the default break labels with locale’s decimal and thousands marks (1.000, 2,5 in de-DE). Overrides the plot locale (GGPlot::locale); a custom with_label_formatter still wins.

Source

pub fn with_sec_axis(self, sec: SecAxis) -> Self

Add a secondary axis with a transformation function.

Source

pub fn sec_axis(&self) -> Option<&SecAxis>

Get the secondary axis, if any.

Source

pub fn is_opposite(&self) -> bool

Whether this axis should be drawn on the opposite side (x → top, y → right).

Trait Implementations§

Source§

impl Clone for ScaleContinuous

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 Default for ScaleContinuous

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Scale for ScaleContinuous

Source§

fn set_default_locale(&mut self, locale: &Locale)

Adopt a plot-level default Locale for the default break labels (number marks, month names, date formats), unless the scale already has its own. Called by the plot builder when GGPlot::locale is set. Default: ignored (scales without numeric/date labels).
Source§

fn locale(&self) -> Option<&Locale>

The locale this scale’s default labels are rendered with, if any.
Source§

fn format_value(&self, value: &Value) -> Option<String>

Format a single raw (pre-scale-transform) data value for a per-mark attribute (data-fvalue/data-fx, B2-4) or a tooltip template placeholder — e.g. a de-DE currency string, or a datetime x’s ISO/locale date, independent of how the axis itself abbreviates its break labels. None for a missing/non-finite value, or a scale with nothing meaningful to format (default: every scale except continuous position/size/linewidth and datetime/colour-continuous, which override this).
Source§

fn aesthetic(&self) -> Aesthetic

Which aesthetic this scale is for.
Source§

fn train(&mut self, values: &[Value])

Incorporate data values to determine domain.
Source§

fn map(&self, value: &Value) -> f64

Map a data value to a [0, 1] normalized position (position scales) or to a concrete visual value index (color/size scales).
Source§

fn expanded_domain(&self) -> Option<(f64, f64)>

The data values at the panel edges (normalized 0 and 1) for a trained continuous position scale — the limits after expansion, in the scale’s transformed space. None for discrete / untrained / non-position scales.
Source§

fn breaks(&self) -> Vec<(f64, String)>

Generate break positions and labels for axis/legend.
Source§

fn name(&self) -> &str

Human-readable name (axis title).
Source§

fn set_name(&mut self, name: &str)

Set the scale name.
Source§

fn transform(&self, value: &Value) -> Value

Apply transformation to raw data (e.g., log10).
Source§

fn sec_axis(&self) -> Option<&SecAxis>

Get the secondary axis specification, if any.
Source§

fn set_limits(&mut self, min: f64, max: f64)

Override the trained domain limits (used by coord_cartesian zoom).
Source§

fn set_expand(&mut self, mult: f64, add: f64)

Set the expansion multiplier/additive constant (R’s expand = c(mult, add)), applied symmetrically to both ends. Used by CoordSf::train_scales (expand(false) passes (0.0, 0.0)) to pin an explicit xlim/ylim to the panel exactly. Default: no-op (discrete / non-position scales have no expansion to set).
Source§

fn filter_limits(&self) -> Option<(f64, f64)>

Return OOB filter limits if this scale was created with explicit limits (e.g., via xlim/ylim). Data outside these limits should be removed before stats.
Source§

fn domain(&self) -> Option<(f64, f64)>

Return the trained data domain (min, max) for continuous scales. Used by the colorbar legend to pass data-space values to map_to_color().
Source§

fn axis_position_opposite(&self) -> bool

Whether this axis is drawn on the opposite side (x → top, y → right).
Source§

fn clone_box(&self) -> Box<dyn Scale>

Clone this scale into a boxed trait object.
Source§

fn reset_training(&mut self)

Reset training state so the scale can be retrained on new data.
Source§

fn is_discrete(&self) -> bool

Whether this is a discrete scale.
Source§

fn map_to_color(&self, _value: &Value) -> Option<(u8, u8, u8)>

Map a data value to an RGB color. Default returns None.
Source§

fn map_to_shape(&self, _value: &Value) -> Option<PointShape>

Map a data value to a point shape. Default returns None.
Source§

fn map_to_linetype(&self, _value: &Value) -> Option<Linetype>

Map a data value to a linetype. Default returns None.
Source§

fn map_to_size(&self, _value: &Value) -> Option<f64>

Map a data value to a point size (radius in pixels). Default returns None.
Source§

fn map_to_alpha(&self, _value: &Value) -> Option<f64>

Map a data value to an alpha (opacity) value. Default returns None.
Source§

fn map_fraction_to_size(&self, _fraction: f64) -> Option<f64>

Map an already-computed [0, 1] scale fraction (as returned alongside each label by breaks) directly to an output size, bypassing the round trip through map — a discrete-style legend key only has the break’s rendered label, not its original data value, so a continuous scale can’t recover the fraction by re-mapping the label text. Default: None.
Source§

fn map_fraction_to_alpha(&self, _fraction: f64) -> Option<f64>

Map an already-computed [0, 1] scale fraction directly to an output alpha (opacity), the map_fraction_to_size equivalent for a continuous alpha scale’s discrete-style legend keys — see that method’s doc for why the fraction, not the label, is the input. Default: None.
Source§

fn validate(&self, _warnings: &mut Vec<String>)

Validate this scale’s configuration once training is complete (e.g. a transform undefined at the domain’s own limits) and push a human-readable warning for each problem found. Called once per scale after the final training pass, with the plot’s warnings sink — map/map_to_size run per mark at draw time and have no such access, so a scale-level problem must be reported here instead. Default: no-op.

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V