Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/form/FormTemplate"], function(FormTemplate) { /* code goes here */ });
Class: esri/form/FormTemplate
Inheritance: FormTemplate Accessor
Since: ArcGIS API for JavaScript 4.16

A FormTemplate formats and defines the content of a FeatureForm for a specific Layer or Graphic. A FormTemplate allows the user to access values from feature attributes and values returned from Arcade expressions when a feature in the view is selected.

The FormTemplate can be set directly on a FeatureLayer, a FeatureForm, or its view model. The template consists of various elements that display a specific type of form data.

See also:
Example:
// Create the Form template and pass in elements
  const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  elements: [groupElement] // Add all elements to the template
});

// Add a new feature form with grouped fields
const form = new FeatureForm({
  container: "form",
  groupDisplay: "sequential", // only display one group at a time
  formTemplate: formTemplate // set it to template created above
});

Constructors

new FormTemplate(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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The description of the form.

more details
more detailsFormTemplate
Element[]

An array of form element objects that represent an ordered list of form elements.

more details
more detailsFormTemplate
ExpressionInfo[]

An array of objects or ExpressionInfo[] that reference Arcade expressions.

more details
more detailsFormTemplate
String

The string template for defining how to format the title used in a popup.

more details
more detailsFormTemplate

Property Details

declaredClass Stringreadonly inherited

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

description String

The description of the form.

An array of form element objects that represent an ordered list of form elements.

Elements are designed to allow the form author the ability to define the layout for fields when collecting and/or editing data.

Nested group elements are not supported.

See also:
Example:
// Create a new form template
const formTemplate = new FormTemplate({
  title: "Damage assessments",
  description: "Provide information for insurance",
  elements: [{ // Autocasts to new GroupElement
    type: "group",
    label: "Inspector Information",
    description: "Field inspector information",
    elements: [{
      // Autocasts to new FieldElement
      type: "field",
      fieldName: "inspector",
      label: "name"
    },{
      type: "field",
      fieldName: "inspemail",
      label: "Email address"
    },{
      type: "field",
      fieldName: "insp_date",
      label: "Date of inspection"
    }]
  }]
});
expressionInfos ExpressionInfo[]autocast

An array of objects or ExpressionInfo[] that reference Arcade expressions.

title String

The string template for defining how to format the title used in a popup. This appears at the top of the form.

Method Overview

NameReturn TypeSummaryClass
FormTemplate

Creates a deep clone of the FormTemplate class.

more details
more detailsFormTemplate
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsFormTemplate
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsFormTemplate

Method Details

clone(){FormTemplate}

Creates a deep clone of the FormTemplate class.

Returns:
TypeDescription
FormTemplateA deep clone of the FormTemplate instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...