Arrangement

Enum Arrangement 

Source
pub enum Arrangement {
    Snap,
    Perpendicular,
    Freeform,
    Fixed,
}
Expand description

An enumeration representing node arrangement strategies for Sankey diagrams.

The Arrangement enum controls how nodes are positioned relative to each other:

  • Snap — If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad.
  • Perpendicular — Nodes can only move along a line perpendicular to the primary flow.
  • Freeform — Nodes can freely move anywhere on the plane without automatic constraints.
  • Fixed — Nodes remain stationary at their specified positions and are not adjusted by the layout algorithm.

§Example

use plotlars::{Arrangement, SankeyDiagram, Orientation, Plot, Rgb, Text};
use polars::prelude::*;

let dataset = df![
    "source" => &["A1", "A2", "A1", "B1", "B2", "B2"],
    "target" => &["B1", "B2", "B2", "C1", "C1", "C2"],
    "value"  => &[8, 4, 2, 8, 4, 2],
].unwrap();

SankeyDiagram::builder()
    .data(&dataset)
    .sources("source")
    .targets("target")
    .values("value")
    .orientation(Orientation::Horizontal)
    .arrangement(Arrangement::Freeform)
    .node_colors(vec![
        Rgb(222, 235, 247),
        Rgb(198, 219, 239),
        Rgb(158, 202, 225),
        Rgb(107, 174, 214),
        Rgb( 66, 146, 198),
        Rgb( 33, 113, 181),
    ])
    .link_colors(vec![
        Rgb(222, 235, 247),
        Rgb(198, 219, 239),
        Rgb(158, 202, 225),
        Rgb(107, 174, 214),
        Rgb( 66, 146, 198),
        Rgb( 33, 113, 181),
    ])
    .build()
    .plot();

Example

Variants§

§

Snap

§

Perpendicular

§

Freeform

§

Fixed

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T