Component Attributes
The following properties are supported by the component.
All attributes are reactive and will make the map update whenever their values change.
Property | Type | Required | Default | Description |
---|---|---|---|---|
jwt-token | string | Yes | - | RS256 JSON Web Token to verify the authenticity of the request. |
width | %, px | Yes | - | Width of the map component. Example: 100% |
height | px | Yes | - | Height of the map component. Example: 400px |
client-id | string | No | - | Client identifier associated with the farm. |
embed-farm-id | string | No | - | Unique farm identifier. If included, the map will return the existing property (farm) allocated to the value. If empty, a random identifier will be assigned to the farm |
address | string | No | - | Sets the initial location for the map. The first matching result will be returned. It is recommended to use a fully structured address with street name, number, postcode and state. |
farm-name | string | No | - | Name of the farm. |
enable-building | boolean | No | false | Enable/disable building layer |
enable-kml | boolean | No | true | Enable/disable KML upload button. |
enable-paddock | boolean | No | false | Enable/disable paddock layer instead of cadastre layer. Important: Once the map is loaded, the state of the paddock layer should not be changed. Note: Only supported when region is au (the default) |
enable-save-btn | boolean | No | false | Enable/disable the save button on embed |
enable-search-bar | boolean | No | false | Enable/disable the embedded address bar. |
enable-summary | boolean | No | true | Enable/disable summary box. |
lat | number | No | - | Sets the latitude for the initial map location. |
lng | number | No | - | Sets the longitude for the initial map location. |
mode | edit /view | No | edit | Sets the mode for the map component. The default mode is "edit". To enable view-only mode set it to "view". |
property-boundary-color | string | No | #e54bff | Sets the color for the property boundary. The value must be a valid hex color. |