Skip to main content

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
TypeRequiredDefaultDescription
jwt-tokenstringYes-RS256 JSON Web Token to verify the authenticity of the request.
width%, pxYes-Width of the map component. Example: 100%
heightpxYes-Height of the map component. Example: 400px
client-idstringNo-Client identifier associated with the farm.
embed-farm-idstringNo-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
addressstringNo-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-namestringNo-Name of the farm.
enable-buildingbooleanNofalseEnable/disable building layer
enable-kmlbooleanNotrueEnable/disable KML upload button.
enable-paddockbooleanNofalseEnable/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-btnbooleanNofalseEnable/disable the save button on embed
enable-search-barbooleanNofalseEnable/disable the embedded address bar.
enable-summarybooleanNotrueEnable/disable summary box.
latnumberNo-Sets the latitude for the initial map location.
lngnumberNo-Sets the longitude for the initial map location.
modeedit/viewNoeditSets the mode for the map component. The default mode is "edit". To enable view-only mode set it to "view".
property-boundary-colorstringNo#e54bffSets the color for the property boundary. The value must be a valid hex color.