BatchAttributeForm | API Reference | ArcGIS Maps SDK for JavaScript 4.33

The BatchAttributeForm widget enables users to edit the attributes of multiple features at once. Designed for batch editing workflows, it provides a dynamic form that adapts to the fields of the selected features. The BatchAttributeForm is ideal for scenarios where attribute consistency across multiple features is required, streamlining data management and reducing repetitive editing tasks.

Known Limitations

Currently, editing relationship elements and Attachments and are not supported within this widget. Users can edit related records and attachments individually using the FeatureForm widget.
Editing utility network associations is not supported within this widget. Users can edit association fields individually using the FeatureForm widget.
Text elements are not supported within this widget.
The widget does not support editing features from layers with contingent values.

See also

Example

const batchAttributeForm = new BatchAttributeForm({
  container: batchAttributeFormDiv, //HTML div
  features: featureCollection,
  map: map, // Required if using Arcade expressions that use the global $map variable
});

Constructors

BatchAttributeForm Constructor new BatchAttributeForm(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

// Typical usage
const batchAttributeForm = new BatchAttributeForm({
  container: "batchAttributeFormDiv", // HTML div
  features: featureCollection, // Pass in the featureCollection that works with the widget
  map: map, // Required if using Arcade expressions that use the global $map variable
});

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
Number	The index of the active feature that is currently being edited.	BatchAttributeForm
HTMLElement\|null\|undefined	The ID or node representing the DOM element containing the widget.	Widget
String	The name of the class.	Accessor
Boolean	Indicates if the widget is disabled.	BatchAttributeForm
Collection<Graphic>	The collection of features whose attributes are being edited.	BatchAttributeForm
String	Defines how groups will be displayed to the user.	BatchAttributeForm
Number	Indicates the heading level to use for the title of the form.	BatchAttributeForm
String	Icon displayed in the widget's button.	BatchAttributeForm
String	The unique ID assigned to the widget when the widget is created.	Widget
String\|null\|undefined	The widget's label.	Widget
Map\|null\|undefined	A reference to the associated Map.	BatchAttributeForm
Boolean	Indicates whether the form is in a read-only state.	BatchAttributeForm
String\|null\|undefined	The time zone used to interpret date values in the form.	BatchAttributeForm
Boolean	Indicates whether there are validation errors for any fields for any features.	BatchAttributeForm
BatchAttributeFormViewModel	The view model for this widget.	BatchAttributeForm
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	Defines which elements are visible in the widget.	BatchAttributeForm

Property Details

activeFeatureIndex Property activeFeatureIndex Number

The index of the active feature that is currently being edited. This will be -1 when mode is batch. To enter single mode, set this property to the index in the features array of the feature you wish to edit individually. To enter batch mode, set this property to -1.

Default Value:-1

container Inherited Property container HTMLElement |null |undefinedautocast Inherited from Widget Autocasts from String

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.

Examples

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

disabled Property disabled Boolean

Indicates if the widget is disabled. When true, the widget is not interactive and cannot be submitted.

Default Value:false

features Property features Collection<Graphic>

The collection of features whose attributes are being edited.

groupDisplay Property groupDisplay String

Defines how groups will be displayed to the user.

Possible Values

Value	Description
all	All groups will be expanded.
sequential	A single group will be expanded at a time.

Possible Values:"all" |"sequential"

Default Value:"all"

headingLevel Property headingLevel Number

Indicates the heading level to use for the title of the form. By default, the title is rendered as a level 2 heading (e.g. <h2>Form title</h2>). In addition, group element labels default to a level 3 heading (e.g. <h3>Group element label</h3>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:2

See also

Heading Elements

Example

// form title will render as an <h3>
// group element labels will render as an <h4>
featureForm.headingLevel = 3;

icon Property icon String

Icon displayed in the widget's button.

Default Value:"edit-attributes"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label Inherited Property label String |null |undefined Inherited from Widget

The widget's label.

This property is useful whenever the widget is controlled by another one (e.g. Expand)

map Property map Map |null |undefined

A reference to the associated Map.

This property is required if working with Arcade expressions in the BatchAttributeForm that make use of the $map global variable.

readOnly Property readOnly Boolean

Indicates whether the form is in a read-only state. If true, values cannot be modified.

Default Value:false

timeZone Property timeZone String |null |undefined

The time zone used to interpret date values in the form. If this property is null or set to "unknown", date values are displayed in the time zone specified by the layer's preferredTimeZone. If none is provided there, date values are interpreted in UTC.

valid Property valid Booleanreadonly

Indicates whether there are validation errors for any fields for any features.

viewModel Property viewModel BatchAttributeFormViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the BatchAttributeFormViewModel class to access all properties and methods on the widget.

visible Inherited Property visible Boolean Inherited from Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

visibleElements Property visibleElements VisibleElementsautocast

Defines which elements are visible in the widget.

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
String	A utility method used for building the value for a widget's `class` property.	Widget
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
Object	Registers an event handler on the instance.	Widget
	Executes after widget is ready for rendering.	Widget
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Schedules widget rendering.	Widget
	This method is typically called when the user clicks a submit button or when the form is programmatically submitted and calls the FeatureLayer.applyEdits() method to update the features' attributes.	BatchAttributeForm
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

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.

classes Inherited Method classes(classNames){String} Inherited from Widget

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

repeatable

The class names.

Returns

Type	Description
String	The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Inherited from Widget

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean} Inherited from Widget

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Widget

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Widget

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on Inherited Method on(type, listener){Object} Inherited from Widget

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

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

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

submit Method submit()

This method is typically called when the user clicks a submit button or when the form is programmatically submitted and calls the FeatureLayer.applyEdits() method to update the features' attributes.

when Inherited Method when(callback, errback){Promise} Inherited from Widget

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new Promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VisibleElements Type Definition VisibleElements

An object containing properties that control the visibility of certain elements within the FeatureForm widget.

Property: errorsForNonVisibleFields Boolean

optional
Default value is true. Indicates whether to display validation errors for fields that are not visible in the form.

Event Overview

Name	Type	Summary	Class
	{name: "submit",results: SubmitResult [],valid: Boolean}	Fires when the submit() method is called.	BatchAttributeForm
	{features: Graphic [],fieldName: String,name: "value-change",value: Number\|String\|null\|undefined}	Fires when field values are updated.	BatchAttributeForm

Event Details

submit Event submit

Fires when the submit() method is called.

Properties: name String

The name of the event.

The value is always "submit".

results SubmitResult []

An array containing a result object for each feature in the form.

valid Boolean

Indicates whether the form is valid. This is true if all features in the form have valid attribute values, and false if any feature has at least one invalid attribute value.

value-change Event value-change

Fires when field values are updated.

Properties: features Graphic []

The features affected by the value change.

fieldName String

The name of the field that was changed.

name String

The name of the event.

The value is always "value-change".

value Number|String|null|undefined

The updated field value.