geopointFieldSchema: Create a Geographic Point form field schema

View source: R/formField.R

geopointFieldSchemaR Documentation

Create a Geographic Point form field schema

Description

A Geographic Point field allow users to enter a geo-location with a certain accuracy.

Usage

geopointFieldSchema(
  label,
  description = NULL,
  requiredAccuracy = NULL,
  manualEntryAllowed = TRUE,
  code = NULL,
  id = cuid(),
  required = FALSE,
  hideFromEntry = FALSE,
  hideInTable = FALSE,
  relevanceRule = "",
  validationRule = "",
  reviewerOnly = FALSE
)

Arguments

label

The label of the form field

description

The description of the form field

requiredAccuracy

Minimum required accuracy in metres/meters.

manualEntryAllowed

Whether coordinates may be added manually; default is TRUE

code

The code name of the form field

id

The id of the form Field; default is to generate a new cuid

required

Whether the form field is required; default is FALSE

hideFromEntry

Whether the form field is hidden during data entry; default is FALSE

hideInTable

Whether the form field is hidden during data display; default is FALSE

relevanceRule

Relevance rules for the form field given as a single character string; default is ""

validationRule

Validation rules for the form field given as a single character string; default is ""

reviewerOnly

Whether the form field is for reviewers only; default is FALSE

Details

The user interface as the required geo-location accuracy options:

  • No minimum accuracy

  • Medium accuracy (25 m); default

  • High accuracy (10 m)"

This field cannot be a key field.

See Also

Other field schemas: attachmentFieldSchema(), barcodeFieldSchema(), calculatedFieldSchema(), dateFieldSchema(), formFieldSchema(), monthFieldSchema(), multilineFieldSchema(), multipleSelectFieldSchema(), quantityFieldSchema(), referenceFieldSchema(), sectionFieldSchema(), serialNumberFieldSchema(), singleSelectFieldSchema(), subformFieldSchema(), userFieldSchema(), weekFieldSchema()


bedatadriven/activityinfo-R documentation built on Dec. 21, 2024, 8:23 a.m.