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 read-only support class that represents a group of field inputs.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | The input's description. more details | GroupInput | |
String | Defines if the group should be expanded or collapsed when the form is initially displayed. more details | GroupInput | |
FieldInput[]|RelationshipInput[] | The field inputs contained within the group. more details | GroupInput | |
String | The group's label. more details | GroupInput | |
String | Determines whether or not the group is open/expanded. more details | GroupInput | |
String | Possible Values:"expanded"|"collapsed"more details | GroupInput | |
String | For GroupInput the type is always "group". more details | GroupInput | |
Boolean | The group's visibility. more details | GroupInput |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description Stringreadonly
-
The input's description.
-
initialState StringreadonlySince: ArcGIS Maps SDK for JavaScript 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
-
-
The field inputs contained within the group.
-
label Stringreadonly
-
The group's label.
-
open String
-
Determines whether or not the group is open/expanded.
-
state StringDeprecated since version 4.28. Instead use open.
-
Possible Values:"expanded"|"collapsed"
- Default Value:expanded
-
type Stringreadonly
-
For GroupInput the type is always "group".
-
visible Booleanreadonly
-
The group's visibility.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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
-
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");