ESM: import BatchAttributeForm from "@arcgis/core/widgets/BatchAttributeForm.js";
CDN: const BatchAttributeForm = await $arcgis.import("@arcgis/core/widgets/BatchAttributeForm.js");
Class: @arcgis/core/widgets/BatchAttributeForm
Since: 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
Example
const batchAttributeForm = new BatchAttributeForm({
container: batchAttributeFormDiv, //HTML div
features: featureCollection,
map: map, // Required if using Arcade expressions that use the global $map variable
}); new BatchAttributeForm(properties)
Parameter
optionalSee 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
});Show inherited properties Hide inherited properties
Property Details 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.
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"
});Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
Indicates if the widget is disabled. When true, the widget is not interactive and cannot be submitted.
The collection of features whose attributes are being edited.
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"
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.
Example
// form title will render as an <h3>
// group element labels will render as an <h4>
featureForm.headingLevel = 3;Icon displayed in the widget's button.
Inherited
Property id String
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.
The widget's label.
This property is useful whenever the widget is controlled by another one (e.g. Expand)
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.
Indicates whether the form is in a read-only state. If true, values cannot be modified.
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 Booleanreadonly
Indicates whether there are validation errors for any fields for any features.
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.
Inherited
Property visible 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 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".
Example
// Hides the widget in the view
widget.visible = false;Defines which elements are visible in the widget.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
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)} />
);
}Inherited
Method destroy()
Destroys the widget instance.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() 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);
});Inherited
Method postInitialize()
Executes after widget is ready for rendering.
Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
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.
Inherited
Method when(callback, errback){Promise}
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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
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
}); VisibleElements
An object containing properties that control the visibility of certain elements within the FeatureForm widget.
Default value is true. Indicates whether to display validation errors for fields that are not visible in the form.
Fires when the submit() method is called.
The name of the event.
The value is always "submit".
An array containing a result object for each feature in the form.
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
Fires when field values are updated.
The features affected by the value change.
The name of the field that was changed.
The name of the event.
The value is always "value-change".
The updated field value.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4