Attribute | Required | Values | Default Value | Explanation |
---|---|---|---|---|
type | No | any, GPS, network | GPS | Specifies which source of location data should be recorded at this field. |
startWith | No | form, page, field | form | When to start ‘listening’ for location data — as soon as the user enters the form (‘form’), as soon as the user enters the page containing this field (‘page’ — only valid if the location field is actually on a page), or not until the user reaches this particular field (‘field’). |
waitAtField | No | true, false | false | If true, the application will force the user to wait until a sufficiently accurate and recent (as specified by the maxAccuracyRadius and maxAge attributes respectively) location is received using the provider specified in the type attribute. The user must wait at this field until an acceptable location is found in the time since they entered this field, regardless of the setting on the startWith attribute. Once such a location is received the user can proceed to the next field. If false, the current best known location will be used if it is sufficiently recent and accurate and is from the specified provider, even if it was recorded before the user entered this location field. |
useBestKnownLocationOnTimeout | No | true, false | true | Whether or not to accept a sub-optimal location (in terms of accuracy, recency and provider) if no satisfactory location is detected after listening for timeout seconds. |
timeout | No | Any positive whole numberĀ (seconds) | 300s (5min) | Amount of time to wait before using the best known location regardless of whether or not it is sufficient in terms of accuracy, recency and provider. |
maxAge | No | Any positive whole numberĀ (seconds) | 600s (10min) | The maximum age that location data can be before it is deemed too old to record. |
maxAccuracyRadius | No | Any positive float (meters) | 75.0m | The maximum accuracy that location data can be before it is deemed too inaccurate to record, expressed as a float that represents the maximum accuracy radius in metres. |
doublePrecision | No | true, false | false | Whether to use double precision (64 bits) or single precision (32 bits) when storing latitude, longitude and altitude values |
storeAltitude | No | true, false | true | Whether or not the user’s altitude should be stored for this field (if the survey device supports it). |
storeBearing | No | true, false | false | Whether or not the user’s bearing should be stored for this field (if the survey device supports it). |
storeSpeed | No | true, false | false | Whether or not the user’s speed should be stored for this field (if the survey device supports it). |
storeAccuracy | No | true, false | true | Whether or not the accuracy of the final location data that is stored with this field should also be stored. |
storeProvider | No | true, false | false | Whether or not the location provider used to obtain the final location data should also be stored. |