Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-editor";No specific import is needed for this component.
The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.
Demo Properties activeWorkflowreadonlyProperty
A property indicating the current active workflow.
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.
Property
headingLevel: number
Indicates the heading level to use for title of the widget.
Property
hideCreateFeaturesSection: boolean
Property
hideEditFeaturesSection: boolean
Property
hideLabelsToggle: boolean
Property
hideSnappingControlsElementsEnabledToggle: boolean
Property
hideSnappingControlsElementsFeatureEnabledToggle: boolean
Property
hideSnappingControlsElementsLayerList: boolean
Property
hideSnappingControlsElementsSelfEnabledToggle: boolean
Property
hideTooltipsToggle: boolean
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
label: string
The widget's default label.
Property
Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
Property
An array of editing configurations for individual layers.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
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.
Property
showSnappingControlsElementsHeader: boolean
Property
The SnappingOptions for editing.
state: "add-association-create-association" | "add-association-select-feature" | "add-association-select-layer" | "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "creating-features" | "disabled" | "editing-attachment" | "editing-attributes" | "editing-existing-feature" | "editing-features" | "ready" | "viewing-selection-list"
The current state of the component.
Property
This property allows customization of supporting Editor widgets and their default behavior.
Property
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state" | "activeWorkflow"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods cancelWorkflowMethod
cancelWorkflow(): Promise<void>
Method
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisEditor = document.querySelector("arcgis-editor");
document.body.append(arcgisEditor);
await arcgisEditor.componentOnReady();
console.log("arcgis-editor is ready to go!");Method
deleteFeatureFromWorkflow(): Promise<void>
Method
destroy(): Promise<void>
Permanently destroy the component.
Method
startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>
Method
startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>
Method
startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>
feature
Graphic
Method
startUpdateWorkflowAtFeatureSelection(): Promise<void>
Method
startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise<void>
candidates
Array<Graphic>
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