qgis_printlayouttoimage: QGIS algorithm - Export print layout as image

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

QGIS algorithm - Export print layout as image

Description

QGIS Algorithm provided by QGIS (native c++) Export print layout as image (native:printlayouttoimage). Exports a print layout as an image. This algorithm outputs a print layout as an image file (e.g. PNG or JPEG images).

Usage

qgis_printlayouttoimage(
  LAYOUT = qgisprocess:::qgis_default_value(),
  LAYERS = qgisprocess:::qgis_default_value(),
  DPI = qgisprocess:::qgis_default_value(),
  GEOREFERENCE = qgisprocess:::qgis_default_value(),
  INCLUDE_METADATA = qgisprocess:::qgis_default_value(),
  ANTIALIAS = 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.
GEOREFERENCE	boolean - Generate world file. 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.
ANTIALIAS	boolean - Enable antialiasing. 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 - Image 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 - Image file

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