QgsLayoutExporter::SvgExportSettings Struct Reference

Contains settings relating to exporting layouts to SVG. More...

#include <qgslayoutexporter.h>

Public Member Functions
	SvgExportSettings ()
	Constructor for SvgExportSettings. More...

Public Attributes
QgsMargins	cropMargins
	Crop to content margins, in layout units. More...
bool	cropToContents = false
	Set to true if image should be cropped so only parts of the layout containing items are exported. More...
double	dpi = -1
	Resolution to export layout at. If dpi <= 0 the default layout dpi will be used. More...
bool	exportAsLayers = false
	Set to true to export as a layered SVG file. More...
bool	exportMetadata = true
	Indicates whether SVG export should include RDF metadata generated from the layout's project's metadata. More...
QgsLayoutRenderContext::Flags	flags = nullptr
	Layout context flags, which control how the export will be created. More...
bool	forceVectorOutput = false
	Set to true to force vector object exports, even when the resultant appearance will differ from the layout. More...
QgsRenderContext::TextRenderFormat	textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines
	Text rendering format, which controls how text should be rendered in the export (e.g. More...

Detailed Description

Contains settings relating to exporting layouts to SVG.

Definition at line 375 of file qgslayoutexporter.h.

Constructor & Destructor Documentation

QgsLayoutExporter::SvgExportSettings::SvgExportSettings ( )

inline

Constructor for SvgExportSettings.

Definition at line 378 of file qgslayoutexporter.h.

Member Data Documentation

QgsMargins QgsLayoutExporter::SvgExportSettings::cropMargins

Crop to content margins, in layout units.

These margins will be added to the bounds of the exported layout if cropToContents is true.

Definition at line 404 of file qgslayoutexporter.h.

bool QgsLayoutExporter::SvgExportSettings::cropToContents = false

Set to true if image should be cropped so only parts of the layout containing items are exported.

Definition at line 398 of file qgslayoutexporter.h.

double QgsLayoutExporter::SvgExportSettings::dpi = -1

Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.

Definition at line 383 of file qgslayoutexporter.h.

bool QgsLayoutExporter::SvgExportSettings::exportAsLayers = false

Set to true to export as a layered SVG file.

Note that this option is considered experimental, and the generated SVG may differ from the expected appearance of the layout.

Definition at line 411 of file qgslayoutexporter.h.

bool QgsLayoutExporter::SvgExportSettings::exportMetadata = true

Indicates whether SVG export should include RDF metadata generated from the layout's project's metadata.

Since

QGIS 3.2

Definition at line 419 of file qgslayoutexporter.h.

QgsLayoutRenderContext::Flags QgsLayoutExporter::SvgExportSettings::flags = nullptr

Layout context flags, which control how the export will be created.

Definition at line 424 of file qgslayoutexporter.h.

bool QgsLayoutExporter::SvgExportSettings::forceVectorOutput = false

Set to true to force vector object exports, even when the resultant appearance will differ from the layout.

If false, some items may be rasterized in order to maintain their correct appearance in the output.

This option is mutually exclusive with rasterizeWholeImage.

Definition at line 392 of file qgslayoutexporter.h.

QgsRenderContext::TextRenderFormat QgsLayoutExporter::SvgExportSettings::textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines

Text rendering format, which controls how text should be rendered in the export (e.g.

as paths or real text objects).

Since

QGIS 3.4.3

Definition at line 432 of file qgslayoutexporter.h.

---

The documentation for this struct was generated from the following file:

• /build/qgis-3.4.15+24xenial/src/core/layout/qgslayoutexporter.h