qgis_atlaslayouttomultiplepdf: QGIS algorithm - Export atlas layout as PDF (multiple files)

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Export atlas layout as PDF (multiple files)

Description

QGIS Algorithm provided by QGIS (native c++) Export atlas layout as PDF (multiple files) (native:atlaslayouttomultiplepdf). Exports an atlas layout to multiple PDF files. This algorithm outputs an atlas layout to multiple PDF files. If a coverage layer is set, the selected layout's atlas settings exposed in this algorithm will be overwritten. In this case, an empty filter or sort by expression will turn those settings off.

Usage

qgis_atlaslayouttomultiplepdf(
  LAYOUT = qgisprocess:::qgis_default_value(),
  COVERAGE_LAYER = qgisprocess:::qgis_default_value(),
  FILTER_EXPRESSION = qgisprocess:::qgis_default_value(),
  SORTBY_EXPRESSION = qgisprocess:::qgis_default_value(),
  SORTBY_REVERSE = 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(),
  OUTPUT_FILENAME = qgisprocess:::qgis_default_value(),
  OUTPUT_FOLDER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LAYOUT	layout - Atlas layout. Name of print layout in current project.
COVERAGE_LAYER	vector - Coverage layer. Path to a vector layer.
FILTER_EXPRESSION	expression - Filter expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
SORTBY_EXPRESSION	expression - Sort expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
SORTBY_REVERSE	boolean - Reverse sort order (used when a sort expression is provided). 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.
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'.
OUTPUT_FILENAME	expression - Output filename. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
OUTPUT_FOLDER	file - Output folder. Path to a 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

No output description provided.

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.