Struct Page 

pub struct Page {
    pub number: usize,
    pub width: f64,
    pub height: f64,
    pub source_format: String,
    pub title: String,
    pub description: String,
    pub embedded_source: Option<String>,
    pub nodes: Vec<Node>,
    pub clips: Vec<ClipPath>,
    pub masks: Vec<MaskDefinition>,
    pub patterns: Vec<TilingPatternDefinition>,
    pub warnings: Vec<String>,
}

Fields

number: usize

width: f64

height: f64

source_format: String

title: String

description: String

embedded_source: Option<String>

The source document this page was drawn from, kept verbatim so a reverse conversion can restore it instead of packaging a picture.

draw.io writes the same thing into its own SVG exports, as the content attribute on the root element, and reads it back when the SVG is opened as a diagram.

nodes: Vec<Node>

clips: Vec<ClipPath>

masks: Vec<MaskDefinition>

patterns: Vec<TilingPatternDefinition>

warnings: Vec<String>

Implementations

impl Page

pub fn new(number: usize, width: f64, height: f64, source_format: &str) -> Self

Examples found in repository

examples/custom_ir.rs (line 20)

fn main() -> Result<()> {
    let output_path = std::env::args_os()
        .nth(1)
        .map(PathBuf::from)
        .unwrap_or_else(|| PathBuf::from("output/custom.svg"));
    if let Some(parent) = output_path.parent() {
        fs::create_dir_all(parent)?;
    }

    let mut page = Page::new(1, 320.0, 180.0, "custom");
    page.title = "Public IR example".into();
    page.description = "A path and editable text generated by document-svg".into();

    page.nodes.push(Node::Path {
        id: "card".into(),
        d: "M 20 20 H 300 V 160 H 20 Z".into(),
        fill_rule: "nonzero".into(),
        fill: Paint::solid("#E8F1FF"),
        stroke: Stroke {
            paint: Paint::solid("#246BCE"),
            width: 2.0,
            ..Stroke::default()
        },
        transform: IDENTITY,
        clip_id: None,
        meta: SourceMeta {
            kind: "shape".into(),
            source_id: "example-card".into(),
            semantic_role: "background".into(),
            ..SourceMeta::default()
        },
    });

    page.nodes.push(Node::Text {
        id: "message".into(),
        x: 160.0,
        y: 98.0,
        runs: vec![TextRun {
            text: "Hello, SVG!".into(),
            font_size: 24.0,
            bold: true,
            fill: Paint::solid("#123B72"),
            ..TextRun::default()
        }],
        anchor: TextAnchor::Middle,
        transform: IDENTITY,
        opacity: 1.0,
        stroke: Stroke::default(),
        clip_id: None,
        meta: SourceMeta {
            kind: "text".into(),
            source_id: "example-message".into(),
            semantic_role: "heading".into(),
            alt_text: "Hello, SVG!".into(),
            ..SourceMeta::default()
        },
    });

    let file = File::create(&output_path).map_err(Error::from)?;
    write_page(&page, BufWriter::new(file), SvgOptions::default())?;
    println!("wrote {}", output_path.display());
    Ok(())
}

pub fn warn(&mut self, warning: impl Into<String>)

Trait Implementations

impl Clone for Page

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 Page

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

Formats the value using the given formatter.

impl PartialEq for Page

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Page

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Page