Element

AMD: require(["esri/form/elements/Element"], (Element) => { /* code goes here */ });
ESM: import Element from "@arcgis/core/form/elements/Element";
Class: esri/form/elements/Element
Inheritance: Element Accessor
Subclasses: FieldElement , GroupElement
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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The element's description providing the purpose behind it.

more detailsElement
Stringmore details

A string value containing the field alias.

more detailsElement
Stringmore details

The type of form element displayed.

more detailsElement
Stringmore details

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

more detailsElement

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

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.

The referenced expression must be what is defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also:
Example:
// Expression created within ExpressionInfos and is referenced in element
const expression = new ExpressionInfo({
  name: "alwaysHidden",
  expression: "1 == 0"
});

// Reference an already-defined visibilityExpression set within the ExpressionInfos
const fieldElement = new FieldElement({
  type: "field",
  fieldName: "inspemail",
  label: "Email address",
  visibilityExpression: "alwaysHidden"
});

Method Overview

Name Return Type Summary Class
*more details

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

more detailsElement
Objectmore details

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

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 an ArcGIS product. 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:
Type Description
* 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:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.