#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< QgsAbstractGeospatialPdfExporter::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 Geospatial PDF file.

QStringList	layerTreeGroupOrder
	Specifies the ordering of layer tree groups in the generated Geospatial PDF file.

QSet< QString >	mutuallyExclusiveGroups
	Contains a list of group names which should be considered as mutually exclusive.

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 192 of file qgsabstractgeopdfexporter.h.

Member Data Documentation

◆ author

QString QgsAbstractGeospatialPdfExporter::ExportDetails::author

Metadata author tag.

Definition at line 204 of file qgsabstractgeopdfexporter.h.

◆ creationDateTime

QDateTime QgsAbstractGeospatialPdfExporter::ExportDetails::creationDateTime

Metadata creation datetime.

Definition at line 213 of file qgsabstractgeopdfexporter.h.

◆ creator

QString QgsAbstractGeospatialPdfExporter::ExportDetails::creator

Metadata creator tag.

Definition at line 210 of file qgsabstractgeopdfexporter.h.

◆ customLayerTreeGroups

QMap< QString, QString > QgsAbstractGeospatialPdfExporter::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.

See also: layerTreeGroupOrder

Definition at line 259 of file qgsabstractgeopdfexporter.h.

◆ dpi

double QgsAbstractGeospatialPdfExporter::ExportDetails::dpi = 300

Output DPI.

Definition at line 198 of file qgsabstractgeopdfexporter.h.

◆ georeferencedSections

QList< QgsAbstractGeospatialPdfExporter::GeoReferencedSection > QgsAbstractGeospatialPdfExporter::ExportDetails::georeferencedSections

List of georeferenced sections.

Definition at line 201 of file qgsabstractgeopdfexporter.h.

◆ includeFeatures

bool QgsAbstractGeospatialPdfExporter::ExportDetails::includeFeatures = true

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

Definition at line 245 of file qgsabstractgeopdfexporter.h.

◆ initialLayerVisibility

QMap< QString, bool > QgsAbstractGeospatialPdfExporter::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 274 of file qgsabstractgeopdfexporter.h.

◆ keywords

QgsAbstractMetadataBase::KeywordMap QgsAbstractGeospatialPdfExporter::ExportDetails::keywords

Metadata keyword map.

Definition at line 222 of file qgsabstractgeopdfexporter.h.

◆ layerIdToPdfLayerTreeNameMap

QMap< QString, QString > QgsAbstractGeospatialPdfExporter::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 266 of file qgsabstractgeopdfexporter.h.

◆ layerOrder

QStringList QgsAbstractGeospatialPdfExporter::ExportDetails::layerOrder

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

Layers appearing earlier in the list will show earlier in the Geospatial PDF layer tree list.

See also: layerTreeGroupOrder

Since: QGIS 3.14

Definition at line 285 of file qgsabstractgeopdfexporter.h.

◆ layerTreeGroupOrder

QStringList QgsAbstractGeospatialPdfExporter::ExportDetails::layerTreeGroupOrder

Specifies the ordering of layer tree groups in the generated Geospatial PDF file.

Groups appearing earlier in the list will show earlier in the Geospatial PDF layer tree list.

See also: layerOrder; customLayerTreeGroups

Since: QGIS 3.38

Definition at line 297 of file qgsabstractgeopdfexporter.h.

◆ mutuallyExclusiveGroups

QSet< QString > QgsAbstractGeospatialPdfExporter::ExportDetails::mutuallyExclusiveGroups

Contains a list of group names which should be considered as mutually exclusive.

Since: QGIS 3.40

Definition at line 304 of file qgsabstractgeopdfexporter.h.

◆ pageSizeMm

QSizeF QgsAbstractGeospatialPdfExporter::ExportDetails::pageSizeMm

Page size, in millimeters.

Definition at line 195 of file qgsabstractgeopdfexporter.h.

◆ producer

QString QgsAbstractGeospatialPdfExporter::ExportDetails::producer

Metadata producer tag.

Definition at line 207 of file qgsabstractgeopdfexporter.h.

◆ subject

QString QgsAbstractGeospatialPdfExporter::ExportDetails::subject

Metadata subject tag.

Definition at line 216 of file qgsabstractgeopdfexporter.h.

◆ title

QString QgsAbstractGeospatialPdfExporter::ExportDetails::title

Metadata title tag.

Definition at line 219 of file qgsabstractgeopdfexporter.h.

◆ useIso32000ExtensionFormatGeoreferencing

bool QgsAbstractGeospatialPdfExporter::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 231 of file qgsabstractgeopdfexporter.h.

◆ useOgcBestPracticeFormatGeoreferencing

bool QgsAbstractGeospatialPdfExporter::ExportDetails::useOgcBestPracticeFormatGeoreferencing = false

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

Warning: This results in Geospatial PDF files compatible with a unnamed suite of tools starting with Terra and ending with Go, but can break compatibility with the built-in Acrobat geospatial tools (yes, Geospatial PDF format is a mess!).

Definition at line 240 of file qgsabstractgeopdfexporter.h.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/qgsabstractgeopdfexporter.h

Public Attributes