Edit features in 3D with the Editor widget

This sample shows how to use the Editor widget in 3D. This widget is useful as it provides an out-of-the-box experience to help streamline the editing experience within an application.

How it works

The widget automatically recognizes if there are any editable feature layer(s) within the scene. If there are, the layer or layers will display within the widget. Based on the editing functionality set on the feature layer, you can Edit existing features and/or Add new features.

The Editor widget uses the same coding pattern as other widgets, i.e. you must specify the view to be used by the widget.

1
2
3
4
const editor = new Editor({
  view: view
  // Pass in any other additional property as needed
});

Lastly, we add the widget to application using the View's UI.

1
2
// Add widget to top-right of the view
view.ui.add(editor, "top-right");

When points use 3D object symbol layer, the editing tool allows you to configure size and rotation interactively by using the 3D manipulators:

For the editing tool to identify the size and the rotation, you need to set them as visual variables in the renderer:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
const renderer = {
  type: "unique-value", // autocasts as new UniqueValueRenderer()
  // define visual variable for size and rottion and connect to the corresponding fields
  visualVariables: [
    {
      // size can be modified with the interactive handle
      type: "size",
      field: "SIZE",
      axis: "height",
      valueUnit: "meters"
    },
    {
      // rotation can be modified with the interactive handle
      type: "rotation",
      field: "ROTATION"
    }
  ],
};

For more samples, see Edit features with the Editor widget and Editor widget with configurations.

Snapping

It is also possible to configure snapping within the Editor widget. This is handled via the snappingOptions property or via the widget's UI. Snapping to self and to other features can be toggled separately.

Use the Ctrl key to dynamically toggle snapping on/off.

1
2
3
...
editor.snappingOptions.enabled = true;
editor.snappingOptions.featureSources = [{ layer: graphicsLayer }];

Tooltips, labels and sketching with constraints

The tooltips and segment labels provide useful information when creating or updating existing features. They can be enabled programmatically or toggled via the Editor widget's UI. Pressing Tab while drawing a new feature activates the tooltips' input mode. Then, one can set editing constraints to achieve greater control over segment lengths, angles, and elevation values.

1
2
3
...
editor.tooltipOptions.enabled = true;
editor.labelOptions.enabled = true;