GroupElement

A GroupElement form element defines a container that holds a set of form elements that can be expanded, collapsed, or displayed together. Use this to set grouped field configurations within a FeatureForm or Featurelayer formTemplate.

Form with individual field elements	Form with grouped field elements

Nested group elements are not supported.

See also

• FormTemplate
• FeatureForm
• FieldElement

• Sample - Update Feature Attributes

• Sample - Advanced Attribute Editing

Example

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

const fieldElement2 = new FieldElement({
  fieldName: "inspdate",
  label: "Inspection date",
  description: "Date inspection was handled",
  input: { // autocastable to DateTimePickerInput
    type: "datetime-picker",
      includeTime: true,
      min: 1547678342000,
      max: 1610836742000
    }
});

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

Property Details

declaredClass Stringreadonly inherited

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

description String inherited

The element's description providing the purpose behind it.

elements FieldElement[]autocast

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

:: esri-md class="panel trailer-1" Nested group elements are not supported. :::

initialState String

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

Possible Value	Description
collapsed	The grouped elements appear collapsed.
expanded	The grouped elements appear expanded.

Possible Values:"collapsed"|"expanded"

Default Value:expanded

label String inherited

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 the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined by the Form Constraint Profile. Expressions may reference field values using the $feature profile variable and must return either true or false.

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 element is always 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.

The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also

• ExpressionInfo

• Sample - Update Feature Attributes

• Form Constraint Arcade Profile

Example

// Expression created within ExpressionInfos and is referenced in element
const expression = new ExpressionInfo({
  name: "alwaysHidden",
  expression: "false"
});

// Reference an already-defined visibilityExpression set within the ExpressionInfos
const fieldElement = new FieldElement({
  type: "field",
  fieldName: "inspemail",
  label: "Email address",
  visibilityExpression: "alwaysHidden"
});

formTemplate.expressionInfos = [ expression ];
formTemplate.elements = [ fieldElement ];

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key 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(){GroupElement}

Creates a deep clone of the GroupElement class.

Returns

Type	Description
GroupElement	A 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 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.

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

Type	Description
*	Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	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");
}

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}inherited

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

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.