Class WMEMap

Index

Constructors

Methods

addDataLayer addDataMarker addDrawControl addEllipseControl addFooterControls addFooterMessages addLayer addLayers addMarker addMarkerLayer addMTEClosuresLayer addRasterTileLayer addRulerControl addSelectionMediator calculateBounds createDragElementHandler createDrawingContext createFogOfWarController createSnappingHandler drawMarkerOnMapCenter focus getAsyncLayerStylesPromise getBigJunctionLayer getDriveLayerController getEditableAreasLayer getEditSuggestionsIconLayer getEl getExtent getExtentPolygon getFarTurnPathLayer getHeight getLayerByName getLayers getLayersBitmask getLayersBy getLayerVisibility getLonLatFromViewPortPx getManagedAreasLayer getMapSelection getMapState getMarkerElement getMarkerLayer getNodeLayer getPannable getParkingLotUpdatesLayer getPixelFromLonLat getPlaceUpdatesLayer getProblemLayer getProjectedCenter getRepositoryByLayerName getResidentialPlaceUpdatesLayer getResolution getSegmentLayer getSegmentSuggestionLayer getSegmentSuggestionsGeoIconLayer getSelectableLayers getSize getSketchLayer getUnprojectedCenter getUnvalidatedUnprojectedCenter getUpdateRequestLayer getWazeMap getZoom getZoomForExtent hasMarker initializeLayers initializePlaceUpdateLayers initMapIssuesSelection initMapSelection initMapState isOnScreen isZoomOutEnabled moveByPx moveLayerToTop moveMarker moveTo mustGetLayerByName panDown panLeft panRight panUp refreshEarthEngineLayers refreshRoadLayer registerAccelerators registerLayerEvent registerMapEvent registerPriorityMapEvent removeAllFeaturesFromLayer removeDataMarker removeMarker removeMTEClosuresLayer resize resizeFromTopLeft setEditingMediator setLayerAttribution setLayerVisibility setMarker setProjectedCenter setSearchResult setSnapshotManager setUnprojectedCenter showConfirmationDialog showMapProblemLayer showUpdateRequestLayer toggleClass toggleDisallowedTurnsEditor togglePathsLayer toggleSVMode unregisterLayerEvent unregisterMapEvent updateRoadsVisibility updateSize zoomIn zoomOut zoomToExtent

Constructors

constructor

new WMEMap(options: { app: App; snapshotManager: SnapshotManager }): WMEMap
Parameters
- options: { app: App; snapshotManager: SnapshotManager }
Returns WMEMap

Methods

addDataLayer

addDataLayer(layerName: string): void
Parameters
- layerName: string
Returns void

addDataMarker

addDataMarker(
    layerName: string,
    shape: DataMarkerShape,
    options?: { style?: FeatureStyle },
): string
Parameters
- layerName: string
- shape: DataMarkerShape
- options: { style?: FeatureStyle } = {}
Returns string

addDrawControl

addDrawControl(
    options: {
        autoDestroy?: boolean;
        drawShape: DrawShape;
        layerName: string;
    },
): MapControlHandle
Parameters
- options: { autoDestroy?: boolean; drawShape: DrawShape; layerName: string }
Returns MapControlHandle

addEllipseControl

addEllipseControl(
callbacks: EllipseHandlerCallback,
options?: EllipseHandlerOptions,
): MapControlHandle
Parameters
- callbacks: EllipseHandlerCallback
- Optionaloptions: EllipseHandlerOptions
Returns MapControlHandle

addFooterControls

addFooterControls(): void
Returns void

addFooterMessages

addFooterMessages(): void
Returns void

addLayer

addLayer(layer: WazeFeatureLayer<WazeFeature>): void
Parameters
- layer: WazeFeatureLayer<WazeFeature>
Returns void

addLayers

addLayers(layers: WazeFeatureLayer<WazeFeature>[]): void
Parameters
- layers: WazeFeatureLayer<WazeFeature>[]
Returns void

addMarker

addMarker(
    layerName: string,
    lonlat: LonLat,
    options?: { classNames?: string[] },
): string
Parameters
- layerName: string
- lonlat: LonLat
- options: { classNames?: string[] } = {}
Returns string

addMarkerLayer

addMarkerLayer(
layerName: string,
__namedParameters?: { classNames?: string[]; hidden?: boolean },
): HTMLMarkerLayer
Parameters
- layerName: string
- __namedParameters: { classNames?: string[]; hidden?: boolean } = {}
Returns HTMLMarkerLayer

addMTEClosuresLayer

addMTEClosuresLayer(features: FeatureCollection): void
Parameters
- features: FeatureCollection
Returns void

addRasterTileLayer

addRasterTileLayer(
    layerName: string,
    layerUrl: { fileName: string; params?: ObjectLiteral; servers: string[] },
    layerOptions: RasterTileLayerOptions,
): void
Parameters
- layerName: string
- layerUrl: { fileName: string; params?: ObjectLiteral; servers: string[] }
- layerOptions: RasterTileLayerOptions
Returns void

addRulerControl

addRulerControl<MS extends "imperial" | "metric">(
props?: RulerProps<MS>,
): MapControlHandle
Type Parameters
- MS extends "imperial" | "metric"
Parameters
- Optionalprops: RulerProps<MS>
Returns MapControlHandle

addSelectionMediator

addSelectionMediator<W extends WazeFeature>(
selectableLayers: WazeFeatureLayer<W>[],
options: SelectionMediatorOptions<W>,
): SelectionMediator<W>
Type Parameters
- W extends WazeFeature
Parameters
- selectableLayers: WazeFeatureLayer<W>[]
- options: SelectionMediatorOptions<W>
Returns SelectionMediator<W>

calculateBounds

calculateBounds(): BBox
Returns BBox

createDragElementHandler

createDragElementHandler(options: DragElementHandlerOptions): DragElementHandler
Parameters
- options: DragElementHandlerOptions
Returns DragElementHandler

createDrawingContext

createDrawingContext<F extends WazeFeature = WazeFeature>(
styleMap?: FeatureStyleMap<F>,
): DrawingContext<F>
Type Parameters
- F extends WazeFeature = WazeFeature
Parameters
- OptionalstyleMap: FeatureStyleMap<F>
Returns DrawingContext<F>

createFogOfWarController

createFogOfWarController(layerName: string): FogOfWarController
Parameters
- layerName: string
Returns FogOfWarController

createSnappingHandler

createSnappingHandler<
    EditedFeature extends WazeFeature,
    TargetFeature extends WazeFeature,
>(
    options: SnappingHandlerOptions<EditedFeature, TargetFeature>,
): SnappingHandler<EditedFeature, TargetFeature>
Type Parameters
- EditedFeature extends WazeFeature
- TargetFeature extends WazeFeature
Parameters
- options: SnappingHandlerOptions<EditedFeature, TargetFeature>
Returns SnappingHandler<EditedFeature, TargetFeature>

drawMarkerOnMapCenter

drawMarkerOnMapCenter(): void
Returns void

focus

focus(): void
Returns void

getAsyncLayerStylesPromise

getAsyncLayerStylesPromise(): Promise<void[]>
Returns Promise<void[]>

getBigJunctionLayer

getBigJunctionLayer(): BigJunctionFeatureLayer<WMEBigJunction>
Returns BigJunctionFeatureLayer<WMEBigJunction>

getDriveLayerController

getDriveLayerController(): DriveLayerController
Returns DriveLayerController

getEditableAreasLayer

getEditableAreasLayer(): WazeFeatureLayer<WazeFeature>
Returns WazeFeatureLayer<WazeFeature>

getEditSuggestionsIconLayer

getEditSuggestionsIconLayer(): EditSuggestionsIconLayer
Returns EditSuggestionsIconLayer

getEl

getEl(): JQuery<HTMLElement>
Returns JQuery<HTMLElement>

getExtent

getExtent(): BBox
Returns BBox

getExtentPolygon

getExtentPolygon(): Feature<Polygon, GeoJsonProperties>
Returns Feature<Polygon, GeoJsonProperties>

getFarTurnPathLayer

getFarTurnPathLayer(): WazeFeatureLayer<any>
Returns WazeFeatureLayer<any>

getHeight

getHeight(): number
Returns number

getLayerByName

getLayerByName(name: string): undefined | Layer
Parameters
- name: string
Returns undefined | Layer

getLayers

getLayers(): Layer[]
Returns Layer[]

getLayersBitmask

getLayersBitmask(): bigint
Returns bigint

getLayersBy

getLayersBy(property: string, match: string | ObjectLiteral): any[]
Parameters
- property: string
- match: string | ObjectLiteral
Returns any[]

getLayerVisibility

getLayerVisibility(name: string): null | boolean
Parameters
- name: string
Returns null | boolean

getLonLatFromViewPortPx

getLonLatFromViewPortPx(viewPortPx: Pixel): LonLat
Parameters
- viewPortPx: Pixel
Returns LonLat

getManagedAreasLayer

getManagedAreasLayer(): WazeFeatureLayer<WazeFeature>
Returns WazeFeatureLayer<WazeFeature>

getMapSelection

getMapSelection(): MapSelection
Returns MapSelection

getMapState

getMapState(): MapState
Returns MapState

getMarkerElement

getMarkerElement(layerName: string, markerId: string): HTMLElement
Parameters
- layerName: string
- markerId: string
Returns HTMLElement

getMarkerLayer

getMarkerLayer(layerName: string): HTMLMarkerLayer
Parameters
- layerName: string
Returns HTMLMarkerLayer

getNodeLayer

getNodeLayer(): NodeFeatureLayer<WMENode>
Returns NodeFeatureLayer<WMENode>

getPannable

getPannable(): {
    getZoom(): ZoomLevel;
    panToLonLat(
        lonLat: LonLat,
        zoom?: ZoomLevel,
        options?: { animate?: boolean; dragging?: boolean },
    ): void;
}
Returns {
    getZoom(): ZoomLevel;
    panToLonLat(
        lonLat: LonLat,
        zoom?: ZoomLevel,
        options?: { animate?: boolean; dragging?: boolean },
    ): void;
}

getParkingLotUpdatesLayer

getParkingLotUpdatesLayer(): PlaceUpdatesLayer
Returns PlaceUpdatesLayer

getPixelFromLonLat

getPixelFromLonLat(lonLat: LonLat): Pixel
Parameters
- lonLat: LonLat
Returns Pixel

getPlaceUpdatesLayer

getPlaceUpdatesLayer(): PlaceUpdatesLayer
Returns PlaceUpdatesLayer

getProblemLayer

getProblemLayer(): MapProblemsLayer
Returns MapProblemsLayer

getProjectedCenter

getProjectedCenter(): LonLat
Returns LonLat

getRepositoryByLayerName

getRepositoryByLayerName(
    layerName: string,
):
    | undefined
    | DataModelRepository<
        DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>,
    >
Parameters
- layerName: string
Returns
    | undefined
    | DataModelRepository<
        DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>,
    >

getResidentialPlaceUpdatesLayer

getResidentialPlaceUpdatesLayer(): PlaceUpdatesLayer
Returns PlaceUpdatesLayer

getResolution

getResolution(): number
Returns number

getSegmentLayer

getSegmentLayer(): SegmentFeatureLayer<WMESegment>
Returns SegmentFeatureLayer<WMESegment>

getSegmentSuggestionLayer

getSegmentSuggestionLayer(): WazeFeatureLayer<WMEFeature>
Returns WazeFeatureLayer<WMEFeature>

getSegmentSuggestionsGeoIconLayer

getSegmentSuggestionsGeoIconLayer(): SegmentSuggestionsGeoIconLayer
Returns SegmentSuggestionsGeoIconLayer

getSelectableLayers

getSelectableLayers(): WazeFeatureLayer<WMEFeature>[]
Returns WazeFeatureLayer<WMEFeature>[]

getSize

getSize(): Size
Returns Size

getSketchLayer

getSketchLayer(): SketchFeatureLayer
Returns SketchFeatureLayer

getUnprojectedCenter

getUnprojectedCenter(): LonLat
Returns LonLat

getUnvalidatedUnprojectedCenter

getUnvalidatedUnprojectedCenter(): MapLocation
Returns MapLocation

getUpdateRequestLayer

getUpdateRequestLayer(): MapUpdateRequestsLayer
Returns MapUpdateRequestsLayer

getWazeMap

getWazeMap(): WazeMap
Returns WazeMap
Deprecated
Accessing the WazeMap instance outside of WMEMap is discouraged as it will make it more difficult to upgrade @waze/web-map versions. If required, add a wrapper method to the WMEMap to abstract over WazeMap.

getZoom

getZoom(): ZoomLevel
Returns ZoomLevel

getZoomForExtent

getZoomForExtent(bbox: BBox, closest?: boolean): ZoomLevel
Parameters
- bbox: BBox
- Optionalclosest: boolean
Returns ZoomLevel

hasMarker

hasMarker(): boolean
Returns boolean

initializeLayers

initializeLayers(): void
Returns void

initializePlaceUpdateLayers

initializePlaceUpdateLayers(venueIssueCollection: IssueCollection): void
Parameters
- venueIssueCollection: IssueCollection
Returns void

initMapIssuesSelection

initMapIssuesSelection(): void
Returns void

initMapSelection

initMapSelection(): void
Returns void

initMapState

initMapState(
    selectionManager: SelectionManager,
    app: App,
    togglerTree: TogglerTree,
): void
Parameters
- selectionManager: SelectionManager
- app: App
- togglerTree: TogglerTree
Returns void

isOnScreen

isOnScreen(lonlat: LonLat): boolean
Parameters
- lonlat: LonLat
Returns boolean

isZoomOutEnabled

isZoomOutEnabled(): boolean
Returns boolean

moveByPx

moveByPx(dx: number, dy: number): void
Moves the map by a certain number of pixels
Parameters
- dx: number
- dy: number
Returns void

moveLayerToTop

moveLayerToTop(layer: WazeFeatureLayer<WazeFeature> | HTMLMarkerLayer): void
Parameters
- layer: WazeFeatureLayer<WazeFeature> | HTMLMarkerLayer
Returns void

moveMarker

moveMarker(layerName: string, markerId: string, lonlat: LonLat): void
Parameters
- layerName: string
- markerId: string
- lonlat: LonLat
Returns void

moveTo

moveTo(
    lonLat: LonLat,
    zoom?: ZoomLevel,
    options?: { animate?: boolean; dragging?: boolean },
): void
Parameters
- lonLat: LonLat
- Optionalzoom: ZoomLevel
- Optionaloptions: { animate?: boolean; dragging?: boolean }
Returns void

mustGetLayerByName

mustGetLayerByName(name: string): Layer
Parameters
- name: string
Returns Layer

panDown

panDown(): void
Returns void

panLeft

panLeft(): void
Returns void

panRight

panRight(): void
Returns void

panUp

panUp(): void
Returns void

refreshEarthEngineLayers

refreshEarthEngineLayers(): void
Returns void

refreshRoadLayer

refreshRoadLayer(): void
Returns void

registerAccelerators

registerAccelerators(accelerators: KeyboardShortcuts): void
Parameters
- accelerators: KeyboardShortcuts
Returns void

registerLayerEvent

registerLayerEvent<T>(
    layerName: string,
    eventName: OLMapEvent,
    callback: OLLayerEventHandler<T>,
    scope?: unknown,
): void
Type Parameters
- T
Parameters
- layerName: string
- eventName: OLMapEvent
- callback: OLLayerEventHandler<T>
- Optionalscope: unknown
Returns void

registerMapEvent

registerMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
- callback: OLMapEventHandler
- Optionalscope: unknown
Returns void

registerPriorityMapEvent

registerPriorityMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
- callback: OLMapEventHandler
- Optionalscope: unknown
Returns void

removeAllFeaturesFromLayer

removeAllFeaturesFromLayer(layerName: string): void
Parameters
- layerName: string
Returns void

removeDataMarker

removeDataMarker(layerName: string, dataMarkerId: string): void
Parameters
- layerName: string
- dataMarkerId: string
Returns void

removeMarker

removeMarker(layerName: string, markerId: string): void
Parameters
- layerName: string
- markerId: string
Returns void

removeMTEClosuresLayer

removeMTEClosuresLayer(): void
Returns void

resize

resize(): void
Returns void

resizeFromTopLeft

resizeFromTopLeft(): void
Resizes the map considering the diff in size added/substracted from top left

Returns void

setEditingMediator

setEditingMediator(editingMediator: EditingMediator): void
Parameters
- editingMediator: EditingMediator
Returns void

setLayerAttribution

setLayerAttribution(layerUniqueName: string, atribution: string): void
Parameters
- layerUniqueName: string
- atribution: string
Returns void

setLayerVisibility

setLayerVisibility(layerUniqueName: string, visible: boolean): void
Parameters
- layerUniqueName: string
- visible: boolean
Returns void

setMarker

setMarker(value: boolean): void
Parameters
- value: boolean
Returns void

setProjectedCenter

setProjectedCenter(
    lonLat: LonLat,
    zoom?: ZoomLevel,
    dragging?: boolean,
    forceZoomChange?: boolean,
): void
Parameters
- lonLat: LonLat
- Optionalzoom: ZoomLevel
- Optionaldragging: boolean
- OptionalforceZoomChange: boolean
Returns void

setSearchResult

setSearchResult(lonLat: LonLat): void
Parameters
- lonLat: LonLat
Returns void

setSnapshotManager

setSnapshotManager(snapshotManager: SnapshotManager): void
Parameters
- snapshotManager: SnapshotManager
Returns void

setUnprojectedCenter

setUnprojectedCenter(
    lonLat: LonLat,
    zoom?: ZoomLevel,
    dragging?: boolean,
    forceZoomChange?: boolean,
): void
Parameters
- lonLat: LonLat
- Optionalzoom: ZoomLevel
- Optionaldragging: boolean
- OptionalforceZoomChange: boolean
Returns void

showConfirmationDialog

showConfirmationDialog(props: ConfirmMapBalloonProps): Promise<void>
Parameters
- props: ConfirmMapBalloonProps
Returns Promise<void>

showMapProblemLayer

showMapProblemLayer(): void
Returns void

showUpdateRequestLayer

showUpdateRequestLayer(): void
Returns void

toggleClass

toggleClass(className: string, state: boolean): void
Parameters
- className: string
- state: boolean
Returns void

toggleDisallowedTurnsEditor

toggleDisallowedTurnsEditor(show: boolean): void
Parameters
- show: boolean
Returns void

togglePathsLayer

togglePathsLayer(show: boolean): void
Parameters
- show: boolean
Returns void

toggleSVMode

toggleSVMode(enabled: boolean): void
Parameters
- enabled: boolean
Returns void

unregisterLayerEvent

unregisterLayerEvent<T>(
    layerName: string,
    eventName: OLMapEvent,
    callback: OLLayerEventHandler<T>,
    scope?: unknown,
): void
Type Parameters
- T
Parameters
- layerName: string
- eventName: OLMapEvent
- callback: OLLayerEventHandler<T>
- Optionalscope: unknown
Returns void

unregisterMapEvent

unregisterMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
- callback: OLMapEventHandler
- Optionalscope: unknown
Returns void

updateRoadsVisibility

updateRoadsVisibility(isVisibleInLayerSwitcher: boolean): void
Parameters
- isVisibleInLayerSwitcher: boolean
Returns void

updateSize

updateSize(): void
Returns void

zoomIn

zoomIn(): void
Returns void

zoomOut

zoomOut(): void
Returns void

zoomToExtent

zoomToExtent(bbox: BBox, closest?: boolean): void
Parameters
- bbox: BBox
- Optionalclosest: boolean
Returns void