qgis_rectanglesovalsdiamondsvariable: QGIS algorithm - Rectangles, ovals, diamonds (variable)

View source: R/qgis_rectanglesovalsdiamondsvariable.R

qgis_rectanglesovalsdiamondsvariableR Documentation

QGIS algorithm - Rectangles, ovals, diamonds (variable)

Description

QGIS Algorithm provided by QGIS Rectangles, ovals, diamonds (variable) (qgis:rectanglesovalsdiamondsvariable). —————- Arguments —————- INPUT: Input layer Argument type: source Acceptable values: - Path to a vector layer SHAPE: Buffer shape Argument type: enum Available values: - 0: Rectangles - 1: Diamonds - 2: Ovals Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' WIDTH: Width field Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names HEIGHT: Height field Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names ROTATION: Rotation field (optional) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names SEGMENTS: Number of segments Default value: 36 Argument type: number Acceptable 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: Output Argument type: sink Acceptable values: - Path for new vector layer

Usage

qgis_rectanglesovalsdiamondsvariable(
  INPUT = qgisprocess:::qgis_default_value(),
  SHAPE = qgisprocess:::qgis_default_value(),
  WIDTH = qgisprocess:::qgis_default_value(),
  HEIGHT = qgisprocess:::qgis_default_value(),
  ROTATION = qgisprocess:::qgis_default_value(),
  SEGMENTS = 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.

SHAPE

enum of ⁠("Rectangles", "Diamonds", "Ovals")⁠ - Buffer shape. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

WIDTH

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

HEIGHT

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

ROTATION

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

SEGMENTS

number - Number of 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.

OUTPUT

sink - Output. 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 - Output


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