Get Current Position Activity

Description

The Get Current Position activity gets the current position of the device running the workflow.

Usage

You may need to get the current location of the user. You could get the user's current position using the Get Current Position activity then use the Set Map Extent activity to center the currently selected map on the user's location.

Inputs

Enable High Accuracy

Optional

Type: Boolean

Whether to request the best possible location data.

Maximum Age

Optional

Type: Number

The maximum age (in milliseconds) of a cached position that will be accepted.

If not specified, the activity obtains a fresh location.

Timeout

Optional

Type: Number

The amount of time (in milliseconds) to wait for a location.

The default is 20000 (20 seconds).

Use Multiple Readings

Optional

Type: Boolean

Whether to use multiple readings to improve the accuracy of the geolocation result.

Accuracy Threshold

Optional

Type: Number

The device-reported accuracy in meters that must be reached before a reading is considered valid. This value is only used when Use Multiple Readings is true.

The default is 10 meters.

If the Timeout is reached before a valid reading is obtained, the best reading obtained prior to the Timeout is provided.

Outputs

position

Type: esri.Point (3.x, 4.x)*

The position in WGS84.

accuracy

Type: Number

Represents the accuracy of the latitude and longitude properties, expressed in meters.

altitude

Type: Number

Represents the position's altitude in meters, relative to sea level.

This value can be Null if the implementation cannot provide the data.

altitudeAccuracy

Type: Number

Represents the position's altitude in meters, relative to sea level.

This value can be Null if the implementation cannot provide the data.

heading

Type: Number

Represents the direction in which the device is traveling.

This value, specified in degrees, indicates how far off from heading true north the device is.

If the device is unable to provide heading information, this value is Null.

latitude

Type: Number

Represents the position's latitude in decimal degrees.

longitude

Type: Number

Represents the position's longitude in decimal degrees.

speed

Type: Number

Represents the velocity of the device in meters per second.

This value can be Null.

timestamp

Type: Number

Represents the time (in Unix Epoch milliseconds) at which the location was retrieved.

receiverName

Type: String

The name of the receiver used to get the location.

pdop

Type: Number

Position Dilution Of Precision. Error caused by the relative positions of the GPS satellites.

hdop

Type: Number

Horizontal Dilution Of Precision. The horizontal component of PDOP.

vdop

Type: Number

Vertical Dilution Of Precision. The vertical component of PDOP.

fixType

Type: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Number

An integer between 0 and 8 that represents the type of GNSS location fix.

0 = Invalid; 1 = GPS; 2 = Differential GPS; 3 = Precise Positioning Service; 4 = Real Time Kinematic (Fixed); 5 = Real Time Kinematic (Floating); 6 = Estimated; 7 = Manual Input; 8 = Simulation.

correctionAge

Type: Number

The age of the differential correction being applied to the location(s).

stationId

Type: Number

The well known ID of the station used for differential correction.

numberOfSatellites

Type: Number

The number of satellites used in calculating the position.

averageAccuracy

Type: Number

The average horizontal accuracy, in meters.

averageAltitudeAccuracy

Type: Number

The average vertical accuracy, in meters.

averagedPositions

Type: Number

The number of positions used to determine the average location.

standardDeviation

Type: Number

The standard deviation of the average.

errorCode

Type: Number

Represents the reason of an error occurring when using the geolocating device.

This value will be defined if there was an error.

errorMessage

Type: String

Represents the reason of an error occurring when using the geolocating device. This value will be defined if there was an error.

* Geocortex Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of host application. See Underlying Technologies for information.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Supported Environments

Environments capable of running this activity

Server

 

Client

Geocortex Web

Geocortex Mobile

Geocortex Viewer for HTML5

Web AppBuilder

Partially Supported Environments

The following outputs are supported by Geocortex Mobile only:

Some of these outputs are used with high-precision GNSS devices only.

Offline Support

This activity works when the device is offline.

Version Information

Supported from: Geocortex Viewer for HTML5 2.9, Web AppBuilder for ArcGIS 2.4.

© 2020 VertiGIS North America Ltd. All Rights Reserved.

Documentation Version 5.19