Obsolete Members for ArcGISRuntime

The following members of class ArcGISRuntime are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Classes

(deprecated) class SketchEditConfiguration
(deprecated) class SketchEditor
(deprecated) class SketchStyle
(deprecated) class SketchVertex
(deprecated) class TaskWatcher

Types

(deprecated) enum class SketchCreationMode { Unknown, Point, Polyline, Polygon, Multipoint }
(deprecated) enum class SketchResizeMode { None, Stretch, Uniform }
(deprecated) enum class SketchVertexEditMode { InteractionEdit, SelectOnly }

Classes

[since Esri::ArcGISRuntime 100.12] class ArcGISRuntime::SketchEditConfiguration

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

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] class ArcGISRuntime::SketchEditor

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

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.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] class ArcGISRuntime::SketchStyle

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

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] class ArcGISRuntime::SketchVertex

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

If the pointIndex is greater or equal to 0, then it is a vertex. If the insertionIndex is greater or equal to 0, then it is a mid-vertex. This object cannot have both pointIndex and insertionIndex greater or equal to 0. When the associated sketch editor is modifying a point geometry, the partIndex and pointIndex will both be 0 for a valid vertex. Mid-vertices are not allowed for a single point geometry. When the associated sketch editor is modifying a multi-point geometry, the partIndex will be 0 for a valid vertex. Mid-vertices are not allowed for a multi-point geometry.

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.0] class ArcGISRuntime::TaskWatcher

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

TaskWatcher supports examining the state of a task along with the ability to cancel a task.

This class is only copyable for convenience. All copies are shallow copies and reference the same underlying task.

since Esri::ArcGISRuntime 200.2

This class was introduced in Esri::ArcGISRuntime 100.0.

Type Documentation

[since Esri::ArcGISRuntime 100.12] enum class SketchCreationMode

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

Enumerates the type of geometry and how it will be created by the SketchEditor.

ConstantValueDescription
SketchCreationMode::Unknown-1Unknown geometry.
SketchCreationMode::Point0Sketches a Point geometry.
SketchCreationMode::Polyline1Sketches a Polyline geometry incrementally vertex by vertex.
SketchCreationMode::Polygon2Sketches a Polygon geometry incrementally vertex by vertex.
SketchCreationMode::Multipoint10Sketches a Multipoint geometry.

This enum was introduced or modified in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] enum class SketchResizeMode

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

Describes how geometry is resized to fill its allocated space while editing geometry.

The SketchResizeMode can be one of:

ConstantValueDescription
SketchResizeMode::None0The geometry preserves its original size.
SketchResizeMode::Stretch1The geometry is resized to fill the destination dimensions. The aspect ratio is not preserved.
SketchResizeMode::Uniform2The geometry is resized to fill the destination dimensions while it preserves its native aspect ratio.

This enum was introduced or modified in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] enum class SketchVertexEditMode

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

Describes how vertices respond to user interaction.

The SketchVertexEditMode can be one of:

ConstantValueDescription
SketchVertexEditMode::InteractionEdit0Selection state and location of vertex can be updated through user interaction (i.e. tap, drag).
SketchVertexEditMode::SelectOnly1Only selection state of vertex can be updated through user interaction.

This enum was introduced or modified in Esri::ArcGISRuntime 100.12.

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