Struct FlowHandle 

pub struct FlowHandle<T: 'static = ()> { /* private fields */ }

A handle for controlling a crate::Flow from the component that owns it.

let flow = use_flow_handle();
rsx! {
    button { onclick: move |_| flow.auto_layout(&LayoutOptions::default()), "Layout" }
    Flow { nodes, edges, handle: flow }
}

Implementations

impl<T: Clone + PartialEq + 'static> FlowHandle<T>

pub fn core(&self) -> Option<FlowCore>

The flow’s shared core, once mounted.

pub fn viewport(&self) -> Option<Viewport>

Current viewport (non-reactive read).

pub fn set_viewport(&self, viewport: Viewport, duration_ms: u64)

pub fn fit_view(&self, duration_ms: u64)

pub fn zoom_in(&self, duration_ms: u64)

pub fn zoom_out(&self, duration_ms: u64)

pub fn client_to_flow(&self, client: Point) -> Option<Point>

Convert client (page) coordinates to flow coordinates, e.g. for placing a node at a click position.

pub fn delete_selected(&self)

Delete the selected nodes (with their edges) and selected edges — the same cascade the Delete key performs by default. Call this from an on_delete handler after confirming or snapshotting for undo.

pub fn auto_layout(&self, opts: &LayoutOptions)

Re-layout the graph with animated node movement, then fit it into view. Handle sides follow the layout direction when opts.update_handle_sides is set.

Trait Implementations

impl<T> Clone for FlowHandle<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for FlowHandle<T>

impl<T> PartialEq for FlowHandle<T>

fn eq(&self, _other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.