QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | Public Attributes | List of all members
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 exportLabelsToSeparateLayers = true
 Set to true to export labels to separate layers (grouped by map layer) in layered SVG exports. More...
 
bool exportMetadata = true
 Indicates whether SVG export should include RDF metadata generated from the layout's project's metadata. More...
 
QgsLayoutRenderContext::Flags flags = QgsLayoutRenderContext::Flags()
 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...
 
QVector< qreal > predefinedMapScales
 A list of predefined scales to use with the layout. More...
 
bool simplifyGeometries = true
 Indicates whether vector geometries should be simplified to avoid redundant extraneous detail, such as vertices which are not visible at the specified dpi of the output. More...
 
Qgis::TextRenderFormat textRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines
 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 483 of file qgslayoutexporter.h.

Constructor & Destructor Documentation

◆ SvgExportSettings()

QgsLayoutExporter::SvgExportSettings::SvgExportSettings ( )
inline

Constructor for SvgExportSettings.

Definition at line 486 of file qgslayoutexporter.h.

Member Data Documentation

◆ cropMargins

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 512 of file qgslayoutexporter.h.

◆ cropToContents

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 506 of file qgslayoutexporter.h.

◆ dpi

double QgsLayoutExporter::SvgExportSettings::dpi = -1

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

Definition at line 491 of file qgslayoutexporter.h.

◆ exportAsLayers

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 519 of file qgslayoutexporter.h.

◆ exportLabelsToSeparateLayers

bool QgsLayoutExporter::SvgExportSettings::exportLabelsToSeparateLayers = true

Set to true to export labels to separate layers (grouped by map layer) in layered SVG exports.

This option is only used if exportAsLayers is true.

Since
QGIS 3.10

Definition at line 529 of file qgslayoutexporter.h.

◆ exportMetadata

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 537 of file qgslayoutexporter.h.

◆ flags

QgsLayoutRenderContext::Flags QgsLayoutExporter::SvgExportSettings::flags = QgsLayoutRenderContext::Flags()

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

Definition at line 542 of file qgslayoutexporter.h.

◆ forceVectorOutput

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 500 of file qgslayoutexporter.h.

◆ predefinedMapScales

QVector<qreal> QgsLayoutExporter::SvgExportSettings::predefinedMapScales

A list of predefined scales to use with the layout.

This is used for maps which are set to the predefined atlas scaling mode.

Since
QGIS 3.10

Definition at line 565 of file qgslayoutexporter.h.

◆ simplifyGeometries

bool QgsLayoutExporter::SvgExportSettings::simplifyGeometries = true

Indicates whether vector geometries should be simplified to avoid redundant extraneous detail, such as vertices which are not visible at the specified dpi of the output.

Since
QGIS 3.10

Definition at line 558 of file qgslayoutexporter.h.

◆ textRenderFormat

Qgis::TextRenderFormat QgsLayoutExporter::SvgExportSettings::textRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines

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 550 of file qgslayoutexporter.h.


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