require(["esri/widgets/FeatureForm/GroupInput"], (GroupInput) => { /* code goes here */ });
import GroupInput from "@arcgis/core/widgets/FeatureForm/GroupInput.js";
esri/widgets/FeatureForm/GroupInput
This is a support class that represents a group of field inputs.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The input's description. | GroupInput | |
| String | Defines if the group should be expanded or collapsed when the form is initially displayed. | GroupInput | |
| FieldInput[]|RelationshipInput[] | The field inputs contained within the group. | GroupInput | |
| String | The group's label. | GroupInput | |
| Boolean | Indicates whether or not the group is open, ie. | GroupInput | |
| String | Possible Values:"expanded"|"collapsed" | GroupInput | |
| String | The type of input. | GroupInput | |
| Boolean | The group's visibility. | GroupInput |
Property Details
-
description
Propertydescription Stringreadonly -
The input's description.
-
initialState
PropertyinitialState StringreadonlySince: ArcGIS Maps SDK for JavaScript 4.28GroupInput since 4.27, initialState added at 4.28. -
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:"expanded"|"collapsed"
- Default Value:expanded
-
inputs
Propertyinputs FieldInput[]|RelationshipInput[]readonly -
The field inputs contained within the group.
-
label
Propertylabel Stringreadonly -
The group's label.
-
open
Propertyopen Boolean -
Indicates whether or not the group is open, ie. expanded.
-
type
Propertytype Stringreadonly -
The type of input.
For GroupInput the type is always "group".
-
visible
Propertyvisible Booleanreadonly -
The group's visibility. Note that the grouped input's visibility must be
trueif any fields within the group are required.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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
-
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");