QGIS algorithm - Export print layout as PDF

QGIS Algorithm provided by QGIS (native c++) Export print layout as PDF (native:printlayouttopdf). Exports a print layout as a PDF. This algorithm outputs a print layout as a PDF file.

qgis_printlayouttopdf(
  LAYOUT = qgisprocess:::qgis_default_value(),
  LAYERS = qgisprocess:::qgis_default_value(),
  DPI = qgisprocess:::qgis_default_value(),
  FORCE_VECTOR = qgisprocess:::qgis_default_value(),
  FORCE_RASTER = qgisprocess:::qgis_default_value(),
  GEOREFERENCE = qgisprocess:::qgis_default_value(),
  INCLUDE_METADATA = qgisprocess:::qgis_default_value(),
  DISABLE_TILED = qgisprocess:::qgis_default_value(),
  SIMPLIFY = qgisprocess:::qgis_default_value(),
  TEXT_FORMAT = qgisprocess:::qgis_default_value(),
  IMAGE_COMPRESSION = qgisprocess:::qgis_default_value(),
  SEPARATE_LAYERS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LAYOUT

layout - Print layout. Name of print layout in current project.

LAYERS

multilayer - Map layers to assign to unlocked map item(s). .

DPI

number - DPI (leave blank for default layout DPI). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

FORCE_VECTOR

boolean - Always export as vectors. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

FORCE_RASTER

boolean - Always export as raster. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

GEOREFERENCE

boolean - Append georeference information. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

INCLUDE_METADATA

boolean - Export RDF metadata (title, author, etc.). 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

DISABLE_TILED

boolean - Disable tiled raster layer exports. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

SIMPLIFY

boolean - Simplify geometries to reduce output file size. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

TEXT_FORMAT

enum of ("Always Export Text as Paths (Recommended)", "Always Export Text as Text Objects", "Prefer Exporting Text as Text Objects") - Text export. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

IMAGE_COMPRESSION

enum of ("Lossy (JPEG)", "Lossless") - Image compression. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

SEPARATE_LAYERS

boolean - Export layers as separate PDF files. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

OUTPUT

fileDestination - PDF file. Path for new file.

...

further parameters passed to qgisprocess::qgis_run_algorithm()

.complete_output

logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.

.quiet

logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.

.messages

logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

• OUTPUT - outputFile - PDF file