Struct LayoutOptions 

#[non_exhaustive]
pub struct LayoutOptions {
    pub container_width: f64,
    pub container_height: f64,
    pub screen_available_width: Option<f64>,
}

Host-provided geometry available to family layout algorithms.

This models the element that owns diagram layout, not a browser page viewport and not the final SVG viewport emitted after layout.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

container_width: f64

Width of the host layout container in CSS pixels.

Families whose Mermaid renderer reads DOM-available width use this value.

container_height: f64

Height of the host layout container in CSS pixels.

screen_available_width: Option<f64>

Browser screen.availWidth in CSS pixels when the host has a screen environment.

Mermaid’s C4 renderer uses the available screen width rather than its container width. None keeps headless rendering deterministic by falling back to container_width.

Implementations

impl LayoutOptions

pub fn headless_svg_defaults() -> Self

Returns geometry defaults suitable for headless SVG rendering.

pub fn with_container_size(self, width: f64, height: f64) -> Self

Sets the host layout container dimensions in CSS pixels.

pub fn with_screen_available_width(self, width: f64) -> Self

Supplies the browser screen.availWidth observed by the host.

Trait Implementations

impl Clone for LayoutOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutOptions

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

Formats the value using the given formatter.

impl Default for LayoutOptions

fn default() -> Self

Returns the “default value” for a type.