qgis_buffer: QGIS algorithm - Buffer

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

QGIS algorithm - Buffer

Description

QGIS Algorithm provided by QGIS (native c++) Buffer (native:buffer). This algorithm computes a buffer area for all the features in an input layer, using a fixed or dynamic distance. The segments parameter controls the number of line segments to use to approximate a quarter circle when creating rounded offsets. The end cap style parameter controls how line endings are handled in the buffer. The join style parameter specifies whether round, miter or beveled joins should be used when offsetting corners in a line. The miter limit parameter is only applicable for miter join styles, and controls the maximum distance from the offset curve to use when creating a mitered join. —————- Notes —————- - This algorithm may drop existing primary keys or FID values and regenerate them in output layers, depending on the input parameters.

Usage

qgis_buffer(
  INPUT = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  SEGMENTS = qgisprocess:::qgis_default_value(),
  END_CAP_STYLE = qgisprocess:::qgis_default_value(),
  JOIN_STYLE = qgisprocess:::qgis_default_value(),
  MITER_LIMIT = qgisprocess:::qgis_default_value(),
  DISSOLVE = qgisprocess:::qgis_default_value(),
  SEPARATE_DISJOINT = 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.
DISTANCE	distance - Distance. 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.
SEGMENTS	number - Segments. 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.
END_CAP_STYLE	enum of ⁠("Round", "Flat", "Square")⁠ - End cap style. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
JOIN_STYLE	enum of ⁠("Round", "Miter", "Bevel")⁠ - Join style. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
MITER_LIMIT	number - Miter limit. 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.
DISSOLVE	boolean - Dissolve result. 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.
SEPARATE_DISJOINT	boolean - Keep disjoint results separate. 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	sink - Buffered. 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 - Buffered

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