SketchEditor Class

  • SketchEditor
  • class Esri::ArcGISRuntime::SketchEditor

    A class that allows the user to sketch geometries on the map. More...

    Header: #include <SketchEditor.h>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object

    This class is deprecated. We strongly advise against using it in new code.

    Public Functions

    virtual ~SketchEditor() override

    Signals

    Detailed Description

    Instances of this class represent a sketch editor that allows the user to interactively sketch geometries. You can sketch point, polygon, and polyline geometries from scratch, modify existing geometries, insert and remove vertices, undo and redo changes, and so on.

    The sketch editor must be set on the view using MapView::setSketchEditor and then started to perform the sketch based on user interactions.

    A new GeometryEditor class provides a successor to this class, supporting a wider array of use cases and providing a foundation for additional future geometry editing capabilities. If starting new development, use GeometryEditor in preference to SketchEditor.

    since Esri::ArcGISRuntime 200.2

    Use GeometryEditor instead.

    Relevant samples:

    • Sketch on map: This sample demonstrates how to use the Sketch Editor to edit or sketch a new point, line, or polygon geometry on to a map.

    Member Function Documentation

    [override virtual] SketchEditor::~SketchEditor()

    Destructor.

    [signal] void SketchEditor::creationModeChanged()

    Signal emitted when the creationMode changes.

    [signal] void SketchEditor::geometryChanged()

    Signal emitted when the geometry changes.

    [signal] void SketchEditor::opacityChanged()

    Signal emitted when opacity changes.

    [signal] void SketchEditor::selectedVertexChanged()

    Signal emitted when selectedVertex changes.

    [signal] void SketchEditor::startedChanged()

    Signal emitted when isStarted changes.

    [signal] void SketchEditor::styleChanged()

    Signal emitted when style changes.

    [signal] void SketchEditor::visibleChanged()

    Signal emitted when isVisible changes.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close