FeatureFormViewModel

AMD: require(["esri/widgets/FeatureForm/FeatureFormViewModel"], (FeatureFormVM) => { /* code goes here */ });
ESM: import FeatureFormVM from "@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js";
Class: esri/widgets/FeatureForm/FeatureFormViewModel
Inheritance: FeatureFormViewModel→Accessor
Since: ArcGIS Maps SDK for JavaScript 4.9

Provides the logic for the FeatureForm widget.

Known Limitations

This widget is not yet at full parity with the functionality provided in the 3.x AttributeInspector widget. There is currently no support for editing attachments or related records solely within this widget, although it is possible to edit attachments and relationship data via the Editor widget. Please refer to the Editor documentation for any known limitations regarding this.

See also
Example
let featureForm = new FeatureForm({
  viewModel: { // Autocasts as new FeatureFormViewModel()
    map: map, // Required if using Arcade expressions that use the global $map variable
    layer: featureLayer   // Associates the FeatureForm to the layer
  },
  container: "formDiv"
});

Constructors

FeatureFormViewModel

Constructor
new FeatureFormViewModel(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

The name of the class.

Accessor

The associated feature containing the editable attributes.

FeatureFormViewModel

The associated template used for the form.

FeatureFormViewModel

The field, group, or relationship inputs that make up the form FeatureForm widget.

FeatureFormViewModel

Layer containing the editable feature attributes.

FeatureFormViewModel

A reference to the associated Map.

FeatureFormViewModel

The widget's state.

FeatureFormViewModel

Indicates if the field's value can be submitted without introducing data validation issues.

FeatureFormViewModel

The timezone displayed within the form.

FeatureFormViewModel

Indicates whether the form is currently updating.

FeatureFormViewModel

Indicates whether all of the input fields are valid.

FeatureFormViewModel

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.

feature

Property
feature Graphic

The associated feature containing the editable attributes. A common way to access this is via the MapView or SceneView's hitTest() method.

Example
// Check if a user clicked on an incident feature.
view.on("click", function(event) {
  view.hitTest(event).then(function(response) {
    // Display the attributes of selected incident feature in the form
    if (response.results[0].graphic && response.results[0].graphic.layer.id == "incidentsLayer") {
       formVM.feature = result.results[0].graphic
    }
  });
});

formTemplate

Property
formTemplate FormTemplateautocast
Since: ArcGIS Maps SDK for JavaScript 4.16 FeatureFormViewModel since 4.9, formTemplate added at 4.16.

The associated template used for the form.

The formTemplate is where you configure how the form should display and set any associated properties for the form, e.g. title, description, field elements, etc.

inputs

Property
inputs Array<(FieldInput|GroupInput|RelationshipInput)>readonly
Since: ArcGIS Maps SDK for JavaScript 4.27 FeatureFormViewModel since 4.9, inputs added at 4.27.

The field, group, or relationship inputs that make up the form FeatureForm widget.

layer

Property
layer FeatureLayer |SceneLayer |SubtypeSublayer

Layer containing the editable feature attributes. If this layer is not specified, it is the same as the graphic's layer.

map

Property
map Map
Since: ArcGIS Maps SDK for JavaScript 4.27 FeatureFormViewModel since 4.9, map added at 4.27.

A reference to the associated Map.

This property is required if working with Arcade expressions in the FeatureForm that make use of the $map global variable.

state

Property
state Stringreadonly

The widget's state. Possible values are in the table below.

Value Description
ready Dependencies are met and has valid property values.
disabled Dependencies are missing and cannot provide valid inputs.

Possible Values:"ready" |"disabled"

Default Value:"disabled"

submittable

Property
submittable Boolean

Indicates if the field's value can be submitted without introducing data validation issues.

timeZone

Property
timeZone String
Since: ArcGIS Maps SDK for JavaScript 4.28 FeatureFormViewModel since 4.9, timeZone added at 4.28.

The timezone displayed within the form. If unknown, it will display the preferredTimeZone of the layer. If this layer property is not set, it will default to UTC.

updating

Property
updating Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.27 FeatureFormViewModel since 4.9, updating added at 4.27.

Indicates whether the form is currently updating.

valid

Property
valid Booleanreadonly

Indicates whether all of the input fields are valid.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Convenience method to find field inputs.

FeatureFormViewModel

Returns all of the field values, regardless of whether or not they were updated.

FeatureFormViewModel

Returns true if a named group of handles exist.

Accessor

Registers an event handler on the instance.

FeatureFormViewModel

Removes a group of handles owned by the object.

Accessor

The method used to set the updated field value.

FeatureFormViewModel

Fires the submit event.

FeatureFormViewModel

Validates whether a feature's attribute values conform to the defined contingent values.

FeatureFormViewModel

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.

findField

Method
findField(fieldName){FieldInput}

Convenience method to find field inputs.

Parameter
fieldName String

The input field to find.

Returns
Type Description
FieldInput Returns an instance of the FieldInput.

getValues

Method
getValues(){Object}

Returns all of the field values, regardless of whether or not they were updated.

Returns
Type Description
Object An object of key-value pairs of field names with their values.
See also
Example
function updateFeature() {
  // Get the updated field values
  const attributes = formVM.getValues();
  // Call applyEdits on the feature layer
  layer.applyEdits({
    // Pass in the updated field values
    updateFeatures: [{ attributes }]
  });
}

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");
}

on

Method
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

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");

setValue

Method
setValue(fieldName, value)
Since: ArcGIS Maps SDK for JavaScript 4.21 FeatureFormViewModel since 4.9, setValue added at 4.21.

The method used to set the updated field value.

This renders the new value within the form but does not update the underlying input feature's attributes.

Parameters
fieldName String

The target field to update.

The value to set on the target field.

submit

Method
submit()

Fires the submit event.

Example
// Listen for when 'submit' is called.
// Once it is fired, update the feature.
formVM.on("submit", updateFeature);

// When the DOM's button (btnUpdate) is clicked,
// Update attributes of the selected feature.
document.getElementById("btnUpdate").onclick = function() {
  // Fires feature form's submit event.
  formVM.submit();
}

validateContingencyConstraints

Method
validateContingencyConstraints(values, options){Object[]}
Since: ArcGIS Maps SDK for JavaScript 4.23 FeatureFormViewModel since 4.9, validateContingencyConstraints added at 4.23.

Validates whether a feature's attribute values conform to the defined contingent values.

Parameters
values String

A hash map of the form fields and their values.

options Object
optional

An object specifying additional options on what should be considered an error.

Specification
includeIncompleteViolations Boolean
optional

If true, return contingency violations for field groups that are invalid because values have not yet been specified for all their fields. If false, any of these violations are ignored.

Returns
Type Description
Object[] An array of objects, each representing a violation of a field group's contingent value rules.
Example
// Validate a features attribute values against the layer's contingent values
featureForm.on("value-change", () => {
  const validations = featureForm.viewModel.validateContingencyConstraints(featureForm.getValues());
  !!validations.length ? console.log("found some validation errors: ", validations) : console.log("no errors found!");
});

Event Overview

Name Type Summary Class
{valid: String[],invalid: String[],values: Object}

Fires when the submit() method is called.

FeatureFormViewModel
{layer: FeatureLayer,feature: Graphic,fieldName: String,value: Number|String|null,valid: Boolean}

Fires when a field value is updated.

FeatureFormViewModel

Event Details

submit

Event
submit

Fires when the submit() method is called. Call FeatureLayer.applyEdits() method to update a feature's attributes.

Properties
valid String[]

The valid field names.

invalid String[]

The invalid field names.

values Object

An object of key-value pairs of field names with all of their values, regardless of whether or not they were updated.

See also
Example
// Listen for the submit event.
featureFormVM.on("submit", function(){
  if (editFeature) {
    // Grab updated attributes from the form.
    const updated = featureFormVM.getValues();

    // Loop through updated attributes and assign
    // the updated values to feature attributes.
    Object.keys(updated).forEach(function(name) {
      editFeature.attributes[name] = updated[name];
    });

    // Setup the applyEdits parameter with updates.
    const edits = {
      updateFeatures: [editFeature]
    };
    applyEdits(edits);
  }
});

value-change

Event
value-change

Fires when a field value is updated.

Properties
layer FeatureLayer

The associated feature layer.

feature Graphic

The associated feature.

fieldName String

The updated field.

The updated field value.

valid Boolean

When true, the value conforms to the field's definition.

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