Feature Form

ESM:
Use dark colors for code blocksCopy
1
import "@arcgis/map-components/components/arcgis-feature-form";
CDN:
No specific import is needed for this component.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
group-display
"all" | "sequential"
heading-level
number
icon
string
label
string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
state
readonly
state
"disabled" | "ready"
time-zone
string

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

feature

Property
feature: Graphic

The associated feature containing the editable attributes.

Read more...

formTemplate

Property
formTemplate: FormTemplate

The associated template used for the form.

Read more...

groupDisplay

Property
groupDisplay: "all" | "sequential"

Defines how groups will be displayed to the user.

Attribute
group-display
Default value
"all"

headingLevel

Property
headingLevel: number

Indicates the heading level to use for the title of the form.

Attribute
heading-level
Default value
2

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also
Attribute
icon
Default value
"form-field"

label

Property
label: string

The widget's default label.

Read more...

Attribute
label

layer

Property

Layer containing the editable feature attributes.

Read more...

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also
Attribute
reference-element

state

readonlyreflected

Attribute changes are reflected on the DOM.

Property
state: "disabled" | "ready"

The current state of the component.

Attribute
state
Default value
"disabled"

timeZone

Property
timeZone: string

The timezone displayed within the form.

Read more...

Attribute
time-zone

Slots

No slots to display.

Events

EventType
CustomEvent<{ name: "state"; }>
FeatureFormSubmitEvent
FeatureFormValueChangeEvent

arcgisPropertyChange

Event
arcgisPropertyChange: CustomEvent<{ name: "state"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

arcgisReady

Event
arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is is ready to be interacted with.

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

arcgisSubmit

Event
arcgisSubmit: FeatureFormSubmitEvent
bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

arcgisValueChange

Event
arcgisValueChange: FeatureFormValueChangeEvent

Fires when a field value is updated.

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
getValues(): Promise<any>
submit(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example
Use dark colors for code blocksCopy
1
2
3
4
const arcgisFeatureForm = document.querySelector("arcgis-feature-form");
document.body.append(arcgisFeatureForm);
await arcgisFeatureForm.componentOnReady();
console.log("arcgis-feature-form is ready to go!");
Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component.

Returns
Promise<void>

getValues

Method
getValues(): Promise<any>

Returns all of the field values, regardless of update status.

Returns
Promise<any>

submit

Method
submit(): Promise<void>

Fires the submit event.

Returns
Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.