Skip to content

Commit d5ab7fb

Browse files
committed
add data types to extra variables
1 parent 6c6ed74 commit d5ab7fb

File tree

1 file changed

+35
-39
lines changed

1 file changed

+35
-39
lines changed

src/layer/variables/index.md

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ Here you can find the lists of:
1515

1616
The <QGISPluginName /> adds several variables that can be used in QGIS expressions:
1717

18-
| Variable name | Sample value | Scope | Description |
19-
|-----------------------------|-------------------------------|---------|-------------
20-
| `@mm_full_name` | `martin second name` | global | Full name of the currently logged in user, blank if the full name is not set |
21-
| `@mm_username` | `martin` | global | Username of the user currently logged in to <MainPlatformNameLink /> |
22-
| `@mm_user_email` | `martin@example.com` | global | Email of the user currently logged in to <MainPlatformName />|
23-
| `@mm_url` | `https://app.merginmaps.com` | global | URL of the <MainPlatformName /> service |
24-
| `@mm_project_name` | `Tree survey` | project | Name of the active <MainPlatformName /> project |
25-
| `@mm_project_full_name` | `martin/Tree survey` | project | Workspace and project name joined with a forward slash |
26-
| `@mm_project_version` | `42` | project | Current version of the active project |
18+
| Variable name | Type | Sample value | Description |
19+
|-------------------------|-----------------|----------------|-------------|
20+
| `@mm_full_name` | string| `Joe Schmoe` | Full name of the currently logged in user, blank if the full name is not set |
21+
| `@mm_username` | string | `joe-schmoe` | Username of the user currently logged in to <MainPlatformNameLink /> |
22+
| `@mm_user_email` | string | `joe.schmoe@mail.com` | Email of the user currently logged in to <MainPlatformName /> |
23+
| `@mm_url` | string | `https://app.merginmaps.com` | URL of the <MainPlatformName /> service |
24+
| `@mm_project_name` | string | `My project` | Name of the active <MainPlatformName /> project |
25+
| `@mm_project_full_name` | string | `my-team/My project` | Workspace and project name joined with a forward slash |
26+
| `@mm_project_version` | integer | `9` | Current version of the active project |
27+
2728

2829
A common use case is to use `@mm_username` or `@mm_user_email` as the [default value](../default-values/) for one of the fields in a survey layer to automatically track who has added (and/or modified) a particular record.
2930

@@ -39,36 +40,31 @@ With <MobileAppName />, it is possible to access GPS information using extra pos
3940

4041
Extra position variables can be used as [default values in feature forms](../default-values/).
4142

42-
Following variables are supported:
43-
- `@position_coordinate` - A point with the coordinates in WGS84.
44-
- `@position_latitude` - Latitude
45-
- `@position_longitude` - Longitude
46-
- `@position_elevation` - Orthometric or normal height
47-
- `@position_elevation_ellipsoid` - Ellipsoidal height
48-
- `@position_geoid_separation` - Geoid or quasi-geoid height (undulation)
49-
- `@position_direction` - The bearing measured in degrees clockwise from true north to the direction of travel.
50-
- `@position_ground_speed` - The ground speed, in meters/sec.
51-
- `@position_vertical_speed` - The vertical speed, in meters/sec.
52-
- `@position_magnetic_variation` - The angle between the horizontal component of the magnetic field and true north, in degrees. Also known as magnetic declination. A positive value indicates a clockwise direction from true north and a negative value indicates a counter-clockwise direction.
53-
- `@position_horizontal_accuracy` - The accuracy of the provided latitude-longitude value, in meters.
54-
- `@position_vertical_accuracy` - The accuracy of the provided altitude value, in meters.
55-
- `@position_from_gps` - True, if recorded/edited feature's geometry corresponds with current user's position (Position marker has the same location as the crosshairs marker).
56-
- `@position_satellites_visible` - Number of visible satellites.
57-
- `@position_satellites_used` - Number of satellites used to calculate the position.
58-
- `@position_gps_fix` - GPS fix, e.g. "RTK float"
59-
- `@position_gps_antenna_height` - Antenna height as defined in [GPS settings](../../field/mobile-app-ui/#gps-settings)
60-
- `@position_provider_type` - GPS device type.
61-
- for internal GPS, returns "internal"
62-
- for external GPS, returns "external"
63-
- `@position_provider_name` - GPS device name.
64-
- for internal GPS, returns "Internal"
65-
- for external GPS, returns the name of the external device
66-
- `@position_provider_address` - GPS device address.
67-
- for internal GPS, returns "<NoSpellcheck id="devicegps" />"
68-
- for external GPS, returns the MAC address
69-
- `@position_hdop` - Horizontal dilution of precision (HDOP)
70-
- `@position_vdop` - Vertical dilution of precision (VDOP)
71-
- `@position_pdop` - Position (3D) dilution of precision (PDOP)
43+
| Variable name | Type | Description |
44+
|-------------------------|-----------------|-------------|
45+
| `@position_coordinate` | geometry | A point with the coordinates in WGS84 |
46+
| `@position_latitude` | decimal | Latitude |
47+
| `@position_longitude` | decimal | Longitude |
48+
| `@position_elevation` | decimal | Orthometric or normal height |
49+
| `@position_elevation_ellipsoid` | decimal | Ellipsoidal height |
50+
| `@position_geoid_separation` | decimal | Geoid or quasi-geoid height (undulation) |
51+
| `@position_direction` | integer | The bearing measured in degrees clockwise from true north to the direction of travel |
52+
| `@position_ground_speed` | decimal | The ground speed, in meters/sec |
53+
| `@position_vertical_speed` | decimal | The vertical speed, in meters/sec |
54+
| `@position_magnetic_variation` | decimal | The angle between the horizontal component of the magnetic field and true north, in degrees. Also known as magnetic declination. A positive value indicates a clockwise direction from true north and a negative value indicates a counter-clockwise direction. |
55+
| `@position_horizontal_accuracy` | decimal | The accuracy of the provided latitude-longitude value, in meters |
56+
| `@position_vertical_accuracy` | decimal | The accuracy of the provided altitude value, in meters |
57+
| `@position_from_gps` | Boolean | *True* if recorded/edited feature's geometry corresponds with current user's position (position marker has the same location as the crosshairs marker) |
58+
| `@position_satellites_visible` | integer | Number of visible satellites |
59+
| `@position_satellites_used` | integer | Number of satellites used to calculate the position |
60+
| `@position_gps_fix` | string | GPS fix, e.g. "RTK float" |
61+
| `@position_gps_antenna_height` | decimal | Antenna height as defined in [GPS settings](../../field/mobile-app-ui/#gps-settings) |
62+
| `@position_provider_type` | string | GPS device type (for internal GPS, returns "internal", for external GPS, returns "external") |
63+
| `@position_provider_name` | string | GPS device name (for internal GPS, returns "Internal", for external GPS, returns the name of the external device) |
64+
| `@position_provider_address` | string | GPS device address (for internal GPS, returns "<NoSpellcheck id="devicegps" />", for external GPS, returns the MAC address) |
65+
| `@position_hdop` | decimal | Horizontal dilution of precision (HDOP) |
66+
| `@position_vdop` | decimal | Vertical dilution of precision (VDOP) |
67+
| `@position_pdop` | decimal | Position (3D) dilution of precision (PDOP) |
7268

7369
:::tip
7470
**Dilution of precision** (DOP) is a useful value that reflects the confidence level of achieved position precision. In addition to the horizontal and vertical accuracy, the appropriate DOP value (horizontal, vertical, or 3D) can be used to assess the overall quality of your survey accuracy.

0 commit comments

Comments
 (0)