advanced-editing

This bundle adds tools to create, update and delete features.

Usage

No configuration is required! Default values are applied.

To use the features of this bundle, add one or more of the following tools to your app:

Configuration Reference

The following sample shows the configurable properties and its default values:

{
    "advanced-editing": {
        "Config": {
            "showSketching": true,
            "showSnappingControls": true,
            "allowGeometryEditing": true,
            "allowAttributeEditing": true,
            "allowAttachmentEditing": true,
            "allowMovingObject": true,
            "allowBasemapSnapping": false,
            "removeHelperGeometriesOnClose": true,
            "snappingEnabled": true,
            "selfSnappingEnabled": true,
            "featureSnappingEnabled": true,
            "gridSnappingEnabled": false,
            "snappingDistance": 6,
            "toggleGeometryEditModeOnClick": true,
            "gridEnabledToggle": true,
            "gridControls": true,
            "featureTemplates": {
                "groupBy": "layer",
                "filterText": "",
                "visibleElements": {
                    "filter": true
                }
            }
        }
    }
}

Configuration for FeatureLayers

The following properties can be added directly to layer configurations:

{
    "map": {
        "layers": [
            {
                "id": "mylayer",
                "type": "AGS_FEATURE",
                "url": ".../FeatureServer/0",
                "editingEnabled": true,
                "advancedEditing": {
                    "allowSnapping": true,
                    "allowAdd": true,
                    "allowUpdate": true,
                    "allowDelete": true
                }
            }
        ]
    }
}

Configurations options for advancedEditing:

MergeViewModel

This component is the view model for the MergeWorkflowWidget. The following properties can be configured:

External API

The external API allows developers to start the editing and get the resulting feature after the edit is complete.

Usage

Add the Editing reference to your component.

{
    "name": "_editing",
    "providing": "advanced-editing.Editing"
}

Create a new feature

Create a new feature for a specified FeatureLayer. Pass the layer ID of the according layer.

this._editing.createFeature("areas").then(
    result => {
        // handle result
    },
    reason => {
        // error case
    }
);

Edit an existing feature

Edit an existing feature that belongs to a FeatureLayer. Pass the feature that must be an instance of esri/Graphic.

const featureLayer = this._mapWidgetModel.map.findLayerById("areas");
const queryParams = featureLayer.createQuery();
queryParams.where = "1=1";
featureLayer.queryFeatures(queryParams).then(results => {
    const feature = results.features[0];
    this._editing.editFeature(feature).then(
        result => {
            // handle result
        },
        reason => {
            // error case
        }
    );
});

Create a new geometry

Pass the geometry type to create a new esri/geometry/Geometry.

this._editing.createGeometry("polygon").then(
    result => {
        // handle result
    },
    reason => {
        // error case
    }
);

Edit an existing geometry

Pass an existing instance of esri/geometry/Geometry to allow the user to edit it.

const geometry = new Polygon({
    rings: [
        [
            [356517.0185643031, 5710524.887694486],
            [356537.11723534466, 5710522.300539059],
            [356541.35057714465, 5710473.352524496],
            [356477.78500000015, 5710478.9120000005],
            [356517.0185643031, 5710524.887694486]
        ]
    ],
    spatialReference: {wkid: 25832}
});
this._editing.editGeometry(geometry).then(
    result => {
        // handle result
    },
    reason => {
        // error case
    }
);

EditorInterceptor

To get direct access to the initialization properties of the Editor widget (for example to customize additional properties or watch for events), use this extension point. You can register multiple advanced-editing.EditorInterceptor instances.

class MyEditorInterceptor {
    intercept(editModel) {
        // Add your code
    }
}

In your manifest.json file, register the interceptor as advanced-editing.EditorInterceptor:

components: [
    {
        name: "MyEditorInterceptor",
        provides: "advanced-editing.EditorInterceptor"
    }
];