FeatureFormViewModel

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

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

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 FormTemplateautocast

Since: ArcGIS Maps SDK for JavaScript 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.

See also

• Sample - Update Feature Attributes

• Sample - Advanced Attribute Editing

inputFields Array<(InputField|InputFieldGroup)>readonly

Deprecated since version 4.27. Instead use inputs.

The field and/or group inputs that make up the form FeatureForm widget.

inputs Array<(FieldInput|GroupInput|RelationshipInput)>readonly

Since: ArcGIS Maps SDK for JavaScript 4.27

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

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 Map

Since: ArcGIS Maps SDK for JavaScript 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 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 Boolean

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

updating Booleanreadonly

Since: ArcGIS Maps SDK for JavaScript 4.27

Indicates whether the form is currently updating.

valid Booleanreadonly

Indicates whether all of the input fields are valid.

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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.

emit(type, event){Boolean}

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String The name of the event.

event Object optional The event payload.

Returns

Type	Description
Boolean	true if a listener was notified

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(){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

• submit event

• submit() method

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

hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(type, listener){Object}

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

Parameters

type String|String[] 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(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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(fieldName, value)

Since: ArcGIS Maps SDK for JavaScript 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.

value Number|String|null The value to set on the target field.

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(values, options){Object[]}

Since: ArcGIS Maps SDK for JavaScript 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

Event Details

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

• submit()

• getValues()

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

Fires when a field value is updated.

Properties

layer FeatureLayer The associated feature layer.

feature Graphic The associated feature.

fieldName String The updated field.

value Number|String|null The updated field value.

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