Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/form/elements/FieldElement"], function(FieldElement) { /* code goes here */ });
Class: esri/form/elements/FieldElement
Inheritance: FieldElement Element
Since: ArcGIS API for JavaScript 4.16

A FieldElement form element defines how a feature layer's field participates in the FeatureForm. This is the preferred way to set field configurations within a feature form's or feature layer's formTemplate.

form template field elements

See also:
Example:
// Create the field element
const fieldElement1 = new FieldElement({
  fieldName: "inspector",
  label: "Inspector name"
});

const fieldElement2 = new FieldElement({
  fieldName: "inspemail",
  label: "Inspector email address",
  description: "Provide full email address including .com suffix"
});

const fieldElement3 = new FieldElement({
  fieldName: "placename",
  label: "Business name",
  editable: false
});

// Next pass in any elements to the FormTemplate
const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  elements: [fieldElement1, fieldElement2, fieldElement3] // Add all elements to the template
});

Constructors

new FieldElement(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the 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
CodedValueDomain|RangeDomain

The coded value domain or range domain of the field.

more details
more detailsFieldElement
Boolean

Indicates whether the field can be edited.

more details
more detailsFieldElement
String

The field name as defined by the feature layer.

more details
more detailsFieldElement
String

Contains a hint used to help editors while editing fields.

more details
more detailsFieldElement
TextBoxInput|TextAreaInput

The input user interface to use for the element.

more details
more detailsFieldElement
String

A string value containing the field alias.

more details
more detailsElement
String

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

more details
more detailsFieldElement
String

Indicates the type of form element.

more details
more detailsFieldElement
String

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

more details
more detailsElement

Property Details

description String inherited

The element's description providing the purpose behind it.

The coded value domain or range domain of the field. If it is defined, this domain takes precedence over domains defined within the form's fieldConfig.

editable Boolean

Indicates whether the field can be edited.

This does not change the underlying service's field and whether it can be edited.

Default Value:true
fieldName String

The field name as defined by the feature layer. Set this property to indicate which field to edit.

hint String

Contains a hint used to help editors while editing fields.

The input user interface to use for the element. The client application is responsible for defining the default user interface.

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

requiredExpression String

A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true and the element is visible, the element must have a valid value in order for the feature to be created or edited. When the expression evaluates to false, the element is not required. If no expression is provided, the default behavior is that the element is not required. If the referenced field is non-nullable, the required expression is ignored and the element is always required.

type String

Indicates the type of form element. FieldElement is of type, field.

For FieldElement the type is always "field".

Example:
// Create an array of elements. If the element is autocasted, the type property must be set.
elements: [{
  // autocastable as FieldElement
  type: "field",
  fieldName: "lastname",
  label: "Last name"
 },
 {
  type: "field",
  fieldName: "firstname",
  label: "First name"
 }]
visibilityExpression String inherited

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
FieldElement

Creates a deep clone of the FieldElement class.

more details
more detailsFieldElement
*

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 detailsFieldElement
Object

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

more details
more detailsFieldElement

Method Details

clone(){FieldElement}

Creates a deep clone of the FieldElement class.

Returns:
TypeDescription
FieldElementA deep clone of the FieldElement instance.
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...