GroupInput

AMD: require(["esri/widgets/FeatureForm/GroupInput"], (GroupInput) => { /* code goes here */ });
ESM: import GroupInput from "@arcgis/core/widgets/FeatureForm/GroupInput.js";
Class: esri/widgets/FeatureForm/GroupInput
Inheritance: GroupInput Accessor
Since: ArcGIS Maps SDK for JavaScript 4.27

This is a support class that represents a group of field inputs.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

The input's description.

GroupInput

Defines if the group should be expanded or collapsed when the form is initially displayed.

GroupInput

The field inputs contained within the group.

GroupInput

The group's label.

GroupInput

Indicates whether or not the group is open, ie.

GroupInput
Possible Values:"expanded"|"collapsed"GroupInput

The type of input.

GroupInput

The group's visibility.

GroupInput

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

description

Property
description Stringreadonly

The input's description.

initialState

Property
initialState Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.28 GroupInput 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

Property
inputs FieldInput[] |RelationshipInput[]readonly

The field inputs contained within the group.

label

Property
label Stringreadonly

The group's label.

open

Property
open Boolean

Indicates whether or not the group is open, ie. expanded.

state

Property
state String
Deprecated since version 4.28. Instead use open.

Possible Values:"expanded" |"collapsed"

Default Value:expanded

type

Property
type Stringreadonly

The type of input.

For GroupInput the type is always "group".

visible

Property
visible Booleanreadonly

The group's visibility. Note that the grouped input's visibility must be true if any fields within the group are required.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.