<MapViewTypes.h> - MapView Enums

MapView enumerations."> <MapViewTypes.h> - MapView Enums | ArcGISQtCpp

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 LocationDataSourceStatus { Stopped, Starting, Started, Stopping, FailedToStart }
enum class LocationDisplayAutoPanMode { Off, Recenter, Navigation, CompassNavigation }
enum class LocationType { Location, NmeaLocation, Unknown }
enum class MGRSGridLabelUnit { KilometersMeters, Meters }
enum class NmeaAccuracyType { Gst, Gsa, Gga }
enum class NmeaFixType { Invalid, Standard, Dgps, Pps, Rtk, …, Simulation }
enum class NmeaGnssSystem { Unknown, Gps, Glonass, Galileo, Bds, …, Navic }
enum class SketchCreationMode { Unknown, Point, Polyline, Polygon, Multipoint }
enum class SketchResizeMode { None, Stretch, Uniform }
enum class SketchVertexEditMode { InteractionEdit, SelectOnly }
enum class USNGGridLabelUnit { KilometersMeters, Meters }
enum class WrapAroundMode { EnabledWhenSupported, Disabled }

Detailed Description

Type Documentation

[since Esri::ArcGISRuntime 100.0] 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.

[since Esri::ArcGISRuntime 100.0] enum class DrawStatus

Enumerates the possible draw status in the GeoView

Use this status to determine whether the content of a view is still drawing or drawing is completed. The drawing state of a GeoView can either be InProgress or Completed. For example, when using GeoView::exportImageAsync to take a screen capture of the view's visible area, you can use the draw status to determine whether the GeoView content has been rendered. If you need to ensure that an individual layer has loaded and is visible, examine the LayerViewState returned by the GeoView::layerViewState method.

The DrawStatus can be one of:

ConstantValueDescription
DrawStatus::InProgress0Drawing of the {Esri::ArcGISRuntime::GeoView} {GeoView} content is in progress.
DrawStatus::Completed1Drawing of the {Esri::ArcGISRuntime::GeoView} {GeoView} content is complete.

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

[since 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.

[since 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.

[since 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.

[since 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.

[since 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 that 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.

[since Esri::ArcGISRuntime 100.14] enum class LocationDataSourceStatus

The list of possible LocationDataSource statuses.

This is used to determine the status of a LocationDataSource.

The LocationDataSourceStatus can be one of:

ConstantValueDescription
LocationDataSourceStatus::Stopped0The data source is stopped.
LocationDataSourceStatus::Starting1The data source is starting.
LocationDataSourceStatus::Started2The data source has started.
LocationDataSourceStatus::Stopping3The data source is stopping.
LocationDataSourceStatus::FailedToStart4The data source has failed to start.

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

[since Esri::ArcGISRuntime 100.0] enum class LocationDisplayAutoPanMode

An enumeration of the various modes that define how the map view extent reacts to location changes.

The LocationDisplayAutoPanMode can be one of:

ConstantValueDescription
LocationDisplayAutoPanMode::Off0Displays the location symbol at the current location without adjusting the map view's extent, so no auto-panning is performed.
LocationDisplayAutoPanMode::Recenter1Centers the map view at the current location, and shows the location symbol. When the current location changes, the map view is automatically panned to re-center at the new location. Behavior is affected by the wander extent factor.
LocationDisplayAutoPanMode::Navigation2Pans the map view so that the current location symbol is shown near the bottom of the map view, and rotates the map view to align it with the direction of travel. When the current location or direction of travel changes the map view is automatically panned and rotated to maintain this position. To use this mode effectively, the device location must be moving at a speed greater than 0 meters per second. Behavior is affected by the navigation point height factor.
LocationDisplayAutoPanMode::CompassNavigation3Centers the map view at the current location, rotates the map view to align with the direction in which the device is currently, and shows the location symbol. When the current location or position of the device changes, the map view is automatically panned and rotated to maintain this position, thus if the device is spun in a circle, the map view stays aligned with the real world.

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

[since Esri::ArcGISRuntime 100.10] enum class LocationType

The list of Location types.

This is used to determine the Location type.

The LocationType can be one of:

ConstantValueDescription
LocationType::Location0A basic location.
LocationType::NmeaLocation1A location obtained from an NMEA location source.
LocationType::Unknown-1An unknown location.

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

[since 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.

[since Esri::ArcGISRuntime 100.10] enum class NmeaAccuracyType

The list of NMEA accuracy types.

The NmeaAccuracyType can be one of:

ConstantValueDescription
NmeaAccuracyType::Gst0An accuracy calculated from GST (pseudo-range error statistics) message.
NmeaAccuracyType::Gsa1An accuracy calculated from GSA (DOP and active satellites) message.
NmeaAccuracyType::Gga2An accuracy calculated from GGA (time, position, and fix-related data) message.

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

[since Esri::ArcGISRuntime 100.10] enum class NmeaFixType

The list of NMEA fix types.

Indicates the type of signal or technique being used by the GPS receiver to determine its location. For example it indicates the quality of the signal, or the accuracy and reliability of the location being reported. The fix type is determined by the receiver based on number of satellites visible, the type of GPS receiver and the GPS technology being used.

The NmeaFixType can be one of:

ConstantValueDescription
NmeaFixType::Invalid0An invalid GPS fix type. Indicates that there is no satellite signal being received or there are not enough satellites available for proper location determination.
NmeaFixType::Standard1A standard GPS fix type. Indicates a standard GPS signal, or Standard Positioning Service (SPS) is being used. SPS is the standard specified level of positioning and timing accuracy that is available, without qualification or restrictions, to any user on a continuous worldwide basis.
NmeaFixType::Dgps2A differential GPS fix type. Indicates that Differential GPS is being used to provide increased accuracy over SPS. This technique uses a network of fixed ground based reference stations to broadcast the difference between the positions indicated by the satellite systems and the known fixed positions.
NmeaFixType::Pps3A PPS GPS fix type. Indicates that Precise Positioning System, encrypted for government use is being used by the receiver. PPS is the most accurate positioning, velocity, and timing information continuously available, worldwide, from the basic GPS.
NmeaFixType::Rtk4A real time kinematic GPS fix type. A technique used in land survey based on the use of carrier phase measurements of the GPS signals where a single reference station provides the real-time corrections of even to a centimeter level of accuracy.
NmeaFixType::Frtk5A float real time kinematic GPS fix type. The type is very similar to the fixed RTK (NmeaFixType::RTK) method of calculating location, but is not as precise, typically around 20 cm to 1 meter accuracy range.
NmeaFixType::Estimated6An estimated GPS fix type. The type is the determination of a location based on computations of position given an accurately known point of origin and measurements of speed, heading and elapsed time.
NmeaFixType::Manual7A manual input mode GPS fix type. Indicates that the location has been manually entered into the GPS receiver, and is not based on the satellite system.
NmeaFixType::Simulation8A simulation mode GPS fix type.

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

[since Esri::ArcGISRuntime 100.10] enum class NmeaGnssSystem

Enumeration of supported GNSS (Global Navigation Satellite System) systems

The NmeaGnssSystem can be one of:

ConstantValueDescription
NmeaGnssSystem::Unknown0The unknown GNSS type. Used if GNSS System ID is unknown or NMEA version before v4.11 is used.
NmeaGnssSystem::Gps1The Global Positioning System.
NmeaGnssSystem::Glonass2The Russian Global Navigation Satellite System.
NmeaGnssSystem::Galileo3The European Union Global Navigation Satellite System.
NmeaGnssSystem::Bds4The BeiDou Navigation Satellite System. Is a Chinese satellite navigation system.
NmeaGnssSystem::Qzss5The Quasi-Zenith Satellite System. Is a Japanese satellite navigation system.
NmeaGnssSystem::Navic6The Navigation Indian Constellation. Was renamed from IRNSS (Indian Regional Navigation Satellite System).

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

[since Esri::ArcGISRuntime 100.12] enum class SketchCreationMode

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

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

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.

[since 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.

[since Esri::ArcGISRuntime 100.0] enum class WrapAroundMode

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

The WrapAroundMode can be one of:

ConstantValueDescription
WrapAroundMode::EnabledWhenSupported0Enable wrap around if it is supported. Wraparound can only be applied to a map view if the following requirements are met.
  • The map's full extent covers the entire world.
  • The MapView::spatialReference is either WGS 84 or Web Mercator Auxiliary Sphere.
  • Dynamic layers in the map are based on map services from ArcGIS Server 10.0 or higher.
WrapAroundMode::Disabled1Disabled

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

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