import type { LayerInfo, CreationInfo, EditorLayerUnion, State, AttachmentsProperties } from "@arcgis/core/widgets/Editor/types.js";Type definitions
LayerInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Configurations used for setting the layer's editable preferences within the Editor.
layer
- Type
- EditorLayerUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The associated layer containing the fields to edit.
formTemplate
- Type
- FormTemplate | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A template that defines the feature's form content. Use this when setting the fields for editing.
attachmentsOnCreateEnabled
- Since
- ArcGIS Maps SDK for JavaScript 5.0
(Since 4.26) Indicates whether to enable or disable attachments while creating features. Support for this is dependent upon whether this operation is supported on the FeatureLayer.capabilities.operations.
- Default value
- true
attachmentsOnUpdateEnabled
- Since
- ArcGIS Maps SDK for JavaScript 5.0
(Since 4.26) Indicates whether to enable or disable attachments while updating existing features. Support for this is dependent upon whether update or delete operations are supported on the FeatureLayer.capabilities.
The Editor will not display attachment file names if it is displaying image types. These images must have resize support within its corresponding FeatureLayer.capabilities, ie. FeatureLayer.capabilities.attachment.supportsResize is true. Attachment types, other than images, will display an icon and its corresponding file name.
- Default value
- true
CreationInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
This object provides required and optional properties needed when creating a new feature.
layer
- Type
- EditorLayerUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The associated layer for newly-created feature.
geometryToPlace
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The associated Mesh geometry for the newly-created feature. This property is only applicable when editing scene layers.
State
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "add-association-select-layer" | "add-association-select-feature" | "add-association-create-association" | "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "choosing-key-feature" | "creating-features" | "disabled" | "drawing-splitter-geometry" | "editing-attributes" | "editing-attachment" | "editing-existing-feature" | "editing-features" | "ready" | "reviewing-features" | "viewing-selection-list"
AttachmentsProperties
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- Partial<Pick<Attachments, "displayType" | "capabilities">>
FeatureFormProperties
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- Partial<Pick<FeatureForm, "groupDisplay">>
FeatureTemplatesProperties
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- Partial<Pick<FeatureTemplates, "groupBy" | "visibleElements" | "enableListScroll">>
SketchProperties
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- Partial<Pick<SketchViewModel, "defaultUpdateOptions" | "pointSymbol" | "polygonSymbol" | "polylineSymbol" | "updateOnGraphicClick">>
SupportingWidgetDefaults
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Set this to customize any supporting Editor widget's default behavior. Specific properties can be adjusted in the Attachments, FeatureForm, and FeatureTemplates widgets. In addition, it is possible to update specific properties within the SketchViewModel.
attachments
- Type
- AttachmentsProperties | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object containing properties specific for customizing the Attachments widget.
featureForm
- Type
- FeatureFormProperties | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object containing properties specific for customizing the FeatureForm widget.
featureTemplates
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object containing properties specific for customizing the FeatureTemplates widget.
sketch
- Type
- SketchProperties | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object containing properties specific for customizing the Sketch widget.
FailedOperation
- Since
- ArcGIS Maps SDK for JavaScript 5.0
error
- Type
- EsriError
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The read-only error message.
CreateFeatureState
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "create-new" | "update-pending"
MergeFeaturesWorkflowStep
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "choosing-key-feature"
UpdateFeaturesWorkflowStep
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "editing-features"
SplitFeatureWorkflowStep
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "drawing-splitter-geometry" | "reviewing-features"
FeatureInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
This object provides information required when updating a set of features.
layer
- Type
- EditorLayerUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The layer containing features.
objectIds
- Type
- ObjectId[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The object identifiers for features being edited
EditorSketchEventBase
- Since
- ArcGIS Maps SDK for JavaScript 5.0
layer
- Type
- EditorLayerUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The layer currently being edited.
EditorSketchCreateEvent
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- EditorSketchEventBase
detail
- Type
- SketchViewModelEvents["create"]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Detailed information returned within the "sketch-create" event.
EditorSketchUpdateEvent
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- EditorSketchEventBase
detail
- Type
- SketchViewModelEvents["update"]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Detailed information returned within the "sketch-update" event.