sagang_exportpolygonstohtmlimagemap: QGIS algorithm - Export polygons to html image map

View source: R/sagang_exportpolygonstohtmlimagemap.R

sagang_exportpolygonstohtmlimagemapR Documentation

QGIS algorithm - Export polygons to html image map

Description

QGIS Algorithm provided by SAGA Next Gen Export polygons to html image map (sagang:exportpolygonstohtmlimagemap). —————- Arguments —————- POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer LINK: Link Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TITLE: Title Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names FILE: File Default value: False Argument type: file Acceptable values: - Path to a file LINK_PREFIX: Link Prefix Default value: http://www.saga-gis.org/ Argument type: string Acceptable values: - String 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 LINK_SUFFIX: Link Suffix Default value: index.html Argument type: string Acceptable values: - String 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

Usage

sagang_exportpolygonstohtmlimagemap(
  POLYGONS = qgisprocess:::qgis_default_value(),
  LINK = qgisprocess:::qgis_default_value(),
  TITLE = qgisprocess:::qgis_default_value(),
  FILE = qgisprocess:::qgis_default_value(),
  LINK_PREFIX = qgisprocess:::qgis_default_value(),
  LINK_SUFFIX = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POLYGONS

source - Polygons. Path to a vector layer.

LINK

field - Link. The name of an existing field. ; delimited list of existing field names.

TITLE

field - Title. The name of an existing field. ; delimited list of existing field names.

FILE

file - File. Path to a file.

LINK_PREFIX

string - Link Prefix. String 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.

LINK_SUFFIX

string - Link Suffix. String 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.

...

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.