QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
Public Attributes | List of all members
QgsAbstractGeoPdfExporter::ExportDetails Struct Reference

#include <qgsabstractgeopdfexporter.h>

Public Attributes

QString author
 Metadata author tag. More...
QDateTime creationDateTime
 Metadata creation datetime. More...
QString creator
 Metadata creator tag. More...
QMap< QString, QString > customLayerTreeGroups
 Optional map of map layer ID to custom logical layer tree group in created PDF file. More...
double dpi = 300
 Output DPI. More...
QList< QgsAbstractGeoPdfExporter::GeoReferencedSectiongeoreferencedSections
 List of georeferenced sections. More...
bool includeFeatures = true
 true if feature vector information (such as attributes) should be exported. More...
QgsAbstractMetadataBase::KeywordMap keywords
 Metadata keyword map. More...
QSizeF pageSizeMm
 Page size, in millimeters. More...
QString producer
 Metadata producer tag. More...
QString subject
 Metadata subject tag. More...
QString title
 Metadata title tag. More...
bool useIso32000ExtensionFormatGeoreferencing = true
 true if ISO3200 extension format georeferencing should be used. More...
bool useOgcBestPracticeFormatGeoreferencing = false
 true if OGC "best practice" format georeferencing should be used. More...

Detailed Description

Definition at line 189 of file qgsabstractgeopdfexporter.h.

Member Data Documentation

◆ author

QString QgsAbstractGeoPdfExporter::ExportDetails::author

Metadata author tag.

Definition at line 201 of file qgsabstractgeopdfexporter.h.

◆ creationDateTime

QDateTime QgsAbstractGeoPdfExporter::ExportDetails::creationDateTime

Metadata creation datetime.

Definition at line 210 of file qgsabstractgeopdfexporter.h.

◆ creator

QString QgsAbstractGeoPdfExporter::ExportDetails::creator

Metadata creator tag.

Definition at line 207 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 253 of file qgsabstractgeopdfexporter.h.

◆ dpi

double QgsAbstractGeoPdfExporter::ExportDetails::dpi = 300

Output DPI.

Definition at line 195 of file qgsabstractgeopdfexporter.h.

◆ georeferencedSections

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

List of georeferenced sections.

Definition at line 198 of file qgsabstractgeopdfexporter.h.

◆ includeFeatures

bool QgsAbstractGeoPdfExporter::ExportDetails::includeFeatures = true

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

Definition at line 241 of file qgsabstractgeopdfexporter.h.

◆ keywords

QgsAbstractMetadataBase::KeywordMap QgsAbstractGeoPdfExporter::ExportDetails::keywords

Metadata keyword map.

Definition at line 219 of file qgsabstractgeopdfexporter.h.

◆ pageSizeMm

QSizeF QgsAbstractGeoPdfExporter::ExportDetails::pageSizeMm

Page size, in millimeters.

Definition at line 192 of file qgsabstractgeopdfexporter.h.

◆ producer

QString QgsAbstractGeoPdfExporter::ExportDetails::producer

Metadata producer tag.

Definition at line 204 of file qgsabstractgeopdfexporter.h.

◆ subject

QString QgsAbstractGeoPdfExporter::ExportDetails::subject

Metadata subject tag.

Definition at line 213 of file qgsabstractgeopdfexporter.h.

◆ title

QString QgsAbstractGeoPdfExporter::ExportDetails::title

Metadata title tag.

Definition at line 216 of file qgsabstractgeopdfexporter.h.

◆ useIso32000ExtensionFormatGeoreferencing

bool QgsAbstractGeoPdfExporter::ExportDetails::useIso32000ExtensionFormatGeoreferencing = true

true if ISO3200 extension format georeferencing should be used.

This is a recommended setting which results in Geospatial PDF files compatible with the built-in Acrobat geospatial tools.

Definition at line 227 of file qgsabstractgeopdfexporter.h.

◆ useOgcBestPracticeFormatGeoreferencing

bool QgsAbstractGeoPdfExporter::ExportDetails::useOgcBestPracticeFormatGeoreferencing = false

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

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

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