require(["esri/form/FormTemplate"], (FormTemplate) => { /* code goes here */ });
import FormTemplate from "@arcgis/core/form/FormTemplate.js";
esri/form/FormTemplate
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 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.
// 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The description of the form. | FormTemplate | |
| Element[] | An array of form element objects that represent an ordered list of form elements. | FormTemplate | |
| ExpressionInfo[] | An array of objects or ExpressionInfo[] that reference Arcade expressions following the specification defined by the Form Constraint Profile or the Form Calculation Profile. | FormTemplate | |
| Boolean | Indicates whether to retain or clear a form's field element values. | FormTemplate | |
| String | The string template for defining how to format the title displayed at the top of a form. | FormTemplate |
Property Details
-
description
Propertydescription 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
PropertyexpressionInfos ExpressionInfo[]autocast -
An array of objects or ExpressionInfo[] that reference Arcade expressions following the specification defined by the Form Constraint Profile or the Form Calculation Profile. Form Constraint expressions must return either
trueorfalse. Form Calculation expressions must return a string, date, or a number.
-
preserveFieldValuesWhenHidden
PropertypreserveFieldValuesWhenHidden BooleanSince: ArcGIS Maps SDK for JavaScript 4.25FormTemplate since 4.16, preserveFieldValuesWhenHidden added at 4.25. -
Indicates whether to retain or clear a form's field element values. Use this property when a field element initially displays as visible but then updates to not display as a result of an applied visibilityExpression.
- Default Value:false
- See also
-
title
Propertytitle String -
The string template for defining how to format the title displayed at the top of a form.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| FormTemplate | Creates a deep clone of the FormTemplate class. | FormTemplate | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | FormTemplate | |
| 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. | FormTemplate |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
Methodclone(){FormTemplate} -
Creates a deep clone of the FormTemplate class.
ReturnsType Description FormTemplate A deep clone of the FormTemplate instance.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.