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 Featurelayer or SubtypeSubLayer.
The FormTemplate
allows the user to create and update feature attribute values which can be set directly on a Featurelayer, SubtypeSubLayer,a FeatureForm, a FeatureForm view model, or within the Editor's layerInfos.
The FormTemplate
is composed of various elements that display a specific type of form data. Each element is designed to allow the form author the ability to define the layout for fields when collecting and/or editing data.
Forms can be created with a variety of elements, including:
- FieldElement: Represents a single field in the form.
- GroupElement: Represents a group of
field
,relationship
, ortext
elements in the form. - RelationshipElement: Represents a relationship in the form.
- TextElement: Represents a text element in the form.
The FormTemplate
also supports the use of Arcade expressions to define form constraints and calculations. These expressions can be used to set the visibility of all form elements, make fields required, or dynamically calculate field values.
If a FormTemplate
is set on a FeatureLayer#formTemplate, SubtypeSublayer, or the Editor widget's layerInfos, it is used for all features within the specified layer. If the form's template is authored using the Map Viewer's authoring experience or Field Maps Designer, the resulting saved layer or web map item's JSON will contain a formInfo object.
- See also
// Create a FieldElement
const fieldElement = new FieldElement({
fieldName: "inspector",
label: "Inspector name"
});
// Create a TextElement
const textElement = new TextElement({
textFormat: "markdown",
text: "**This text is bold.**"
});
// Create the group element and pass in the field and text elements
const groupElement = new GroupElement({
label: "This is a group",
elements: [fieldElement, textElement]
});
// 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
});
// Add a formtemplate to a feature layer
const featureLayer = new FeatureLayer({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
outFields: ["*"],
formTemplate: formTemplate
});
map.add(featureLayer);
// Add a formtemplate to a subtype sublayer
const sublayer = new SubtypeSublayer({
layer: featureLayer,
subtype: "1",
formTemplate: formTemplate
});
// Add a formtemplate to the Editor's layerInfos
const editor = new Editor({
view: view,
layerInfos: [
{
layer: featureLayer,
formTemplate: formTemplate
}]
});
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 |
---|---|---|---|
The name of the class. | Accessor | ||
The description of the form. | FormTemplate | ||
An array of form element objects that represent an ordered list of form elements. | FormTemplate | ||
An array of ExpressionInfo objects that reference Arcade expressions following the specification defined by the Form Constraint Profile or the Form Calculation Profile. | FormTemplate | ||
Indicates whether to retain or clear a form's field element values. | FormTemplate | ||
The string defining how to format the title displayed at the top of a form. | FormTemplate |
Property Details
-
description
description String
-
The description of the form. It is possible to substitute a template string for a field value within this description.
ExampleformTemplate.description = "The population of {County}, {State} is: {Population}";
-
elements
elements Array<(FieldElement|GroupElement|RelationshipElement|TextElement)>autocast
-
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.
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
expressionInfos ExpressionInfo[]autocast
-
An array of ExpressionInfo objects that reference Arcade expressions following the specification defined by the Form Constraint Profile or the Form Calculation Profile. Form Constraint expressions must return either
true
orfalse
. Form Calculation expressions must return a string, date, boolean, or a number.
-
preserveFieldValuesWhenHidden
preserveFieldValuesWhenHidden Boolean
Since: 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 later updates to not be visible as a result of an applied visibilityExpression.
- Default Value:false
- See also
-
title
title String
-
The string defining how to format the title displayed at the top of a form. It is possible to substitute a template string for a field value within this description.
ExampleformTemplate.title = "{County}, {State}";
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
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 | |
Returns the names of all fields represented or referenced in any way by the FormTemplate. | getFieldsUsed | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
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
clone(){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
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.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.
-
Since: ArcGIS Maps SDK for JavaScript 4.30getFieldsUsed since 4.16, getFieldsUsed added at 4.30. -
Returns the names of all fields represented or referenced in any way by the FormTemplate. This includes fields where field elements exist in the form, as well as any fields referenced in the form's Arcade expressions and used in templated strings in the title and description of the form and in the label and description of its elements.
Below is a comprehensive list of all the possible ways in which a field can be utilized within a
FormTemplate
:- The
FormTemplate
contains a field element associated with the field. - The field is identified by the Arcade parser as being referenced in an expression that is used by one (or more) of the elements in the
FormTemplate
. Take note that expressions included in ExpressionInfo but not used by any of the elements are not considered. - The field is referenced via a template string, ie.
{}
, substitution syntax in the title or description properties of theFormTemplate
. - The
FormTemplate
contains an element whose label or description properties reference the field via a template string, ie.{}
, substitution syntax. - The
FormTemplate
contains TextElement.text that references the field via a template string, ie.{}
, substitution syntax. - The form contains a RelationshipElement that uses the field to order results, as specified in its orderByFields property.
- The field serves as a relationship key field for a relationship that is represented by a RelationshipElement in the
FormTemplate
. These fields will be included in the output only if a value is provided for the relationship parameter. TheFormTemplate
by itself does not possess enough information to determine the key field of a relationship.
ParametersfieldsIndex ObjectoptionalAn object that provides a reference to the fields used in the
FormTemplate
.relationships RelationshipoptionalAn array of Relationship objects that define the relationships on the layer with which the
FormTemplate
is associated.Returns - The
-
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 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"); }
-
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
toJSON(){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.