qgis_pointonsurface: QGIS algorithm - Point on surface

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

QGIS algorithm - Point on surface

Description

QGIS Algorithm provided by QGIS (native c++) Point on surface (native:pointonsurface). Returns a point guaranteed to lie on the surface of a geometry. —————- Notes —————- - This algorithm may drop existing primary keys or FID values and regenerate them in output layers, depending on the input parameters.

Usage

qgis_pointonsurface(
  INPUT = qgisprocess:::qgis_default_value(),
  ALL_PARTS = 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.
ALL_PARTS	boolean - Create point on surface for each part. 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 - Point. 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 - Point

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