FieldElement | API Reference | ArcGIS Maps SDK for JavaScript 4.30

A FieldElement form element defines how a feature layer's field participates in the FeatureForm. Use this approach to set field configurations within a feature form or feature layer 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 DatePickerInput
    type: "date-picker",
      min: "2010-01-15",
      max: "2030-01-15"
    }
});

const fieldElement3 = new FieldElement({
  fieldName: "placename",
  label: "Business name",
  editableExpression: "editing-disabled"
});

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

// Next pass in any elements to the FormTemplate
const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  expressionInfos: [{
    name: "editing-disabled",
    expression: "false",
    returnType: "boolean"
  }],
  elements: [fieldElement1, fieldElement2, fieldElement3, fieldElement4] // Add all elements to the template
});

Constructors

FieldElement Constructor 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

Type	Summary	Class
String	The name of the class.	Accessor
String	The element's description providing the purpose behind it.	Element
CodedValueDomain\|RangeDomain	The coded value domain or range domain of the field.	FieldElement
String	A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.	FieldElement
String	The field name as defined by the feature layer.	FieldElement
String	Contains a hint used to help editors while editing fields.	FieldElement
BarcodeScannerInput\|ComboBoxInput\|DatePickerInput\|DateTimeOffsetPickerInput\|DateTimePickerInput\|TextAreaInput\|TextBoxInput\|RadioButtonsInput\|SwitchInput\|TimePickerInput	The esri/form/elements/inputs/Input to use for the element.	FieldElement
String	A string value containing the field alias.	Element
String	A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.	FieldElement
String	Indicates the type of form element.	FieldElement
String	A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.	FieldElement
String	A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.	Element

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Inherited Property description String Inherited from Element

The element's description providing the purpose behind it.

domain Property domain CodedValueDomain |RangeDomainautocast

The coded value domain or range domain of the field.

editableExpression Property editableExpression String Since: ArcGIS Maps SDK for JavaScript 4.23 FieldElement since 4.16, editableExpression added at 4.23.

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

When this expression evaluates to true, it is possible to edit the field value, and vice-versa if false. If the referenced field on the feature service is not editable, the editable expression is ignored and the element is not editable.

The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.
It is required to set the map property when instantiating a FeatureForm widget and using expressions that make use of the $map variable.
Editing must be disabled if setting a field element's valueExpression. The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also

fieldName Property fieldName String

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

hint Property 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 esri/form/elements/inputs/Input to use for the element. The client application is responsible for defining the default user interface.

label Inherited Property label String Inherited from Element

A string value containing the field alias. This should not be used for referencing fields in Arcade expressions. Rather, the service fieldName should be referenced.

requiredExpression Property requiredExpression String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. An expression that evaluates to true results in the field element requiring the end user to provide a value for fieldName for the feature to be created or edited. If the expression evaluates to false, the end user is not required to provide a value to the element.

If the referenced fieldName is non-nullable, the requiredExpression is ignored and the element is always required.

The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.
It is required to set the map property when instantiating a FeatureForm widget and using expressions that make use of the $map variable.
The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline to this property.
Field and Group elements must be visible if the field or one of the grouped fields is required.

See also

Form Constraint Arcade Profile

Examples

// The diameter field requires a value to be created or edited
// if the inspectionStatus value is "Complete"
// if the status is not complete, then this field value is optional
const dbhFieldElement = new FieldElement({
  fieldName: "diameter",
  input: {
    type: "text-box"
  },
  requiredExpression: "tree-dbh",
  editableExpression: "editable"
});

layer.formTemplate = new FormTemplate({
  elements: [ dbhFieldElement ],
  expressionInfos: [{
    expression: "$feature.inspectionStatus == 'Complete'",
    name: "tree-dbh",
    title: "Tree DBH",
    returnType: "boolean"
  }, {
    expression: "true",
    name: "editable",
    returnType: "boolean"
  }]
});

// The field value will ALWAYS be required when editing with a form
const dbhFieldElement = new FieldElement({
  editable: true,
  fieldName: "diameter",
  input: {
    type: "text-box"
  },
  requiredExpression: "always-required",
  editableExpression: "editable"
});

layer.formTemplate = new FormTemplate({
  elements: [ dbhFieldElement ],
  expressionInfos: [{
    // An expression that always returns true
    expression: "true",
    name: "always-required",
    returnType: "boolean"
  }, {
    expression: "true",
    name: "editable",
    returnType: "boolean"
  }]
});

type Property type Stringreadonly

Indicates the type of form element.

For FieldElement the type is always "field".

valueExpression Property valueExpression String Since: ArcGIS Maps SDK for JavaScript 4.23 FieldElement since 4.16, valueExpression added at 4.23.

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

Once the expression evaluates, the form's field value updates to the expression's result.

The expression must follow the specification defined in the Form Calculation Profile. This expression references field values within an individual feature or in other layers and must return either a date, number, or string value.
Editing must be disabled, which may be done via the editableExpression.
The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also

Example

// Calculates the diameter based on the circumference field
const dbhFieldElement = new FieldElement({
  fieldName: "diameter",
  input: {
    type: "text-box"
  },
  valueExpression: "tree-dbh",
  // element must not be editable to enable valueExpression
  editableExpression: "not-editable"
});

layer.formTemplate = new FormTemplate({
  elements: [ dbhFieldElement ],
  expressionInfos: [{
    expression: "Round(DefaultValue($feature.circumference, 0) / PI, 1)",
    name: "tree-dbh",
    title: "Tree DBH",
    returnType: "boolean"
  }, {
    expression: "false",
    name: "not-editable",
    returnType: "boolean"
  }]
});

visibilityExpression Inherited Property visibilityExpression String Inherited from Element

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

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 element is always displayed. Care must be taken when defining a visibility expression for a non-nullable field as to make certain the specified field has either 1) a default value, or 2) is made visible to the end user to enter a value before submitting the form.

The expression must follow the specification defined in the Form Calculation Profile. This expression references field values within an individual feature or in other layers and must return either a date, number, or string value.
The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.
Field and Group elements must be visible if the field or one of the grouped fields is required.

See also

Example

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

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

formTemplate.expressionInfos = [ expression ];
formTemplate.elements = [ fieldElement ];

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
FieldElement	Creates a deep clone of the FieldElement class.	FieldElement
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Element
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Element

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){FieldElement}

Creates a deep clone of the FieldElement class.

Returns

Type	Description
FieldElement	A deep clone of the FieldElement instance.

fromJSON Inherited Method 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Inherited Method toJSON(){Object} Inherited from Element

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.