FormTemplate | References | ArcGIS Maps SDK for JavaScript

import FormTemplate from "@arcgis/core/form/FormTemplate.js";

Inheritance:: FormTemplate→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.16

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.formTemplate, SubtypeSublayer.formTemplate,a FeatureForm.formTemplate, 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, or text 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.formTemplate, 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

Example

// 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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`FormTemplateProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`description`	`string \| null \| undefined`
`elements`	`FormElementUnion[] \| null \| undefined`
`expressionInfos`	`ExpressionInfo[] \| null \| undefined`
`preserveFieldValuesWhenHidden`	`boolean`
`title`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

description

Property

Type: string | null | undefined

The description of the form. It is possible to substitute a template string for a field value within this description.

Example

formTemplate.description = "The population of {County}, {State} is: {Population}";

elements

autocast Property

Type: FormElementUnion[] | null | undefined

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.
The AttachmentElement is not yet fully supported by the FeatureForm widget. Support will be added in a future release.

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

autocast Property

Type: ExpressionInfo[] | null | undefined

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 or false. Form Calculation expressions must return a string, date, boolean, or a number.

See also

preserveFieldValuesWhenHidden

Property

Type: boolean

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

See also

FieldElement.visibilityExpression

Default value: false

title

Property

Type: string | null | undefined

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.

Example

formTemplate.title = "{County}, {State}";

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`getFieldsUsed`	`getFieldsUsed<T extends Field = Field>(fieldsIndex?: FieldsIndex<T>, relationships?: Relationship[]): Promise<string[]>`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

getFieldsUsed

Method

Signature: getFieldsUsed <T extends Field = Field>(fieldsIndex?: FieldsIndex<T>, relationships?: Relationship[]): Promise<string[]>

Type parameters: <T extends Field = Field>

Since: ArcGIS Maps SDK for JavaScript 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 Element.label and Element.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 ExpressionInfo.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 the FormTemplate.

The FormTemplate contains an element whose Element.label or Element.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 RelationshipElement.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. The FormTemplate by itself does not possess enough information to determine the key field of a relationship.

The FormTemplate contains UtilityNetworkAssociationsElement.label or UtilityNetworkAssociationsElement.description that references the field via a template string, ie.{}, substitution syntax.

Parameters

Parameter	Type	Description	Required
fieldsIndex	`FieldsIndex`	The field index. It can be used to make case-insensitive lookup by name for fields used in the `FormTemplate`.
relationships	`Relationship[]`	An array of Relationship objects that define the relationships on the layer with which the `FormTemplate` is associated.

Returns: Promise<string[]>
Resolves with the names of the fields.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.