#include <qgsabstractgeopdfexporter.h>

Public Attributes
QString	author
	Metadata author tag.

QDateTime	creationDateTime
	Metadata creation datetime.

QString	creator
	Metadata creator tag.

QMap< QString, QString >	customLayerTreeGroups
	Optional map of map layer ID to custom logical layer tree group in created PDF file.

double	dpi = 300
	Output DPI.

QList< QgsAbstractGeoPdfExporter::GeoReferencedSection >	georeferencedSections
	List of georeferenced sections.

bool	includeFeatures = true
	`true` if feature vector information (such as attributes) should be exported.

QMap< QString, bool >	initialLayerVisibility
	Optional map of map layer ID to initial visibility state.

QgsAbstractMetadataBase::KeywordMap	keywords
	Metadata keyword map.

QMap< QString, QString >	layerIdToPdfLayerTreeNameMap
	Optional map of map layer ID to custom layer tree name to show in the created PDF file.

QStringList	layerOrder
	Optional list of layer IDs, in the order desired to appear in the generated GeoPDF file.

QSizeF	pageSizeMm
	Page size, in millimeters.

QString	producer
	Metadata producer tag.

QString	subject
	Metadata subject tag.

QString	title
	Metadata title tag.

bool	useIso32000ExtensionFormatGeoreferencing = true
	`true` if ISO32000 extension format georeferencing should be used.

bool	useOgcBestPracticeFormatGeoreferencing = false
	`true` if OGC "best practice" format georeferencing should be used.

Detailed Description

Definition at line 198 of file qgsabstractgeopdfexporter.h.

Member Data Documentation

◆ author

QString QgsAbstractGeoPdfExporter::ExportDetails::author

Metadata author tag.

Definition at line 210 of file qgsabstractgeopdfexporter.h.

◆ creationDateTime

QDateTime QgsAbstractGeoPdfExporter::ExportDetails::creationDateTime

Metadata creation datetime.

Definition at line 219 of file qgsabstractgeopdfexporter.h.

◆ creator

QString QgsAbstractGeoPdfExporter::ExportDetails::creator

Metadata creator tag.

Definition at line 216 of file qgsabstractgeopdfexporter.h.

◆ customLayerTreeGroups

QMap< QString, QString > QgsAbstractGeoPdfExporter::ExportDetails::customLayerTreeGroups

Optional map of map layer ID to custom logical layer tree group in created PDF file.

E.g. if the map contains "layer1": "Environment", "layer2": "Environment", "layer3": "Transport" then the created PDF file will have entries in its layer tree for "Environment" and "Transport", and toggling "Environment" will toggle BOTH layer1 and layer2.

Layers which are not included in this group will always have their own individual layer tree entry created for them automatically.

Definition at line 263 of file qgsabstractgeopdfexporter.h.

◆ dpi

double QgsAbstractGeoPdfExporter::ExportDetails::dpi = 300

Output DPI.

Definition at line 204 of file qgsabstractgeopdfexporter.h.

◆ georeferencedSections

QList< QgsAbstractGeoPdfExporter::GeoReferencedSection > QgsAbstractGeoPdfExporter::ExportDetails::georeferencedSections

List of georeferenced sections.

Definition at line 207 of file qgsabstractgeopdfexporter.h.

◆ includeFeatures

bool QgsAbstractGeoPdfExporter::ExportDetails::includeFeatures = true

true if feature vector information (such as attributes) should be exported.

Definition at line 251 of file qgsabstractgeopdfexporter.h.

◆ initialLayerVisibility

QMap< QString, bool > QgsAbstractGeoPdfExporter::ExportDetails::initialLayerVisibility

Optional map of map layer ID to initial visibility state.

If a layer ID is not present in this, it will default to being initially visible when opening the PDF.

Since: QGIS 3.14

Definition at line 278 of file qgsabstractgeopdfexporter.h.

◆ keywords

QgsAbstractMetadataBase::KeywordMap QgsAbstractGeoPdfExporter::ExportDetails::keywords

Metadata keyword map.

Definition at line 228 of file qgsabstractgeopdfexporter.h.

◆ layerIdToPdfLayerTreeNameMap

QMap< QString, QString > QgsAbstractGeoPdfExporter::ExportDetails::layerIdToPdfLayerTreeNameMap

Optional map of map layer ID to custom layer tree name to show in the created PDF file.

Since: QGIS 3.14

Definition at line 270 of file qgsabstractgeopdfexporter.h.

◆ layerOrder

QStringList QgsAbstractGeoPdfExporter::ExportDetails::layerOrder

Optional list of layer IDs, in the order desired to appear in the generated GeoPDF file.

Layers appearing earlier in the list will show earlier in the GeoPDF layer tree list.

Since: QGIS 3.14

Definition at line 287 of file qgsabstractgeopdfexporter.h.

◆ pageSizeMm

QSizeF QgsAbstractGeoPdfExporter::ExportDetails::pageSizeMm

Page size, in millimeters.

Definition at line 201 of file qgsabstractgeopdfexporter.h.

◆ producer

QString QgsAbstractGeoPdfExporter::ExportDetails::producer

Metadata producer tag.

Definition at line 213 of file qgsabstractgeopdfexporter.h.

◆ subject

QString QgsAbstractGeoPdfExporter::ExportDetails::subject

Metadata subject tag.

Definition at line 222 of file qgsabstractgeopdfexporter.h.

◆ title

QString QgsAbstractGeoPdfExporter::ExportDetails::title

Metadata title tag.

Definition at line 225 of file qgsabstractgeopdfexporter.h.

◆ useIso32000ExtensionFormatGeoreferencing

bool QgsAbstractGeoPdfExporter::ExportDetails::useIso32000ExtensionFormatGeoreferencing = true

true if ISO32000 extension format georeferencing should be used.

This is a recommended setting which results in Geospatial PDF files that use PDF 2.0 Geospatial Features (ISO 32000-2:2017). Compatible with the built-in Acrobat geospatial tools

Definition at line 237 of file qgsabstractgeopdfexporter.h.

◆ useOgcBestPracticeFormatGeoreferencing

bool QgsAbstractGeoPdfExporter::ExportDetails::useOgcBestPracticeFormatGeoreferencing = false

true if OGC "best practice" format georeferencing should be used.

Warning: This results in GeoPDF files compatible with the TerraGo suite of tools, but can break compatibility with the built-in Acrobat geospatial tools (yes, GeoPDF format is a mess!).

Definition at line 246 of file qgsabstractgeopdfexporter.h.

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

/build/qgis-3.34.0+99sid/src/core/qgsabstractgeopdfexporter.h

Public Attributes