pub struct ScaleDiscrete { /* private fields */ }Expand description
Discrete scale: maps categorical values to evenly-spaced positions.
Implementations§
Source§impl ScaleDiscrete
impl ScaleDiscrete
pub fn new() -> Self
pub fn for_aesthetic(self, aes: Aesthetic) -> Self
pub fn with_name(self, name: &str) -> Self
Sourcepub fn with_labels(self, labels: Vec<String>) -> Self
pub fn with_labels(self, labels: Vec<String>) -> Self
Set custom display labels for each level. Must match the number of levels.
Sourcepub fn with_limits(self, limits: Vec<&str>) -> Self
pub fn with_limits(self, limits: Vec<&str>) -> Self
Set level order and filter. Only these levels are shown, in this order. Data values not in limits are mapped to the middle (0.5).
Trait Implementations§
Source§impl Clone for ScaleDiscrete
impl Clone for ScaleDiscrete
Source§impl Debug for ScaleDiscrete
impl Debug for ScaleDiscrete
Source§impl Default for ScaleDiscrete
impl Default for ScaleDiscrete
Source§impl Scale for ScaleDiscrete
impl Scale for ScaleDiscrete
Source§fn map(&self, value: &Value) -> f64
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 is_discrete(&self) -> bool
fn is_discrete(&self) -> bool
Whether this is a discrete scale.
Source§fn reset_training(&mut self)
fn reset_training(&mut self)
Reset training state so the scale can be retrained on new data.
Source§fn map_to_color(&self, _value: &Value) -> Option<(u8, u8, u8)>
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>
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>
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>
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>
fn map_to_alpha(&self, _value: &Value) -> Option<f64>
Map a data value to an alpha (opacity) value. Default returns None.
Source§fn set_default_locale(&mut self, _locale: &Locale)
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>
fn locale(&self) -> Option<&Locale>
The locale this scale’s default labels are rendered with, if any.
Source§fn set_limits(&mut self, _min: f64, _max: f64)
fn set_limits(&mut self, _min: f64, _max: f64)
Override the trained domain limits (used by coord_cartesian zoom).
Source§fn filter_limits(&self) -> Option<(f64, f64)>
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)>
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 expanded_domain(&self) -> Option<(f64, f64)>
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 axis_position_opposite(&self) -> bool
fn axis_position_opposite(&self) -> bool
Whether this axis is drawn on the opposite side (x → top, y → right).
Source§fn set_expand(&mut self, _mult: f64, _add: f64)
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 map_fraction_to_size(&self, _fraction: f64) -> Option<f64>
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 validate(&self, _warnings: &mut Vec<String>)
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§
impl Freeze for ScaleDiscrete
impl RefUnwindSafe for ScaleDiscrete
impl Send for ScaleDiscrete
impl Sync for ScaleDiscrete
impl Unpin for ScaleDiscrete
impl UnsafeUnpin for ScaleDiscrete
impl UnwindSafe for ScaleDiscrete
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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