Skip To ContentArcGIS for DevelopersSign In Dashboard
Class: esri/form/elements/Element
Since: ArcGIS API for JavaScript 4.16

Form elements define what should display within the FormTemplate elements. There are two specific element types:

The Element class is a read-only base class which has no constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The element's description providing the purpose behind it.

more details
more detailsElement
String

A string value containing the field alias.

more details
more detailsElement
String

The type of form element displayed.

more details
more detailsElement
String

A reference to an Arcade expression that returns a boolean value.

more details
more detailsElement

Property Details

description String

The element's description providing the purpose behind it.

label String

A string value containing the field alias. This is not to Arcade expressions as the title is used instead.

type Stringreadonly

The type of form element displayed.

Possible Values:"field"|"group"

visibilityExpression String

A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the default behavior is that the element is displayed. Care must be taken when defining a visibility expression for a non-nullable field i.e. to make sure that such fields either have default values or are made visible to users so that they can provide a value before submitting the form.

Method Overview

NameReturn TypeSummaryClass
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsElement
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsElement

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...