import "@arcgis/map-components/components/arcgis-editor";The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
activeWorkflowreadonly | | |
auto-destroy-disabled | boolean | |
heading-level | number | |
hide-create-features-section | boolean | |
hide-edit-features-section | boolean | |
hide-labels-toggle | boolean | |
hide-snapping-controls-elements-enabled-toggle | boolean | |
hide-snapping-controls-elements-feature-enabled-toggle | boolean | |
hide-snapping-controls-elements-layer-list | boolean | |
hide-snapping-controls-elements-self-enabled-toggle | boolean | |
hide-tooltips-toggle | boolean | |
icon | string | |
label | string | |
| ||
| Array<EditorLayerInfo> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
show-snapping-controls-elements-header | boolean | |
| ||
statereadonly | 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-new-feature" | "ready" |
| ||
|
activeWorkflow
activeWorkflow: CreateFeaturesWorkflow | UpdateWorkflowA property indicating the current active workflow.
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
headingLevel
headingLevel: numberIndicates the heading level to use for title of the widget.
- Attribute
- heading-level
- Default value
- 4
hideCreateFeaturesSection
hideCreateFeaturesSection: boolean- Attribute
- hide-create-features-section
- Default value
- false
hideEditFeaturesSection
hideEditFeaturesSection: boolean- Attribute
- hide-edit-features-section
- Default value
- false
hideSnappingControlsElementsEnabledToggle
hideSnappingControlsElementsEnabledToggle: boolean- Attribute
- hide-snapping-controls-elements-enabled-toggle
- Default value
- false
hideSnappingControlsElementsFeatureEnabledToggle
hideSnappingControlsElementsFeatureEnabledToggle: boolean- Attribute
- hide-snapping-controls-elements-feature-enabled-toggle
- Default value
- false
hideSnappingControlsElementsLayerList
hideSnappingControlsElementsLayerList: boolean- Attribute
- hide-snapping-controls-elements-layer-list
- Default value
- false
hideSnappingControlsElementsSelfEnabledToggle
hideSnappingControlsElementsSelfEnabledToggle: boolean- Attribute
- hide-snapping-controls-elements-self-enabled-toggle
- Default value
- false
hideTooltipsToggle
hideTooltipsToggle: boolean- Attribute
- hide-tooltips-toggle
- Default value
- false
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.
- Attribute
- icon
- Default value
- "pencil"
labelOptions
labelOptions: SketchLabelOptionsOptions to configure the sketch labels shown next to each segment of the geometry being created or updated.
layerInfos
layerInfos: Array<EditorLayerInfo>An array of editing configurations for individual layers.
position
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
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string- Attribute
- reference-element
showSnappingControlsElementsHeader
showSnappingControlsElementsHeader: boolean- Attribute
- show-snapping-controls-elements-header
- Default value
- false
state
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-new-feature" | "ready"The widget's state.
- Attribute
- state
supportingWidgetDefaults
supportingWidgetDefaults: SupportingWidgetDefaultsThis property allows customization of supporting Editor widgets and their default behavior.
tooltipOptions
tooltipOptions: SketchTooltipOptionsOptions to configure the tooltip shown next to the cursor when creating or updating graphics.
Methods
| Method | Signature |
|---|---|
cancelWorkflow(): Promise<void> | |
componentOnReady(): Promise<void> | |
deleteFeatureFromWorkflow(): Promise<void> | |
destroy(): Promise<void> | |
startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void> | |
startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void> | |
startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void> | |
startUpdateWorkflowAtFeatureSelection(): Promise<void> | |
startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
startCreateFeaturesWorkflowAtFeatureCreation
startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>Parameters
| Parameter | Type | Optional? |
|---|---|---|
info |
- Returns
- Promise<void>
startCreateFeaturesWorkflowAtFeatureTypeSelection
startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>- Returns
- Promise<void>
startUpdateWorkflowAtFeatureEdit
startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>Parameters
| Parameter | Type | Optional? |
|---|---|---|
feature |
- Returns
- Promise<void>
startUpdateWorkflowAtFeatureSelection
startUpdateWorkflowAtFeatureSelection(): Promise<void>- Returns
- Promise<void>
startUpdateWorkflowAtMultipleFeatureSelection
startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise<void>Parameters
| Parameter | Type | Optional? |
|---|---|---|
candidates | Array<Graphic> |
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
{ name: "state" | "activeWorkflow"; } | |
undefined |
arcgisPropertyChange
arcgisPropertyChange: { name: "state" | "activeWorkflow"; }Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: undefinedEmitted when the component associated with a map view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.