Skip To Content ArcGIS for Developers Sign In Dashboard

<MapViewTypes.h> - MapView Enums

Collection of MapView enumerations. More...

Header: #include <MapViewTypes.h>

Types

enum class AnimationCurve { Linear, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, …, EaseInOutCirc }
enum class DrawStatus { InProgress, Completed }
enum class GeoViewType { MapView, SceneView, Unknown }
enum class GridLabelPosition { Geographic, BottomLeft, BottomRight, TopLeft, TopRight, …, AllSides }
enum class GridType { Unknown, LatitudeLongitudeGrid, UTMGrid, MGRSGrid, USNGGrid }
enum class LatitudeLongitudeGridLabelFormat { DecimalDegrees, DegreesMinutesSeconds }
enum class LayerViewStatus { Active, NotVisible, OutOfScale, Loading, Error, Warning }
enum class LocationDisplayAutoPanMode { Off, Recenter, Navigation, CompassNavigation }
enum class MGRSGridLabelUnit { KilometersMeters, Meters }
enum class USNGGridLabelUnit { KilometersMeters, Meters }
enum class WrapAroundMode { EnabledWhenSupported, Disabled }

Detailed Description

Type Documentation

enum class AnimationCurve

Enumerates types of animation curves.

The AnimationCurve can be one of:

ConstantValueDescription
AnimationCurve::Linear0Linear
AnimationCurve::EaseInQuad1EaseInQuad
AnimationCurve::EaseOutQuad2EaseOutQuad
AnimationCurve::EaseInOutQuad3EaseInOutQuad
AnimationCurve::EaseInCubic4EaseInCubic
AnimationCurve::EaseOutCubic5EaseOutCubic
AnimationCurve::EaseInOutCubic6EaseInOutCubic
AnimationCurve::EaseInQuart7EaseInQuart
AnimationCurve::EaseOutQuart8EaseOutQuart
AnimationCurve::EaseInOutQuart9EaseInOutQuart
AnimationCurve::EaseInQuint10EaseInQuint
AnimationCurve::EaseOutQuint11EaseOutQuint
AnimationCurve::EaseInOutQuint12EaseInOutQuint
AnimationCurve::EaseInSine13EaseInSine
AnimationCurve::EaseOutSine14EaseOutSine
AnimationCurve::EaseInOutSine15EaseInOutSine
AnimationCurve::EaseInExpo16EaseInExpo
AnimationCurve::EaseOutExpo17EaseOutExpo
AnimationCurve::EaseInOutExpo18EaseInOutExpo
AnimationCurve::EaseInCirc19EaseInCirc
AnimationCurve::EaseOutCirc20EaseOutCirc
AnimationCurve::EaseInOutCirc21EaseInOutCirc

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

enum class DrawStatus

Enumerates the possible draw status of a Esri::ArcGISRuntime::Map.

The DrawStatus can be one of:

ConstantValueDescription
DrawStatus::InProgress0Drawing is in progress.
DrawStatus::Completed1Drawing has completed.

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

enum class GeoViewType

Enumerates types of Esri::ArcGISRuntime::GeoView objects.

The GeoViewType can be one of:

ConstantValueDescription
GeoViewType::MapView0GeoView is a MapView, a 2D view.
GeoViewType::SceneView1GeoView is a SceneView, a 3D view.
GeoViewType::Unknown-1Unknown type

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

enum class GridLabelPosition

Enumerates the label positioning options for the Esri::ArcGISRuntime::Grid in the Esri::ArcGISRuntime::MapView.

The GridLabelPosition can be one of:

ConstantValueDescription
GridLabelPosition::Geographic0Labels anchored to a geographical position on the map view.
GridLabelPosition::BottomLeft1x-labels anchored to bottom, y-labels anchored to left of map view.
GridLabelPosition::BottomRight2x-labels anchored to bottom, y-labels anchored to right of map view.
GridLabelPosition::TopLeft3x-labels anchored to top, y-labels anchored to left of map view.
GridLabelPosition::TopRight4x-labels anchored to top, y-labels anchored to right of map view.
GridLabelPosition::Center5x- and y-label axes pass through center of map view.
GridLabelPosition::AllSides6Labels are anchored to top, right, bottom and left of map view.

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

enum class GridType

Enumerates the grid types that can be used in the Esri::ArcGISRuntime::MapView.

The GridType can be one of:

ConstantValueDescription
GridType::Unknown-1Unknown grid type.
GridType::LatitudeLongitudeGrid0Esri::ArcGISRuntime::LatitudeLongitudeGrid - Latitude and longitude (graticules).
GridType::UTMGrid1Esri::ArcGISRuntime::UTMGrid - Universal Transverse Mercator (UTM).
GridType::MGRSGrid2Esri::ArcGISRuntime::MGRSGrid - Military Grid Reference System (MGRS).
GridType::USNGGrid3Esri::ArcGISRuntime::USNGGrid - United States National Grid (USNG).

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

enum class LatitudeLongitudeGridLabelFormat

Enumerates the possible formats for Latitude-Longitude values used in grid labels.

The LatitudeLongitudeGridLabelFormat can be one of:

ConstantValueDescription
LatitudeLongitudeGridLabelFormat::DecimalDegrees0Label the grid lines (graticules) in decimal degrees.
LatitudeLongitudeGridLabelFormat::DegreesMinutesSeconds1Label the grid lines (graticules) in degrees, minutes and seconds.

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

enum class LayerViewStatus
flags LayerViewStatusFlags

The status of a layer in the Esri::ArcGISRuntime::GeoView.

This status is used to determine whether a layer is displaying in a MapView or SceneView or whether it is still loading, not visible, out of scale, or has encountered an error or warning. Each layer can have multiple states at the same time. For example, a layer could be both LayerViewStatus::NotVisible and l {LayerViewStatus} {LayerViewStatus::OutOfScale}, or it could be LayerViewStatus::NotVisible and LayerViewStatus::Loading. These multiple states are represented using a flags enumeration.

A status of LayerViewStatus::Active indicates that the layer is being displayed in the view. Note, that some of the layer view states are not possible together. For example, a layer cannot be both LayerViewStatus::Active and LayerViewStatus::NotVisible at the same time.

If you implement a layer list in a table of contents (TOCs), you can use the layer view status to manage the TOC user interface. For example, you could gray out the layer if it is LayerViewStatus::OutOfScale, or you could show a spinning icon if the layer is LayerViewStatus::Loading. If the layer list contains a GroupLayer that is LayerViewStatus::NotVisible then its child layers will be LayerViewStatus::NotVisible. If the GroupLayer is visible, then each child layer can be either visible or LayerViewStatus::NotVisible.

If the layer completely fails to load or render you will encounter a LayerViewStatus::Error. If the layer fails to render some of its content then you will encounter a LayerViewStatus::Warning. This could be due to the temporary loss of a network connection, failing layer requests or exceeding the max feature count. In both cases you will find more details about the problem in the LayerViewState::error.

The LayerViewStatus can be one of:

ConstantValueDescription
LayerViewStatus::Active1The layer in the view is active. A status of LayerViewStatus::Active indicates that the layer is being displayed in the view.
LayerViewStatus::NotVisible2The layer in the view is not visible.
LayerViewStatus::OutOfScale4The layer in the view is out of scale. A status of LayerViewStatus::OutOfScale indicates that the view is zoomed outside of the scale range of the layer. If the view is zoomed too far in (e.g. to a street level) it is beyond the max scale defined for the layer. If the view has zoomed to far out (e.g. to global scale) it is beyond the min scale defined for the layer.
LayerViewStatus::Loading8The layer in the view is loading. After loading has completed, the layer will be available for display in the view. If there was a problem loading the layer, the status will be set to LayerViewStatus::Error and the LayerViewState::error property will provide details on the specific problem.
LayerViewStatus::Error16The layer in the view has an unrecoverable error.

When the status is LayerViewStatus::Error, the layer cannot be rendered in the view. For example, it may have failed to load, be an unsupported layer type or contain invalid data.

The LayerViewState::error property will provide more details about the specific problem which was encountered. Depending on the type of problem, you could: - call Esri::ArcGISRuntime::Layer::retryLoad - remove the layer from the Map or Scene - inspect the data.

ConstantValueDescription
LayerViewStatus::Warning32The layer in the view has encountered an error which may be temporary. When the status is LayerViewStatus::Warning, the layer may still be displayed in the view. It is possible for the status to be both LayerViewStatus::Active and LayerViewStatus::Warning.

A warning status indicates that the layer has encountered a problem but may still be usable. For example, some tiles or features may be failing to load due to network failure or server error.

You should be aware that when a LayerViewStatus::Warning is received, the layer may not be showing all data or it may be showing data which is not up-to-date.

The LayerViewState::error property will provide more details about the specific problem which was encountered. Depending on the type of problem, you could: - check your network connection - check whether an online service is experiencing problems.

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

The LayerViewStatusFlags type is a typedef for QFlags<LayerViewStatus>. It stores an OR combination of LayerViewStatus values.

enum class LocationDisplayAutoPanMode

Enumerates types of auto panning with Esri::ArcGISRuntime::LocationDisplay.

The LocationDisplayAutoPanMode can be one of:

ConstantValueDescription
LocationDisplayAutoPanMode::Off0In this mode, the MapView only updates the position of the location symbol on the screen. It does not re-center. Therefore, it is possible that the location symbol may eventually move off the screen as location updates are received. The LocationDisplay defaults to this mode.
LocationDisplayAutoPanMode::Recenter1In this mode, the MapView attempts to keep the location symbol on-screen by re-centering the location symbol when the symbol moves outside a "wander extent". The wander extent is a rectangle that is the same shape as the MapView rectangle, is centered in the MapView, and whose size is a fraction of the size of the MapView rectangle. The fraction is called the wander extent factor. The location symbol may move freely within the wander extent, but as soon as the symbol exits the wander extent, the mapview re-centers map on the symbol. If the map is panned by the user while in this mode, the mode automatically changes to Off to prevent having to "fight" with the map (e.g. you pan to a new location but the MapView automatically pans back to the location symbol). However, if there is a zoom gesture (double-tap or pinch to zoom) or the MapView is rotated, the mode stays in Recenter, and the MapView zooms in/out or rotates around the location symbol.
LocationDisplayAutoPanMode::Navigation2This mode is best suited for in-vehicle navigation. In this mode, the location symbol is pinned to a point on the screen, and always points towards the top edge of the device. The MapView pans and rotates the map based on location updates and the direction the device is traveling in. Therefore, the location symbol appears stationary and always pointing towards the top edge, while the map underneath it appears to be moving and rotating. If the map is panned by the user while in this mode, the mode automatically changes to Off to prevent having to "fight" with the map (e.g. you pan to a new location but the MapView automatically pans back to the location symbol). However, if there is a zoom gesture (double-tap or pinch to zoom) or the MapView is rotated, the mode stays in Navigation, and the MapView zooms in/out or rotates around the location symbol.
LocationDisplayAutoPanMode::CompassNavigation3This mode is best suited for waypoint navigation when while walking. As in Navigation mode, the location symbol is pinned to a point on the screen, and always points towards the top edge of the device. However, the MapView pans and rotates the map based on location updates and the device's heading relative to the magnetic north (as opposed to the direction of travel in Navigation mode). The map reflects what lies ahead of the user as the user pivots around their location. If the map is panned by the user while in this mode, the mode automatically changes to Off to prevent having to "fight" with the map (e.g. you pan to a new location but the MapView automatically pans back to the location symbol). However, if there is a zoom gesture (double-tap or pinch to zoom) or the MapView is rotated, the mode stays in CompassNavigation, and the MapView zooms in/out or rotates around the location symbol.

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

enum class MGRSGridLabelUnit

Enumerates units for displaying values in the Esri::ArcGISRuntime::MGRSGrid.

The MGRSGridLabelUnit can be one of:

ConstantValueDescription
MGRSGridLabelUnit::KilometersMeters0Labels are displayed in kilometers or meters based on view's scale.
MGRSGridLabelUnit::Meters1Labels are always displayed in meters.

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

enum class USNGGridLabelUnit

Enumerates units for displaying values in the Esri::ArcGISRuntime::USNGGrid.

The USNGGridLabelUnit can be one of:

ConstantValueDescription
USNGGridLabelUnit::KilometersMeters0Labels are displayed in kilometers or meters based on view's scale.
USNGGridLabelUnit::Meters1Labels are always displayed in meters.

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

enum class WrapAroundMode

Enumerates the wraparound mode of the Esri::ArcGISRuntime::MapView.

The WrapAroundMode can be one of:

ConstantValueDescription
WrapAroundMode::EnabledWhenSupported0Enabled when supported
WrapAroundMode::Disabled1Disabled

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


Feedback on this topic?