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

Types

Classes

[since Esri::ArcGISRuntime 100.1, deprecated] class ArcGISRuntime::PopupAttachmentListModel

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

Obtain a PopupAttachmentListModel from a PopupAttachmentManager.

The model will automatically fetch attachments from the underlying features so that they can be displayed in a view.

This class is a subclass of QAbstractListModel.

The model returns data for the following roles:

This class was introduced in Esri::ArcGISRuntime 100.1.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupAttachmentManager

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

In addition to the available constructors on PopupAttachmentManager, you can obtain a PopupAttachmentManager from PopupManager::attachmentManager.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupAttributeListModel

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

Obtain a PopupAttributeListModel from the PopupManager.

The model returns data for the following roles:

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupManager

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

This class works in conjunction with the PopupView in the ArcGIS Maps SDK Toolkit. The PopupView is used to display information about a GeoElement. For example, a PopupView could be used to display the attributes of an ArcGISFeature that is stored in a Feature Service. PopupManager provides the PopupView with the content to display in the view. It also contains many helper functions and properties to assist the PopupView with displaying and editing information related to the associated GeoElement.

An example workflow for displaying a PopupView using a PopupManager would be:

• Declare a PopupView and anchor it to a desired location.
• Perform an identify operation on a GeoView and select a Feature from the identify result.
• Create a Popup from the Feature.
• Optionally obtain the Popup's PopupDefinition and set the title, whether to show attachments, and so on.
• Create a PopupManager from the Popup.
• Assign the PopupView's popupManager property the PopupManager created in the previous step.
• Call the show() method to display the PopupView.
• Call the dismiss() method to hide the PopupView.

In order to use the PopupManager with a QML UI, the PopupManager, PopupAttachmentManager, PopupAttachmentListModel, and PopupAttributeListModel classes must be registered as QML Types. For example, the following lines could be added to the main.cpp to register the classes under the Esri.Samples namespace:

qmlRegisterUncreatableType<PopupManager>("Esri.Samples", 1, 0, "PopupManager", "PopupManager is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentManager>("Esri.Samples", 1, 0, "PopupAttachmentManager", "PopupAttachmentManager is uncreateable");
qmlRegisterUncreatableType<PopupAttributeListModel>("Esri.Samples", 1, 0, "PopupAttributeListModel", "PopupAttributeListModel is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentListModel>("Esri.Samples", 1, 0, "PopupAttachmentListModel", "PopupAttachmentListModel is uncreateable");

Relevant samples:

• Display clusters: Display a web map with a point feature layer that has feature reduction enabled to aggregate points into clusters.
• Show popup: Show predefined popups from a web map.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.12, deprecated] 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, deprecated] 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.

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.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] 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, deprecated] 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, deprecated] 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, deprecated] 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.

This enum was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] 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:

This enum was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] 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:

This enum was introduced in Esri::ArcGISRuntime 100.12.