Struct SvgImageData 

pub struct SvgImageData {
    pub tree: Arc<Tree>,
    pub intrinsic_dimensions: SvgIntrinsicDimensions,
}

A parsed SVG image.

usvg always resolves the root <svg> to a concrete usvg::Tree::size, falling back to the viewBox size when width/height are absent or given as percentages. For CSS sizing purposes, however, such an SVG has no intrinsic width/height (only an intrinsic aspect ratio). The accessors on this type resolve the CSS intrinsic dimensions from the declared root attributes, which are captured at parse time.

Fields

tree: Arc<Tree>

The parsed SVG tree.

intrinsic_dimensions: SvgIntrinsicDimensions

The dimensions declared on the root <svg> element.

Implementations

impl SvgImageData

pub fn from_data(data: &[u8], options: &Options<'_>) -> Result<Self, Error>

Parse an SVG image from raw data, capturing both the rendered usvg::Tree and the declared root dimensions from a single XML parse.

Like usvg::Tree::from_data, gzip-compressed data (SVGZ) is decompressed first.

pub fn intrinsic_width(&self) -> Option<f32>

The intrinsic width in CSS px, present only when the root <svg> declared an absolute (non-percentage) width.

pub fn intrinsic_height(&self) -> Option<f32>

The intrinsic height in CSS px, present only when the root <svg> declared an absolute (non-percentage) height.

pub fn viewbox_aspect_ratio(&self) -> Option<f32>

The aspect ratio of the root <svg>’s viewBox, if it declares one.

pub fn resolved_width(&self, container_width: Option<f32>) -> Option<f32>

The root width attribute resolved against a containing block width: percentages resolve against the containing block (None if it is indefinite) and an absent attribute is None.

This is only appropriate for an inline <svg> element, where the attributes behave as presentation attributes. SVG used as an image (e.g. <img src> or a background) must use Self::intrinsic_width, as its intrinsic dimensions are context-free per CSS.

pub fn resolved_height(&self, container_height: Option<f32>) -> Option<f32>

The root height attribute resolved against a containing block height. See Self::resolved_width.

pub fn aspect_ratio(&self) -> f32

The intrinsic aspect ratio of the SVG: the ratio of its declared width/height when both are absolute lengths, otherwise the viewBox ratio, otherwise the ratio of the resolved usvg::Tree::size (which is always non-zero).

pub fn intrinsic_size(&self) -> (f32, f32)

The intrinsic dimensions of the SVG resolved per CSS replaced element sizing: a missing dimension is computed from the declared one and the intrinsic aspect ratio; if neither is declared, the resolved usvg::Tree::size is used as a fallback.

Trait Implementations

impl Clone for SvgImageData

fn clone(&self) -> SvgImageData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SvgImageData

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

Formats the value using the given formatter.