var featureForm = new FeatureForm({
  viewModel: { // Autocasts as new FeatureFormViewModel()
    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.

description String

Since: ArcGIS API for JavaScript 4.16

The description of the form. If this is not set, it defaults to what is set within the FormTemplate.

This property was added at 4.16 to provide parity with the FormTemplate. The preferred way to set this property is via the form template's description property. The description property on the form or its view model will eventually be deprecated in a later release in favor of the setting it within the form template.

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

fieldConfig FieldConfig[]|FieldGroupConfig[]autocast

Deprecated since version 4.16. Use FieldElement and/or GroupElement instead.

Array of individual or grouped field configuration objects. This is where you specify what fields to display and how you wish to display them. It is possible to configure individual or grouped fields. For an example of individual field configurations, please refer to the Update FeatureLayer using ApplyEdits sample.

Starting with version 4.16, the preferred way to set the field or grouped field configurations is via FieldElement(s) or GroupElement(s) set within the form's template.

Currently, the field configuration settings take precedence over any FieldElement(s) that may be set within the form's template. The fieldConfigs property will be fully deprecated at a future release in favor of setting elements within the form's template.

When not set, all fields except for editor, globalID, objectID, and system maintained area and length fields will be included. Otherwise, it is up to the developer to set the right field(s) to override and display.

Examples:

// Individual field configurations without grouping
const featureForm = new FeatureForm({
  container: "formDiv",
  feature: graphic, // Pass in feature
  // Configure fields to display without grouping
  fieldConfig: [ // autocasts as FieldConfig
    {
      name: "Incident_desc",
      label: "Description"
    },{
      name: "Incident_Address",
      label: "Contact"
   }]
});

// Grouped field configurations
const featureForm = new FeatureForm({
  container: "formDiv",
  feature: graphic,
  fieldConfig: [{ // autocasts to FieldGroupConfig
    label: "Inspector", // group 1
    description: "Inspector information",
    // Individual field configurations within the group
    fieldConfig: [{
      name: "inspector",
      label: "Name"
    },
    {
      name: "inspemail",
      label: "Email address"
    }]
   }, {
    label: "Business", // group 2
    description: "Business information",
    // Individual field configurations within the group
    fieldConfig: [{
      name: "placename",
      label: "Business name"
    }, {
      name: "firstname",
      label: "First name"
    }]
  }]
});

formTemplate FormTemplateautocast

Since: ArcGIS API for JavaScript 4.16

The associated template used for the form.

The formTemplate is where you configure how the form should display. Properties, i.e. title, description, fieldConfigs, etc, set directly within the FeatureForm take precedence over any similar properties set within the formTemplate. This will change in a future release as the preferred way to set the form's properties is via it's template.

See also:

• Sample - Update Feature Attributes

• Sample - Advanced Attribute Editing

inputField InputField[]|InputFieldGroup[]readonly

The input fields and/or grouped field rendered by the FeatureForm widget.

layer FeatureLayer

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

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

title String

Since: ArcGIS API for JavaScript 4.16

The title of the form. If this is not set, it defaults to what is set within the FormTemplate.

This property was added at 4.16 to provide parity with the FormTemplate. The preferred way to set this property is via the form template's title property. The title property on the form or its view model will eventually be deprecated in a later release in favor of the setting it within the form template.

valid Boolean

Indicates whether all input fields are valid.

Method Overview

Method Details

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){InputField}

Convenience method to find input fields.

Parameter:

fieldName String The input field to find.

Returns:

Type	Description
InputField	Returns an instance of the InputField.

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.

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[] A event type, or an array of event types, to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can 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);
});

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

Event Overview

{valid: String[],invalid: String[],values: Object}

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

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 to the feature form's submit event.
featureForm.on("submit", function(){
  if (editFeature) {
    // Grab updated attributes from the form.
    const updated = featureForm.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.