Skip to main content

RepelParams

Struct RepelParams 

Source
pub struct RepelParams {
Show 16 fields pub box_padding: f64, pub point_padding: f64, pub point_size: f64, pub nudge_x: f64, pub nudge_y: f64, pub force: f64, pub force_pull: f64, pub max_iter: usize, pub max_time: Duration, pub max_overlaps: usize, pub min_segment_length: f64, pub seed: u64, pub direction: RepelDirection, pub max_labels: usize, pub segment_color: Option<(u8, u8, u8)>, pub segment_width: f64,
}
Expand description

Shared layout parameters of GeomTextRepel / GeomLabelRepel.

Fields§

§box_padding: f64

Padding (px) around each label’s box when testing for overlaps (ggrepel box.padding).

§point_padding: f64

Padding (px) around each data point (ggrepel point.padding); also the gap left between a segment and its point.

§point_size: f64

Radius (px) of the data points labels must avoid (match the point layer’s size; GeomPoint’s default is 3).

§nudge_x: f64

Horizontal nudge of the starting position, in data units (numeric x).

§nudge_y: f64

Vertical nudge of the starting position, in data units (numeric y).

§force: f64

Strength of the repulsion between overlapping boxes.

§force_pull: f64

Strength of the spring pulling a label back to its point.

§max_iter: usize

Maximum relaxation iterations.

§max_time: Duration

Wall-clock bound for the relaxation (a safety net — the layout is deterministic as long as it converges or hits max_iter first). Ignored on wasm32, which has no monotonic clock.

§max_overlaps: usize

Drop labels that still overlap more than this many other labels or points after the layout (ggrepel max.overlaps, default 10).

§min_segment_length: f64

Draw a segment when the label box is farther than this (px) from its point (ggrepel min.segment.length).

§seed: u64

Seed of the tie-breaking jitter; equal seeds give equal layouts.

§direction: RepelDirection

Movement axis.

§max_labels: usize

Above this many labels the force layout is skipped (it is O(n²) in the worst case) and labels are placed greedily, dropping overlaps.

§segment_color: Option<(u8, u8, u8)>

Segment colour; None = the label’s text colour.

§segment_width: f64

Segment width (px).

Trait Implementations§

Source§

impl Clone for RepelParams

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 RepelParams

Source§

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

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

impl Default for RepelParams

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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