InputFieldGroup

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

This is a read-only support class that represents a group of input fields.

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
String

The name of the class.

more details
Accessor
String

The group's description.

more details
InputFieldGroup
Boolean

The result of visibilityExpression.

more details
InputFieldGroup
InputField[]

The input fields belonging to this group.

more details
InputFieldGroup
String

The group's label.

more details
InputFieldGroup
StringPossible Values:"expanded"|"collapsed"more detailsInputFieldGroup
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

declaredClass Stringreadonly inherited

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 be undefined.

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 String
Deprecated 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

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.

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
Since: 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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
Since: ArcGIS Maps SDK for JavaScript 4.25

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
Since: ArcGIS Maps SDK for JavaScript 4.25

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.