FieldElement

AMD: require(["esri/form/elements/FieldElement"], (FieldElement) => { /* code goes here */ });
ESM: import FieldElement from "@arcgis/core/form/elements/FieldElement";
Class: esri/form/elements/FieldElement
Inheritance: FieldElement Element Accessor
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 recommended approach 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: "inspdate",
  label: "Inspection date",
  description: "Date inspection was handled",
  input: { // autocastable to DateTimePickerInput
    type: "datetime-picker",
      includeTime: true,
      min: 1547678342000,
      max: 1610836742000
    }
});

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

const fieldElement4 = new FieldElement({
  fieldName: "floodinsur",
  label: "Flood insurance",
  input: { // autocastable to RadioButtonsInput
    type: "radio-buttons",
    noValueOptionLabel: "No value",
    showNoValueOption: true
  }
});

// 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, fieldElement4] // 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.
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
CodedValueDomain|RangeDomainmore details

The coded value domain or range domain of the field.

more detailsFieldElement
Booleanmore details

Indicates whether the field can be edited.

more detailsFieldElement
Stringmore details

The field name as defined by the feature layer.

more detailsFieldElement
Stringmore details

Contains a hint used to help editors while editing fields.

more detailsFieldElement
TextBoxInput|TextAreaInput|DateTimePickerInput|BarcodeScannerInput|ComboBoxInput|RadioButtonsInput|SwitchInputmore details

The input to use for the element.

more detailsFieldElement
Stringmore details

A string value containing the field alias.

more detailsElement
Stringmore details

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

more detailsFieldElement
Stringmore details

Indicates the type of form element.

more detailsFieldElement
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 inherited

The element's description providing the purpose behind it.

The coded value domain or range domain of the field.

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. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.

The input 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 Stringreadonly

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.

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class
FieldElementmore details

Creates a deep clone of the FieldElement class.

more detailsFieldElement
*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

clone(){FieldElement}

Creates a deep clone of the FieldElement class.

Returns:
Type Description
FieldElement A 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 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}inherited

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.