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 | 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:
| Constant | Value | Description |
|---|---|---|
AnimationCurve::Linear | 0 | Linear |
AnimationCurve::EaseInQuad | 1 | EaseInQuad |
AnimationCurve::EaseOutQuad | 2 | EaseOutQuad |
AnimationCurve::EaseInOutQuad | 3 | EaseInOutQuad |
AnimationCurve::EaseInCubic | 4 | EaseInCubic |
AnimationCurve::EaseOutCubic | 5 | EaseOutCubic |
AnimationCurve::EaseInOutCubic | 6 | EaseInOutCubic |
AnimationCurve::EaseInQuart | 7 | EaseInQuart |
AnimationCurve::EaseOutQuart | 8 | EaseOutQuart |
AnimationCurve::EaseInOutQuart | 9 | EaseInOutQuart |
AnimationCurve::EaseInQuint | 10 | EaseInQuint |
AnimationCurve::EaseOutQuint | 11 | EaseOutQuint |
AnimationCurve::EaseInOutQuint | 12 | EaseInOutQuint |
AnimationCurve::EaseInSine | 13 | EaseInSine |
AnimationCurve::EaseOutSine | 14 | EaseOutSine |
AnimationCurve::EaseInOutSine | 15 | EaseInOutSine |
AnimationCurve::EaseInExpo | 16 | EaseInExpo |
AnimationCurve::EaseOutExpo | 17 | EaseOutExpo |
AnimationCurve::EaseInOutExpo | 18 | EaseInOutExpo |
AnimationCurve::EaseInCirc | 19 | EaseInCirc |
AnimationCurve::EaseOutCirc | 20 | EaseOutCirc |
AnimationCurve::EaseInOutCirc | 21 | EaseInOutCirc |
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 complete. 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(Esri::ArcGISRuntime::Layer*) method.
The DrawStatus can be one of:
| Constant | Value | Description |
|---|---|---|
DrawStatus::InProgress | 0 | Drawing of the {Esri::ArcGISRuntime::GeoView} {GeoView} content is in progress. |
DrawStatus::Completed | 1 | Drawing 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:
| Constant | Value | Description |
|---|---|---|
GeoViewType::MapView | 0 | GeoView is a MapView, a 2D view. |
GeoViewType::SceneView | 1 | GeoView is a SceneView, a 3D view. |
GeoViewType::Unknown | -1 | Unknown 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::GeoView.
Not supported in Esri::ArcGISRuntime::SceneView for Esri::ArcGISRuntime::MGRSGrid, Esri::ArcGISRuntime::USNGGrid, and Esri::ArcGISRuntime::UTMGrid.
The GridLabelPosition can be one of:
| Constant | Value | Description |
|---|---|---|
GridLabelPosition::Geographic | 0 | Labels anchored to a geographical position on the map or scene view. |
GridLabelPosition::BottomLeft | 1 | x-labels anchored to bottom, y-labels anchored to left of map view. |
GridLabelPosition::BottomRight | 2 | x-labels anchored to bottom, y-labels anchored to right of map view. |
GridLabelPosition::TopLeft | 3 | x-labels anchored to top, y-labels anchored to left of map view. |
GridLabelPosition::TopRight | 4 | x-labels anchored to top, y-labels anchored to right of map view. |
GridLabelPosition::Center | 5 | x- and y-label axes pass through center of map view. |
GridLabelPosition::AllSides | 6 | Labels 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::GeoView.
The GridType can be one of:
| Constant | Value | Description |
|---|---|---|
GridType::Unknown | -1 | Unknown grid type. |
GridType::LatitudeLongitudeGrid | 0 | Esri::ArcGISRuntime::LatitudeLongitudeGrid - Latitude and longitude (graticules). |
GridType::UTMGrid | 1 | Esri::ArcGISRuntime::UTMGrid - Universal Transverse Mercator (UTM). |
GridType::MGRSGrid | 2 | Esri::ArcGISRuntime::MGRSGrid - Military Grid Reference System (MGRS). |
GridType::USNGGrid | 3 | Esri::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:
| Constant | Value | Description |
|---|---|---|
LatitudeLongitudeGridLabelFormat::DecimalDegrees | 0 | Label the grid lines (graticules) in decimal degrees. |
LatitudeLongitudeGridLabelFormat::DegreesMinutesSeconds | 1 | Label 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:
| Constant | Value | Description |
|---|---|---|
LayerViewStatus::Active | 1 | The layer in the view is active. A status of LayerViewStatus::Active indicates that the layer is being displayed in the view. |
LayerViewStatus::NotVisible | 2 | The layer in the view is not visible. |
LayerViewStatus::OutOfScale | 4 | The 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::Loading | 8 | The 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::Error | 16 | The 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.
| Constant | Value | Description |
|---|---|---|
LayerViewStatus::Warning | 32 | The 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:
| Constant | Value | Description |
|---|---|---|
LocationDataSourceStatus::Stopped | 0 | The data source is stopped. |
LocationDataSourceStatus::Starting | 1 | The data source is starting. |
LocationDataSourceStatus::Started | 2 | The data source has started. |
LocationDataSourceStatus::Stopping | 3 | The data source is stopping. |
LocationDataSourceStatus::FailedToStart | 4 | The 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:
| Constant | Value | Description |
|---|---|---|
LocationDisplayAutoPanMode::Off | 0 | Displays the location symbol at the current location without adjusting the map view's extent, so no auto-panning is performed. |
LocationDisplayAutoPanMode::Recenter | 1 | Centers 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::Navigation | 2 | Pans 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::CompassNavigation | 3 | Centers 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:
| Constant | Value | Description |
|---|---|---|
LocationType::Location | 0 | A basic location. |
LocationType::NmeaLocation | 1 | A location obtained from an NMEA location source. |
LocationType::Unknown | -1 | An 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:
| Constant | Value | Description |
|---|---|---|
MGRSGridLabelUnit::KilometersMeters | 0 | Labels are displayed in kilometers or meters based on view's scale. |
MGRSGridLabelUnit::Meters | 1 | Labels 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:
| Constant | Value | Description |
|---|---|---|
NmeaAccuracyType::Gst | 0 | An accuracy calculated from GST (pseudo-range error statistics) message. |
NmeaAccuracyType::Gsa | 1 | An accuracy calculated from GSA (DOP and active satellites) message. |
NmeaAccuracyType::Gga | 2 | An 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:
| Constant | Value | Description |
|---|---|---|
NmeaFixType::Invalid | 0 | An 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::Standard | 1 | A 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::Dgps | 2 | A 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::Pps | 3 | A 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::Rtk | 4 | A 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::Frtk | 5 | A 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::Estimated | 6 | An 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::Manual | 7 | A 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::Simulation | 8 | A 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:
| Constant | Value | Description |
|---|---|---|
NmeaGnssSystem::Unknown | 0 | The unknown GNSS type. Used if GNSS System ID is unknown or NMEA version before v4.11 is used. |
NmeaGnssSystem::Gps | 1 | The Global Positioning System. |
NmeaGnssSystem::Glonass | 2 | The Russian Global Navigation Satellite System. |
NmeaGnssSystem::Galileo | 3 | The European Union Global Navigation Satellite System. |
NmeaGnssSystem::Bds | 4 | The BeiDou Navigation Satellite System. Is a Chinese satellite navigation system. |
NmeaGnssSystem::Qzss | 5 | The Quasi-Zenith Satellite System. Is a Japanese satellite navigation system. |
NmeaGnssSystem::Navic | 6 | The 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.0] enum class USNGGridLabelUnit
Enumerates units for displaying values in the Esri::ArcGISRuntime::USNGGrid.
The USNGGridLabelUnit can be one of:
| Constant | Value | Description |
|---|---|---|
USNGGridLabelUnit::KilometersMeters | 0 | Labels are displayed in kilometers or meters based on view's scale. |
USNGGridLabelUnit::Meters | 1 | Labels 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:
| Constant | Value | Description |
|---|---|---|
WrapAroundMode::EnabledWhenSupported | 0 | Enable wrap around if it is supported. Wraparound can only be applied to a map view if the following requirements are met.
|
WrapAroundMode::Disabled | 1 | Disabled |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.