qgis_singlesidedbuffer: QGIS algorithm - Single sided buffer

View source: R/qgis_singlesidedbuffer.R

qgis_singlesidedbufferR Documentation

QGIS algorithm - Single sided buffer

Description

QGIS Algorithm provided by QGIS (native c++) Single sided buffer (native:singlesidedbuffer). This algorithm buffers lines by a specified distance on one side of the line only. The segments parameter controls the number of line segments to use to approximate a quarter circle when creating rounded buffers. The join style parameter specifies whether round, miter or beveled joins should be used when buffering corners in a line. The miter limit parameter is only applicable for miter join styles, and controls the maximum distance from the buffer to use when creating a mitered join.

Usage

qgis_singlesidedbuffer(
  INPUT = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  SIDE = qgisprocess:::qgis_default_value(),
  SEGMENTS = qgisprocess:::qgis_default_value(),
  JOIN_STYLE = qgisprocess:::qgis_default_value(),
  MITER_LIMIT = 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.

SIDE

enum of ⁠("Left", "Right")⁠ - Side. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

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.

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.

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.