qgis_layertobookmarks: QGIS algorithm - Convert layer to spatial bookmarks

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

QGIS algorithm - Convert layer to spatial bookmarks

Description

QGIS Algorithm provided by QGIS (native c++) Convert layer to spatial bookmarks (native:layertobookmarks). Converts feature extents to stored spatial bookmarks. This algorithm creates spatial bookmarks corresponding to the extent of features contained in a layer.

Usage

qgis_layertobookmarks(
  INPUT = qgisprocess:::qgis_default_value(),
  DESTINATION = qgisprocess:::qgis_default_value(),
  NAME_EXPRESSION = qgisprocess:::qgis_default_value(),
  GROUP_EXPRESSION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Input layer. Path to a vector layer.
DESTINATION	enum of ⁠("Project bookmarks", "User bookmarks")⁠ - Bookmark destination. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
NAME_EXPRESSION	expression - Name field. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
GROUP_EXPRESSION	expression - Group field. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
...	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

• COUNT - outputNumber - Count of bookmarks added

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