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

A GroupElement form element defines a container that holds a set of form elements that can be expanded, collapsed, or displayed together. This is the preferred way to set grouped field configurations within a feature form's or feature layer's formTemplate.

Form with individual field elementsForm with grouped field elements
field elementgroup element

Nested group elements are not supported.

See also:
Example:
const fieldElement1 = new FieldElement({
  fieldName: "inspector",
  label: "Inspector name"
});

const fieldElement2 = new FieldElement({
  fieldName: "inspemail",
  label: "Inspector email address",
  description: "Provide full email address including suffix"
});

const fieldElement3 = new FieldElement({
  fieldName: "placename",
  label: "Business name",
  editable: false
});

// Create the group element and pass in elements from above
const groupElement = new GroupElement({
  label: "Business contact information",
  description: "Enter the business contact name",
  elements:[fieldElement1, fieldElement2, fieldElement3]
});

// Next pass in any elements to the FormTemplate
const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  elements: [groupElement] // Add group element to the template
});

Constructors

new GroupElement(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 element's description providing the purpose behind it.

more details
more detailsElement
FieldElement[]

An array of field elements to display as grouped.

more details
more detailsGroupElement
String

Defines if the group should be expanded or collapsed when the form is initially displayed.

more details
more detailsGroupElement
String

A string value containing the field alias.

more details
more detailsElement
String

The type of the element.

more details
more detailsGroupElement
String

A reference to an Arcade expression that returns a boolean value.

more details
more detailsElement

Property Details

description String inherited

The element's description providing the purpose behind it.

An array of field elements to display as grouped. These objects represent an ordered list of form elements.

initialState String

Defines if the group should be expanded or collapsed when the form is initially displayed. If not provided, the default value is expanded.

Possible ValueDescription
collapsedThe grouped elements appear collapsed.
expandedThe grouped elements appear expanded.

Possible Values:"collapsed"|"expanded"

Default Value:expanded

A string value containing the field alias. This is not to Arcade expressions as the title is used instead.

type String

The type of the element. GroupElement is of type, group.

For GroupElement the type is always "group".

visibilityExpression String inherited

A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the default behavior is that the element is displayed. Care must be taken when defining a visibility expression for a non-nullable field i.e. to make sure that such fields either have default values or are made visible to users so that they can provide a value before submitting the form.

Method Overview

NameReturn TypeSummaryClass
GroupElement

Creates a deep clone of the GroupElement class.

more details
more detailsGroupElement
*

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 detailsGroupElement
Object

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

more details
more detailsGroupElement

Method Details

clone(){GroupElement}

Creates a deep clone of the GroupElement class.

Returns:
TypeDescription
GroupElementA deep clone of the GroupElement 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...