GroupInput | API Reference | ArcGIS Maps SDK for JavaScript 4.33

This is a support class that represents a group of batch attribute form inputs.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String\|null\|undefined	The input's description.	GroupInput
Boolean	Indicates whether the input pertains to all the features in the BatchAttributeForm in which the input belongs.	GroupInput
FieldInput []	An array of field inputs contained within the group.	GroupInput
String\|null\|undefined	The input's label.	GroupInput
Array<(FeatureLayer\|GeoJSONLayer\|SceneLayer\|SubtypeSublayer\|OrientedImageryLayer)>	An array of layers included in the BatchAttributeForm.	GroupInput
Boolean	Indicates whether the group should be expanded or collapsed.	GroupInput
String	The type of input.	GroupInput
Boolean	Indicates whether the GroupInput is visible.	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 String |null |undefinedreadonly

The input's description.

existsInAllLayers Property existsInAllLayers Boolean

Indicates whether the input pertains to all the features in the BatchAttributeForm in which the input belongs.

Default Value:true

inputs Property inputs FieldInput[]readonly

An array of field inputs contained within the group.

label Property label String |null |undefinedreadonly

The input's label.

layers Property layers Array<(FeatureLayer|GeoJSONLayer|SceneLayer|SubtypeSublayer|OrientedImageryLayer)>readonly

An array of layers included in the BatchAttributeForm. Each layer must support feature editing and field access.

The following layer types are supported:

FeatureLayer
GeoJSONLayer
SceneLayer (with featureLayer property)
SubtypeSublayer
OrientedImageryLayer

See also

BatchAttributeFormViewModel

open Property open Boolean

Indicates whether the group should be expanded or collapsed.

Default Value:true

type Property type Stringreadonly

The type of input.

For GroupInput the type is always "group".

visible Property visible Booleanreadonly

Indicates whether the GroupInput is visible. For this property to be true, the group, itself, must be visible and contain at least one child input that is visible.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	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");