QGIS algorithm - Export to spreadsheet

Source: R/qgis_exporttospreadsheet.R

QGIS Algorithm provided by QGIS (native c++) Export to spreadsheet (native:exporttospreadsheet). Collects a number of existing layers and exports them to a spreadsheet document. This algorithm collects a number of existing layers and exports them to a spreadsheet document. Optionally the layers can be appended to an existing spreadsheet as additional sheets.

qgis_exporttospreadsheet(
  LAYERS = qgisprocess:::qgis_default_value(),
  USE_ALIAS = qgisprocess:::qgis_default_value(),
  FORMATTED_VALUES = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  OVERWRITE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LAYERS

multilayer - Input layers. .

USE_ALIAS

boolean - Use field aliases as column headings. 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.

FORMATTED_VALUES

boolean - Export formatted values instead of raw values. 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 - Destination spreadsheet. Path for new file.

OVERWRITE

boolean - Overwrite existing spreadsheet. 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.

...

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 - Destination spreadsheet

  • OUTPUT_LAYERS - outputMultilayer - Layers within spreadsheet