scirs2_cluster::hierarchy::visualization::types

Struct DendrogramPlot

pub struct DendrogramPlot<F: Float> {
    pub branches: Vec<Branch<F>>,
    pub leaves: Vec<Leaf>,
    pub colors: Vec<String>,
    pub legend: Vec<LegendEntry>,
    pub bounds: (F, F, F, F),
    pub config: DendrogramConfig<F>,
}

Expand description

Enhanced dendrogram visualization data structure

Fields§

§branches: Vec<Branch<F>>

Branch coordinates for drawing

§leaves: Vec<Leaf>

Leaf positions and labels

§colors: Vec<String>

Color assignments for each branch

§legend: Vec<LegendEntry>

Legend information

§bounds: (F, F, F, F)

Plot bounds (min_x, max_x, min_y, max_y)

§config: DendrogramConfig<F>

Configuration used to create this plot

Implementations§

Source §

impl<F: Float> DendrogramPlot<F>

Source

pub fn to_html(&self) -> Result<String>
where F: FromPrimitive + Debug + Display,

Export the dendrogram plot to HTML format with interactive features

This method creates an HTML document with an embedded D3.js visualization that allows for interactive exploration of the dendrogram.

§Returns

Result<String> - HTML document as a string

§Example

let html = plot.to_html().unwrap();
std::fs::write("dendrogram.html", html).unwrap();

Source

pub fn to_svg(&self) -> Result<String>
where F: FromPrimitive + Debug + Display,

Export the dendrogram plot to SVG format

This method creates a scalable vector graphics representation of the dendrogram that can be embedded in web pages or used in publications.

§Returns

Result<String> - SVG document as a string

Source

pub fn to_json(&self) -> Result<String>
where F: FromPrimitive + Debug + Display,

Export the dendrogram plot to JSON format

This method serializes the plot data to JSON for programmatic use or integration with other visualization libraries.

§Returns

Result<String> - JSON representation of the plot

Source

pub fn export_with_config(&self, config: &ExportConfig) -> Result<String>
where F: FromPrimitive + Debug + Display,

Export with custom configuration

This method provides fine-grained control over the export process using a configuration object.

§Arguments

config - Export configuration options

§Returns

Result<String> - Exported content based on configuration

Trait Implementations§

Source §

impl<F: Clone + Float> Clone for DendrogramPlot<F>

Source §

fn clone(&self) -> DendrogramPlot<F>

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<F: Debug + Float> Debug for DendrogramPlot<F>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> UnwindSafe for DendrogramPlot<F>
where F: 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 §