new UIDisplay(config, mapContainer)
Creates an instance of UIDisplay.
| Name | Type | Description |
|---|---|---|
config |
UIConfig |
The configuration object that contains the button state settings. |
mapContainer |
HTMLElement |
The container element for the map where UI will be injected. |
Methods
-
appendChildTopRight(content)
UIMap/UIDisplay/index.ts, line 280 -
Appends a given HTML element to the top-right UI container.
Name Type Description contentHTMLElement The HTML element to append to the container.
-
createLeftPanelInstance(){UILeftPanel}
UIMap/UIDisplay/index.ts, line 231 -
Creates a UILeftPanel instance, you need to use it, to use button methods.
Returns:
Type Description UILeftPanel The UILeftPanel instance. -
getAddressSearch(){SearchGeocoding}
UIMap/UIDisplay/index.ts, line 271 -
Gets the addresses search instance, you need to use it, to use button methods.
Returns:
Type Description SearchGeocoding The addressSearch instance. -
getExportButton(){ExportButton}
UIMap/UIDisplay/index.ts, line 222 -
Gets the Export button instance, you need to use it, to use button methods.
Returns:
Type Description ExportButton The ExportButton instance. -
getFilterButton(){FilterButton}
UIMap/UIDisplay/index.ts, line 204 -
Gets the Filter button instance, you need to use it, to use button methods.
Returns:
Type Description FilterButton The FilterButton instance. -
getFullScreen(){GoFullScreen|undefined}
UIMap/UIDisplay/index.ts, line 289 -
Gets the FullScreen button instance, you need to use it, to use button methods.
Returns:
Type Description GoFullScreen | undefined The fullscreen button instance. -
getGoMap(){GoMap}
UIMap/UIDisplay/index.ts, line 297 -
Returns goMap instance.
Returns:
Type Description GoMap The GoMap instance. -
getInfoButton(){InfoButton}
UIMap/UIDisplay/index.ts, line 213 -
Gets the Info button instance, you need to use it, to use button methods.
Returns:
Type Description InfoButton The InfoButton instance. -
getLinearMeasurementButton(){LinearMeasurementButton}
UIMap/UIDisplay/index.ts, line 168 -
Gets the LinearMeasurementButton button instance, you need to use it, to use button methods.
Returns:
Type Description LinearMeasurementButton The LinearMeasurementButton button instance. -
getMap3DButton(){Map3DButton}
UIMap/UIDisplay/index.ts, line 262 -
Gets the Map3D button instance, you need to use it, to use button methods.
Returns:
Type Description Map3DButton The Map3D button instance. -
getMapOptions(){GOMapOptions}
UIMap/UIDisplay/index.ts, line 305 -
Returns the configuration options for the map.
Returns:
Type Description GOMapOptions An object containing map options. -
getMeasurementBypolygonsButton(){MeasurementBypolygonsButton}
UIMap/UIDisplay/index.ts, line 195 -
Gets the MeasurementBypolygonsButton button instance, you need to use it, to use button methods.
Returns:
Type Description MeasurementBypolygonsButton The MeasurementBypolygonsButton button instance. -
getPointSelectionButton(){PointSelectionButton}
UIMap/UIDisplay/index.ts, line 177 -
Gets the PointSelectionButton button instance, you need to use it, to use button methods.
Returns:
Type Description PointSelectionButton The PointSelectionButton button instance. -
getPolygonMeasurementButton(){PolygonMeasurementButton}
UIMap/UIDisplay/index.ts, line 186 -
Gets the PolygonMeasurementButton button instance, you need to use it, to use button methods.
Returns:
Type Description PolygonMeasurementButton The PolygonMeasurementButton button instance. -
getRightFloatingPanelInstance(){UIRightFloatingPanel}
UIMap/UIDisplay/index.ts, line 244 -
Gets The RightPanel instance, you need to use it, to use the methods.
Returns:
Type Description UIRightFloatingPanel The RightPanel instance. -
getUIConfig(){UIConfig}
UIMap/UIDisplay/index.ts, line 159 -
Gets the current UI configuration.
Returns:
Type Description UIConfig The configuration object used to initialize the UI. -
getUserLocationButton(){UserLocationButton}
UIMap/UIDisplay/index.ts, line 253 -
Gets the user location Button instance, you need to use it, to use button methods.
Returns:
Type Description UserLocationButton The user location button instance. -
asyncinit(){Promise.<void>}
UIMap/UIDisplay/index.ts, line 66 -
Initializes the UIDisplay by rendering the buttons.
Returns:
Type Description Promise.<void> A promise that resolves when the UI is fully rendered. -
updateTranslation()
UIMap/UIDisplay/index.ts, line 315 -
Re-renders the UI to ensure translations stay in sync with the current language.