QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Contains settings relating to exporting layouts to SVG. More...
#include <qgslayoutexporter.h>
Public Member Functions | |
SvgExportSettings () | |
Public Attributes | |
QgsMargins | cropMargins |
Crop to content margins, in layout units. | |
bool | cropToContents = false |
Set to true if image should be cropped so only parts of the layout containing items are exported. | |
double | dpi = -1 |
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used. | |
bool | exportAsLayers = false |
Set to true to export as a layered SVG file. | |
bool | exportLabelsToSeparateLayers = true |
Set to true to export labels to separate layers (grouped by map layer) in layered SVG exports. | |
bool | exportMetadata = true |
Indicates whether SVG export should include RDF metadata generated from the layout's project's metadata. | |
QgsLayoutRenderContext::Flags | flags = QgsLayoutRenderContext::Flags() |
Layout context flags, which control how the export will be created. | |
bool | forceVectorOutput = false |
Set to true to force vector object exports, even when the resultant appearance will differ from the layout. | |
QVector< qreal > | predefinedMapScales |
A list of predefined scales to use with the layout. | |
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. | |
Qgis::TextRenderFormat | textRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines |
Text rendering format, which controls how text should be rendered in the export (e.g. | |
Contains settings relating to exporting layouts to SVG.
Definition at line 509 of file qgslayoutexporter.h.
|
inline |
Definition at line 511 of file qgslayoutexporter.h.
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 537 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 531 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 516 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 544 of file qgslayoutexporter.h.
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
.
Definition at line 554 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.
Definition at line 562 of file qgslayoutexporter.h.
QgsLayoutRenderContext::Flags QgsLayoutExporter::SvgExportSettings::flags = QgsLayoutRenderContext::Flags() |
Layout context flags, which control how the export will be created.
Definition at line 567 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 525 of file qgslayoutexporter.h.
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.
Definition at line 590 of file qgslayoutexporter.h.
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.
Definition at line 583 of file qgslayoutexporter.h.
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).
Definition at line 575 of file qgslayoutexporter.h.