Struct Settings

Source

pub struct Settings<T> {
    pub theta: T,
    pub ka: T,
    pub kg: T,
    pub kr: T,
    pub lin_log: bool,
    pub prevent_overlapping: Option<T>,
    pub speed: T,
    pub strong_gravity: bool,
}

Expand description

Settings for the graph layout

Fields§

§theta: T

Precision setting for Barnes-Hut computation

Must be in (0.0..1.0). 0.0 is accurate and slow, 1.0 is unaccurate and fast. Default is 0.5.

§ka: T

Attraction coefficient

§kg: T

Gravity coefficient

§kr: T

Repulsion coefficient

§lin_log: bool

Logarithmic attraction

§prevent_overlapping: Option<T>

Prevent node overlapping for a prettier graph.

Value is kr_prime. Requires layout.sizes to be Some. kr_prime is arbitrarily set to 100.0 in Gephi implementation.

§speed: T

Speed factor

§strong_gravity: bool

Gravity does not decrease with distance, resulting in a more compact graph.

Implementations§

Source §

impl<T: Coord> Settings<T>

Source

pub fn check(&self) -> bool

Check whether the settings are valid

Trait Implementations§

Source §

impl<T: Clone> Clone for Settings<T>

Source §

fn clone(&self) -> Settings<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<T: Debug> Debug for Settings<T>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<T: Coord> Default for Settings<T>

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl<T> UnwindSafe for Settings<T>
where T: UnwindSafe,

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §