ESM: import GroupElement from "@arcgis/core/form/elements/GroupElement.js";
CDN: const GroupElement = await $arcgis.import("@arcgis/core/form/elements/GroupElement.js");
Class: @arcgis/core/form/elements/GroupElement
Since: ArcGIS Maps SDK 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. Use this to set grouped field configurations within a FeatureForm or Featurelayer formTemplate.
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
}); new GroupElement(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
The element's description providing the purpose behind it.
An array of field, relationship, and text elements to display as grouped. These objects represent an ordered list of form elements.
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"
A string value containing the field alias. This should not be used for referencing fields in Arcade expressions. Rather, the service fieldName should be referenced.
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.
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 as to make certain the specified field has either 1) a default value, or 2) is made visible to the end user to enter a value before submitting the form.
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 ];Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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.
Creates a deep clone of the GroupElement class.
Returns
Type Description GroupElement A deep clone of the GroupElement instance.Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4