BatchFormInputs

ESM: import BatchFormInputs from "@arcgis/core/widgets/BatchAttributeForm/inputs/BatchFormInputs.js";
CDN: const BatchFormInputs = await $arcgis.import("@arcgis/core/widgets/BatchAttributeForm/inputs/BatchFormInputs.js");
Class: @arcgis/core/widgets/BatchAttributeForm/inputs/BatchFormInputs
Inheritance: BatchFormInputs→Accessor
Since: ArcGIS Maps SDK for JavaScript 4.33

The BatchFormInputs class is a read-only class that acts as a container for a set of inputs in a BatchAttributeFormViewModel.

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
Name Type Summary Class

Returns an array of all the field inputs in the form, including those in groups.

BatchFormInputs

The name of the class.

Accessor

The description for the form.

BatchFormInputs

An array of field or group inputs that make up the BatchAttributeForm.

BatchFormInputs

Returns an array of all features that have validation errors for one or more of the form inputs.

BatchFormInputs

Returns an array of all field inputs that have validation errors but are not visible in the form.

BatchFormInputs

The title of the form.

BatchFormInputs

Returns a boolean indicating whether all of the batch attribute form's field inputs are valid.

BatchFormInputs

Property Details

allFieldInputs

Property
allFieldInputs FieldInput[]readonly

Returns an array of all the field inputs in the form, including those in groups.

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 description for the form.

inputs

Property
inputs Array<(FieldInput|GroupInput)>readonly

An array of field or group inputs that make up the BatchAttributeForm.

invalidFeatures

Property
invalidFeatures Graphic[]readonly

Returns an array of all features that have validation errors for one or more of the form inputs.

invalidHiddenInputs

Property
invalidHiddenInputs FieldInput[]readonly

Returns an array of all field inputs that have validation errors but are not visible in the form.

title

Property
title String |null |undefined

The title of the form.

valid

Property
valid Booleanreadonly

Returns a boolean indicating whether all of the batch attribute form's field inputs are valid. This property will be false if any field input has a validation error.

See also

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.