Struct Mermaid 

pub struct Mermaid {
    diagram: String,
    scale: f32,
    auto_scale: bool,
    max_ratio: f32,
    alignment: Alignment,
    position: Option<Position>,
    link: Option<String>,
}

Element that renders a Mermaid diagram into the PDF as an SVG image.

This element is only available when the mermaid feature is enabled. Rendering requires headless Chrome at runtime; the following example demonstrates creating and configuring a Mermaid element but does not attempt to render it.

Examples

use genpdfi_extended::elements::Mermaid;
use genpdfi_extended::Alignment;

let m = Mermaid::new("graph TB\na-->b")
    .with_alignment(Alignment::Center)
    .with_scale(1.5);

// Example verifies the API compiles and can be debug-formatted without invoking Chrome.
let s = format!("{:?}", m);
assert!(s.contains("Mermaid"));

Fields

diagram: String

scale: f32

Scaling factor applied directly to the generated SVG. A value of 1.0 means no scaling.

auto_scale: bool

If true, automatically reduce the scale so the rendered diagram fits within 90% of the page width or height (whichever constrains first). When enabled the scale is initially set to 2.0 by with_auto_scale() and then adjusted at render time based on the available area.

max_ratio: f32

Maximum ratio of page size to use when auto-scaling (e.g. 0.9 for 90% of page)

alignment: Alignment

Positioning and presentation helpers mirrored from Image.

position: Option<Position>

link: Option<String>

Implementations

impl Mermaid

pub fn render_svg(diagram: &str) -> Result<String, Error>

Renders the diagram string to an SVG string using an embedded helper page and the mermaid.min.js script from examples/helper.

impl Mermaid

pub fn new<S: Into<String>>(diagram: S) -> Self

Create a new Mermaid element from the source string.

Examples

use genpdfi_extended::elements::Mermaid;
let m = Mermaid::new("graph TB\na-->b");
let s = format!("{:?}", m);
assert!(s.contains("Mermaid"));

pub fn ensure_browser() -> Result<(), Error>

Ensure the global headless Chrome instance is up and running.

Useful for examples that want to pre-check the environment before building the full PDF.

pub fn get_browser() -> Result<&'static Browser, Error>

Returns a reference to the shared headless Chrome Browser instance, initializing it if necessary. Use this if you need to open tabs or interact directly with the browser in integration tests or examples.

pub fn with_alignment(self, a: Alignment) -> Self

Set alignment used when no absolute position is given.

pub fn with_position(self, p: Position) -> Self

Set an absolute position for the element.

pub fn with_link<S: Into<String>>(self, link: S) -> Self

Attach a hyperlink to the rendered SVG.

pub fn with_scale(self, s: f32) -> Self

Set the scale to apply directly to the generated SVG.

The scaling is applied to the SVG markup (a wrapper <g transform="scale(...)"> is inserted) and numeric width/height attributes are multiplied accordingly.

Examples

use genpdfi_extended::elements::Mermaid;
let m = Mermaid::new("graph TB\na-->b").with_scale(2.0);
let s = format!("{:?}", m);
assert!(s.contains("Mermaid"));

pub fn with_auto_scale(self, s: f32, max_ratio: f32) -> Self

Enable automatic scaling with a sensible default.

This sets the scale and enables automatic adjustment at render time so that the final rendered diagram does not exceed 90% of the available page width or height. The computed scale will never be larger than the initial value.

Examples

use genpdfi_extended::elements::Mermaid;
let m = Mermaid::new("graph TB\na-->b").with_auto_scale(2.0, 0.9);
let s = format!("{:?}", m);
assert!(s.contains("Mermaid"));

Trait Implementations

impl Clone for Mermaid

fn clone(&self) -> Mermaid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mermaid

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

Formats the value using the given formatter.

impl Element for Mermaid

fn render( &mut self, context: &Context, area: Area<'_>, style: Style, ) -> Result<RenderResult, Error>

Renders this element to the given area using the given style and font cache.

fn framed(self, line_style: impl Into<LineStyle>) -> FramedElement<Self>

where Self: Sized,

Draws a frame around this element using the given line style.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self>

where Self: Sized,

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self>

where Self: Sized,

Sets the default style for this element and its children.