qgis_translategeometry: QGIS algorithm - Translate

View source: R/qgis_translategeometry.R

qgis_translategeometryR Documentation

QGIS algorithm - Translate

Description

QGIS Algorithm provided by QGIS (native c++) Translate (native:translategeometry). This algorithm moves the geometries within a layer, by offsetting them with a specified x and y displacement. Z and M values present in the geometry can also be translated.

Usage

qgis_translategeometry(
  INPUT = qgisprocess:::qgis_default_value(),
  DELTA_X = qgisprocess:::qgis_default_value(),
  DELTA_Y = qgisprocess:::qgis_default_value(),
  DELTA_Z = qgisprocess:::qgis_default_value(),
  DELTA_M = qgisprocess:::qgis_default_value(),
  OUTPUT = 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.

DELTA_X

distance - Offset distance (x-axis). 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.

DELTA_Y

distance - Offset distance (y-axis). 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.

DELTA_Z

number - Offset distance (z-axis). 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.

DELTA_M

number - Offset distance (m values). 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.

OUTPUT

sink - Translated. Path for new vector layer.

...

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 - outputVector - Translated


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