The Map Class manages the 2D map.
| Function Name | Since | Arguments | Return Type | Description |
|---|---|---|---|---|
| setVectorHudButtonVisible | 10.5.2 | value : <boolean> | void | Set the visibility of the vector hud button on the map (only available when viewers are hidden). By default the button is visible. |
| getVectorHudButtonVisible | 10.5.2 | <boolean> | Get the visibility of the vector hud button. | |
| startMeasuring | 10.5.2 | mode : <string> | void | Start the measure function. The user can complete a measurement by double-clicking. |
| stopMeasuring | 10.5.2 | void | Stop the measuring function and return to navigation. |
The following events can be fired :
| Event Name | Since | Event Properties | Description |
|---|---|---|---|
| mapMeasureStart | 10.5.2 | mode : <string> | Fired when the measure function started. |
| mapMeasureStop | 10.5.2 | mode : <string> | Fired when the measure function stopped. |
| mapMeasureUpdate | 10.5.2 | mode : <string> properties : <properties> | Fired when the measurement was updated. A measurement is updated when a new coordinate is measured. |
| mapMeasureComplete | 10.5.2 | mode : <string> properties : <properties> | Fired when the measurement was completed. A measurement is completed when a final coordinate is measured. A final coordinate is measured by double-clicking. |
| mapMeasureClear | 10.5.2 | mode : <string> | Fired when the current measurement was cleared. |