import BatchAttributeForm from "@arcgis/core/widgets/BatchAttributeForm.js";const BatchAttributeForm = await $arcgis.import("@arcgis/core/widgets/BatchAttributeForm.js");- Inheritance:
- BatchAttributeForm→
Widget<BatchAttributeFormProperties>→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.33
The BatchAttributeForm provides a user-friendly interface for editing attributes. It supports both batch and single feature editing modes, allowing users to switch between editing all selected features at once or focusing on individual features as needed. It provides a dynamic form that adapts to the fields of the selected features, ensuring that editors can efficiently manage and update feature attributes. This is ideal when multiple features must share consistent attribute values, as it reduces redundant data entry.
Known Limitations
Currently, relationship elements and associations elements are not supported within this widget. Users can individually edit related records and association fields using the FeatureForm widget.
Example
const batchAttributeForm = new BatchAttributeForm({ container: formDiv, // id of HTML div features: featureCollection, map: map, // Required if using Arcade expressions that use the global $map variable});Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// Typical usageconst batchAttributeForm = new BatchAttributeForm({ container: "formDiv", // id of 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});Properties
| Property | Type | Class |
|---|---|---|
| | ||
container inherited | HTMLElement | null | undefined | |
declaredClass readonly inherited | ||
destroyed readonly inherited | ||
| | ||
| | ||
"all" | "sequential" | | |
| | ||
Icon["icon"] | | |
id inherited | ||
label inherited | ||
| | ||
| | ||
| | ||
| | ||
valid readonly | | |
| | ||
visible inherited | ||
| |
activeFeatureIndex
- Type
- number
The index of the active feature that is currently being edited. This will be -1 when BatchAttributeFormViewModel.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
Example
// Initialize BatchAttributeForm with single feature editingconst baf = new BatchAttributeForm({ activeFeatureIndex: 0, // -1 for batch editing mode. In this case, single editing mode. layerInfos: [ { layer: featureLayer, formTemplate }]}); container
- Type
- HTMLElement | null | undefined
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 containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.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 viewview.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 UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); disabled
- Type
- boolean
Indicates if the widget is disabled. When true, the widget is not interactive and cannot be submitted.
- Default value
- false
features
- Type
- Collection<Graphic>
The collection of features whose attributes are being edited.
Example
// Query for featuresconst { features } = await featureLayer.queryFeatures({ // Ensure the features have a complete set of attributes for use in the form outFields: "*",});// Initialize BatchAttributeFormconst batchAttributeForm = new BatchAttributeForm({ features // pass in the collection of features to edit}); headingLevel
- Type
- HeadingLevel
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.
- See also
- Default value
- 2
Example
// form title will render as an <h3>// group element labels will render as an <h4>form.headingLevel = 3; icon
- Type
- Icon["icon"]
Icon displayed in the widget's button.
- Default value
- "edit-attributes"
layerInfos
- Type
- AttributeFormSupportedLayerInfo[] | null | undefined
An array of objects containing a FormTemplate and its corresponding layer.
This allows per-layer overrides which provides a FormTemplate for building batch form templates. The formTemplate defined here overrides any formTemplate defined on the layer itself. Otherwise, the layer's own formTemplate is used if it exists.
Example
// Query for featuresconst { features } = await featureLayer.queryFeatures();
// Initialize BatchAttributeFormconst batchAttributeForm = new BatchAttributeForm({ features: features, // pass in the collection of features to edit layerInfos: [{ layer: featureLayer, formTemplate: { // This will override any formTemplate defined on the layer itself elements: [ { type: "field", fieldName: "fulladdr", label: "Full Address" } ] }, }]}); map
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
- Type
- boolean
Indicates whether the form is in a read-only state. If true, values cannot be modified.
- Default value
- false
timeZone
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 FeatureLayer.preferredTimeZone. If none is provided there, date values are interpreted in UTC.
valid
- Type
- boolean
Indicates whether there are validation errors for any fields for any features.
viewModel
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
- Type
- boolean
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 DefaultUI, 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 viewwidget.visible = false; visibleElements
- Type
- VisibleElements
Defines which elements are visible in the widget.
Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
goToFirstError(): void | | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
scheduleRender inherited | scheduleRender(): void | |
submit(): void | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- 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)} /> );} emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
goToFirstError
- Signature
-
goToFirstError (): void
Focus the form on the first input element with an error.
- Returns
- void
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
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
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
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);}); submit
- Signature
-
submit (): void
Usually, this is called when the user clicks a specified submit button or when the form is programmatically submitted and calls the FeatureLayer.applyEdits() method
to update the features' attributes.
- Returns
- void
Example
// Listen for when 'submit' is called on the form.// Once it is fired, update the features.form.on("submit", updateFeatures);// When the DOM's button (btnUpdate) is clicked,// execute the 'submit()' method.document.getElementById("btnUpdate").addEventListener("click", () => form.submit()); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.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});Events
| Name | Type |
|---|---|
submit inherited | |
value-change inherited |
submit
submit: CustomEvent<SubmitEvent> Fires when the BatchAttributeForm.submit() method is called.
value-change
value-change: CustomEvent<ValueChangeEvent> Fires when field values are updated.
Example
form.on("value-change", (event) => { const result = {}; for (const feature of form.features) { const value = form.viewModel.getValues(feature)[event.fieldName]; result[feature.getObjectId()] = typeof value === "number" ? new Date(value).toISOString() : value; } console.log(`Values for field ${event.fieldName}`, result);});