This is a read-only support class that represents a group of input fields.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | The group's description. more details | InputFieldGroup | |
Boolean | The result of | InputFieldGroup | |
InputField[] | The input fields belonging to this group. more details | InputFieldGroup | |
String | The group's label. more details | InputFieldGroup | |
String | Possible Values:"expanded"|"collapsed"more details | InputFieldGroup | |
String | Arcade expression to determine whether this group is visible or not. more details | InputFieldGroup | |
Boolean | The group's visibility. more details | InputFieldGroup |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description String
-
The group's description.
-
evaluatedVisibilityExpression Booleanreadonly
-
The result of
visibilityExpression
.Note, if
visibilityExpression
is not defined, the value of this property will beundefined
.
-
inputFields InputField[]readonly
-
The input fields belonging to this group.
-
label Stringreadonly
-
The group's label.
-
state String
-
Possible Values:"expanded"|"collapsed"
- Default Value:"expanded"
-
visibilityExpression StringDeprecated Since 4.23. Use groupElement.visibilityExpression
-
Arcade expression to determine whether this group is visible or not.
- Default Value:null
-
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)inheritedSince: 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();
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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");