GroupInput

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

description Stringreadonly

The input's description.

initialState Stringreadonly

Since: 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

inputs FieldInput[]|RelationshipInput[]readonly

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 String

Deprecated 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

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();

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.

hasHandles(groupKey){Boolean}inherited

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

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