Skip to content
qgis-rs

layout

qgis_render::layout

QGIS print layouts — a map frame plus legend, scale bar, north arrow, and labels — rendered exactly as designed in QGIS.

use qgis_render::layout::*;

Getting a layout

for layout in project.layouts() {
    println!("{}", layout.name());
}


let layout = project.layout("A4 Landscape")?;

Rendering

// Raster
let image = layout.render_to_image(LayoutRenderSettings::new().dpi(300))?;
image.save("map_a4.png")?;


// Vector
layout.render_to_pdf("map_a4.pdf", LayoutRenderSettings::new().dpi(300))?;
layout.render_to_svg("map_a4.svg")?;
LayoutRenderSettings methodDefaultDescription
.dpi(u32)300Rasterisation resolution for images; vector output uses it for raster items only.
.map_extent(Extent)layout defaultOverride the map frame extent.
.map_crs(Crs)layout defaultOverride the map frame CRS.
.force_vector(bool)falseKeep symbols vector in SVG/PDF where possible.

Overriding the map frame

The same layout can be reused for many areas — useful for a series of printed sheets or an atlas.

let image = layout.render_to_image(LayoutRenderSettings::new()
    .dpi(300)
    .map_extent(Extent::new(14.0, 50.0, 15.0, 51.0))
)?;

Inspecting items

for item in layout.items() {
    println!("{}: {} at ({}, {})",
        item.id(),
        item.item_type(),      // MapFrame, Legend, ScaleBar, Label, ...
        item.position().x,
        item.position().y,
    );
}

ItemType covers MapFrame, Legend, ScaleBar, NorthArrow, Label, Picture, Table, and Shape.

See also