Geometry Picker Form Element

Type: Boolean

Name in Properties Panel: Auto-Activate

Name to Use in Expressions: autoActivate

Indicates whether the element activates automatically when the form displays. By default, geometry pickers do not automatically activate. The user must click the button to activate the geometry picker.

To access the autoActivate property in an expression:

${Display Form ID}.state.{Element ID}.autoActivate

For example:

$form1.state.geometryPicker1.autoActivate

Type: String

The text that appears on the button that the user clicks to select a geometry. The default text is Add Location.

You can format the button's label using Markdown.

Type: String

A description of the element. The description appears below the element's title.

You can use the Description property to describe what the element represents or to provide instructions to the user about how to use the element.

You can format the description using Markdown.

Type: String

The element's ID, which is used in other form elements and activities to access the element's properties, including the user's input. The ID must be unique across all elements in the form.

You cannot get or set the value of the Element ID property in an expression—you can only use the value that you configured for it. To use the Element ID property in an expression:

${Display Form ID}.state.{Element ID}.{property name}

For example:

$form1.state.geometryPicker1.visible

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

Indicates whether the geometry picker is enabled in the running workflow. When a geometry picker is enabled, the user can select geometries. When a geometry picker is disabled, the user can see the geometry picker but cannot interact with it. Disabled elements appear dimmed or shaded in the running workflow.

By default, geometry pickers are enabled. To disable a geometry picker, clear the Enabled checkbox. You may want to change the property's value at run time depending on the user's input in a previous form element.

To access the enabled property in an expression:

${Display Form ID}.state.{Element ID}.enabled

For example:

$form1.state.geometryPicker1.enabled

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements.

Type: String

The text that appears on each geometry in the list of selected geometries. The default text is Location.

You can format the Geometry Label property using Markdown.

Type: String

The type of geometry that the user will draw on the map to select a geometry—point, polygon, polyline, freehand polygon, freehand polyline, or extent. The default is Polygon.

Type: Number

The maximum number of geometries that the user can select. When the maximum number of geometries have been selected, the Add Location button becomes unavailable. By default, the user can select 1 geometry.

Type: Boolean

Name in Properties Panel: Required

Name to Use in Expressions: require

Indicates whether the user must select a geometry. When the geometry picker is required, the user cannot submit the form until at least one geometry is selected.

By default, geometry pickers are not required. To require a geometry picker, select the Required checkbox.

The Required checkbox is intended as a quick way to do simple validation without having to add a validate event. If you add a validate event to a form element, selecting the Required checkbox will not have any effect. In this case, you must make the validate event check whether the user entered a value.

To access the require property in an expression:

${Display Form ID}.state.{Element ID}.require

For example:

$form1.state.geometryPicker1.require

Type: String

Indicates the name of the style that will be applied to the element.

To access the styleName property in an expression:

${Display Form ID}.state.{Element ID}.styleName

For example:

$form1.state.geometryPicker1.styleName

Type: String

The element's title, which appears at the top of the element. You may want to change the title to describe what the element represents in your workflow.

You can format the title using Markdown.

Type: String

A message that displays when the user hovers the mouse pointer over the geometry picker. You may want to use the tooltip to provide help to the user.

Type: String

The variety of form element. Geometry pickers are type "GeometryPicker".

Use the type property to find out the variety of a form element in a form with many elements. Loop through ${Display Form ID}.state, comparing each element to the known form types and performing some action on the elements that meet your type criteria.

To access the type property in an expression:

${Display Form ID}.state.{Element ID}.type

For example:

$form1.state.geometryPicker1.type

Type: GeometryRef

An object of type GeometryRef that represents the selected geometry or geometries. The object has a geometry property that is the geometry. To access the geometry in an expression:

${Display Form ID}.state.{Element ID}.value.geometry

For example:

$form1.state.geometryPicker1.value.geometry

The load event fires when the element finishes loading.

You can use the load event to set one or more of the element's properties at run time.

The change event fires when the user adds or removes a geometry.

You can use the change event to display information about the geometry that was just captured, for example, the coordinates or address from a Reverse Geocode activity.

You can use the change event to create dependencies between form elements. For example, you could configure a change subworkflow that enables or disables other form elements depending on the user's selection.

The change event fires every time the user adds or removes a geometry. This means that the change subworkflow can run multiple times. Because of this, you should make sure that the change subworkflow is not computationally intensive or long running.