Class WazeMap

Index

Constructors

Methods

addAlertsLayer addCitiesRasterLayer addClosuresFeatures addClosuresLayer addControl addControls addControlToFooter addDataLayer addDrawingDoneCallback addEarthEngineLayer addElementToFooter addGeoJSON addGoogleMapPermalinkToFooter addGPSPointsRasterLayer addGraticuleControl addHTMLMarker addHTMLMarkerLayer addImageryAttributionToFooter addJamsLayer addLayer addLayers addLinkToFooter addLivemapTileLayer addMapDataNoticesLinkToFooter addMarker addMarkers addMousePositionToFooter addNavigationControl addRasterTileLayer addRoadsRasterLayer addRulerControl addSatelliteImageryLayer addScaleLineToFooter addSelectionMediator addSnappingControl addTermsOfServiceLinkToFooter addWebtilesCitiesPolygonsRasterLayer addWebtilesGPSPointsRasterLayer addWebtilesLivemapBetaLayer addWebtilesRoadsRasterLayer addWKT addZoomControl calculateBounds clearLayerContainerZIndex createDragElementControl createDrawControl createDrawEllipseControl createFogOfWarController createSnappingHandler createWazeBigJunctionsLayer createWazeCamerasLayer createWazeCommentsLayer createWazeFeatureLayer createWazeNodesLayer createWazeRailroadCrossingsLayer createWazeSegmentsLayer createWazeVenuesLayer destroy disableFeatureEvents displayPopup drawEllipse drawFeature drawLine drawPoint drawPolygon enableFeatureEvents focus getCenter getContainerElement getExtent getFeatureAsWkt getFeatureAtPoint getFeatureById getFeatureCollection getFeaturesAsWKT getFeaturesAtPoint getFeaturesByProperty getHTMLMarkerElement getHTMLMarkerLayer getLayerByName getLayerIndex getLayers getLayersBy getLayersByName getLonLatFromViewPortPx getNavigationControl getOLMap getPixelFromLonLat getProjectedCenter getProjectionObject getResolution getSize getViewportElement getZoom getZoomForExtent isValidLonLat isValidZoomLevel moveHTMLMarker moveTo moveToProjectedLonLat panDown panLeft panRight panTo panUp projectLonLat redrawFeature registerDataLayerEvent registerMapEvent registerOLLayerEvent registerOLMapEvent registerPriorityOLMapEvent registerSnappingEvent removeAllFeatures removeAllHTMLMarkers removeControl removeDataLayer removeDrawingDoneCallback removeFeature removeFeaturesByProperty removeGraticuleControl removeHTMLMarker removeLayer removeLayerByName removeMarker removePopup render setCenter setFooterVisibility setLayerIndex setLineStringsWithDirectionArrows setMinZoomLevel setProjectedCenter stopDrawFeature toggleClass unregisterDataLayerEvent unregisterMapEvent unregisterOLLayerEvent unregisterOLMapEvent unregisterSnappingEvent updateHeight updateSize zoomIn zoomOut zoomToExtent zoomToProjectedExtent

Constructors

constructor

new WazeMap(options: WazeMapOptions): WazeMap
Parameters
- options: WazeMapOptions
Returns WazeMap

Methods

addAlertsLayer

addAlertsLayer(
    layerName: string,
    options?: {
        alerts?: FeatureCollection<Geometry, GeoJsonProperties>;
        clusterPixelDistance?: number;
    },
): void
Add layer to map for Waze Alert objects
Parameters
- layerName: string
  a unique name used as reference to the layer
- Optionaloptions: {
  alerts?: FeatureCollection<Geometry, GeoJsonProperties>;
  clusterPixelDistance?: number;
  }
  properties: alerts: optional initial data as a GeoJSON FeatureCollection clusterPixelDistance: pixels between features to group together in the same cluster. default is 120
Returns void

addCitiesRasterLayer

addCitiesRasterLayer(
__namedParameters: { layerName: string; mapnikServers?: string[] },
): void
Add tile layer for cities. By default, tiles are loaded from the Waze Node Mapnik server matching the deployment environment and region code.
Parameters
- __namedParameters: { layerName: string; mapnikServers?: string[] }
Returns void

addClosuresFeatures

addClosuresFeatures(layerName: string, closures: FeatureCollection): void
Add features to Waze Closure objects layer
Parameters
- layerName: string
  a unique name used as reference to the layer
- closures: FeatureCollection
  GeoJSON FeatureCollection to add
Returns void

addClosuresLayer

addClosuresLayer(
layerName: string,
options?: { closures?: FeatureCollection<Geometry, GeoJsonProperties> },
): void
Add layer to map for Waze Closure objects
Parameters
- layerName: string
  a unique name used as reference to the layer
- Optionaloptions: { closures?: FeatureCollection<Geometry, GeoJsonProperties> }
  properties: closures: optional initial data as a GeoJSON FeatureCollection
Returns void

addControl

addControl(control: Control, px?: null | Pixel): void
Parameters
- control: Control
- Optionalpx: null | Pixel
Returns void
Deprecated
Creating an instance of OpenLayers.Control is discouraged and will be removed. Instead, either implement a shared control internally and expose it via the map API, or create an external element which relies on the existing map API functions.

Add a control to the map. Optionally position the control at the given pixel.

addControls

addControls(controls: Control[]): void
Parameters
- controls: Control[]
Returns void
Deprecated
Creating an instance of OpenLayers.Control is discouraged and will be removed. Instead, either implement a shared control internally and expose it via the map API, or create an external element which relies on the existing map API functions.

Add an array of controls to the map

addControlToFooter

addControlToFooter(options: { control: Control; displayClass: string }): void
Parameters
- options: { control: Control; displayClass: string }
  The controls options: displayClass - a class name to add to the control container HTML element control - the OpenLayers.Control to add to the footer
Returns void
Deprecated
Usage of OpenLayers.Control is discouraged and will be removed. Add an arbitrary control to the footer

addDataLayer

addDataLayer(
    layerName: string,
    options?: {
        clustering?: {
            clusterPixelDistance?: number;
            clusterStyle?: FeatureStyle | OLFeaturesToFeatureStyle;
            clusterThreshold?: number;
            enabled: boolean;
            maxZoomLevel?: number;
            zoomToCluster?: boolean;
        };
        geoJSON?: GeoJSON;
        isEditable?: boolean;
        style?: | FeatureStyle
        | AdvancedFeatureStyle<WazeFeature>
        | StyleMap
        | FeatureStyleMap<WazeFeature>;
        wkt?: string;
    },
): void
Add a layer for arbitrary geospatial data. Use a data layer to display custom data on the map. Data can be any valid GeoJSON object.
Parameters
- layerName: string
  a unique name used as reference to the layer
- Optionaloptions: {
      clustering?: {
          clusterPixelDistance?: number;
          clusterStyle?: FeatureStyle | OLFeaturesToFeatureStyle;
          clusterThreshold?: number;
          enabled: boolean;
          maxZoomLevel?: number;
          zoomToCluster?: boolean;
      };
      geoJSON?: GeoJSON;
      isEditable?: boolean;
      style?: | FeatureStyle
      | AdvancedFeatureStyle<WazeFeature>
      | StyleMap
      | FeatureStyleMap<WazeFeature>;
      wkt?: string;
  }
  optional object with the following optional properties: geoJSON: initial data in GeoJSON format to add to the layer wkt: initial data in WKT format to add to the layer style: custom style for features drawn in this layer
Returns void

addDrawingDoneCallback

addDrawingDoneCallback(drawingDoneCallback: DrawingDoneCallback): void
Parameters
- drawingDoneCallback: DrawingDoneCallback
Returns void

addEarthEngineLayer

addEarthEngineLayer(
    layerName: string,
    earthEngineVersion: EarthEngineVersion,
    getMapIdCallback: GetMapIdCallback,
    project?: string,
): void
Add Earth Engine tile layer.
Parameters
- layerName: string
  unique name to reference the layer
- earthEngineVersion: EarthEngineVersion
  EarthEngineVersion to use in the Earth Engine url
- getMapIdCallback: GetMapIdCallback
  callback function to return map-id and TTLMsec
- Optionalproject: string
  (optional) - project to use in the Earth Engine url
Returns void

addElementToFooter

addElementToFooter(el: HTMLElement): void
Parameters
- el: HTMLElement
Returns void

addGeoJSON

addGeoJSON(layerName: string, geoJSON: GeoJSON): void
Add GeoJSON data to a data layer.
Parameters
- layerName: string
  the layer name to add data to
- geoJSON: GeoJSON
  the GeoJSON data to add to the layer
Returns void

addGoogleMapPermalinkToFooter

addGoogleMapPermalinkToFooter(): void
Returns void

addGPSPointsRasterLayer

addGPSPointsRasterLayer(
__namedParameters: { layerName: string; mapnikServers?: string[] },
): void
Add tile layer for GPS points. By default, tiles are loaded from the Waze Node Mapnik server matching the deployment environment and region code.
Parameters
- __namedParameters: { layerName: string; mapnikServers?: string[] }
Returns void

addGraticuleControl

addGraticuleControl(): void
Adds a graticule (grid) control to the map.

Returns void

addHTMLMarker

addHTMLMarker(
    layerName: string,
    lonLat: LonLat,
    options?: { classNames?: string[] },
): string
Add a HTML marker at a location on the map. HTML markers can be added only to HTML marker layers.
Parameters
- layerName: string
  the HTML marker layer name to add the marker to
- lonLat: LonLat
  lon/lat indicating where to place the marker
- Optionaloptions: { classNames?: string[] }
  contains an optional CSS classes to add to the marker HTML element
Returns string
the marker id which can be used as a reference to the marker

addHTMLMarkerLayer

addHTMLMarkerLayer(
layerName: string,
options?: HTMLMarkerLayerOptions,
): HTMLMarkerLayer
Add a layer for HTML markers. Use a marker layer to display HTML markers on the map.
Parameters
- layerName: string
  a unique name used as reference to the layer
- Optionaloptions: HTMLMarkerLayerOptions
  contains an optional CSS classes to add to the layer root
Returns HTMLMarkerLayer
an HTMLMarkerLayer instance

addImageryAttributionToFooter

addImageryAttributionToFooter(): void
Returns void

addJamsLayer

addJamsLayer(
layerName: string,
options?: { jams?: FeatureCollection<Geometry, GeoJsonProperties> },
): void
Add layer to map for Waze Jam objects
Parameters
- layerName: string
  a unique name used as reference to the layer
- Optionaloptions: { jams?: FeatureCollection<Geometry, GeoJsonProperties> }
  properties: jams: optional initial data as a GeoJSON FeatureCollection
Returns void

addLayer

addLayer(layer: Layer): void
Parameters
- layer: Layer
Returns void

addLayers

addLayers(layers: Layer[]): void
Parameters
- layers: Layer[]
Returns void

addLinkToFooter

addLinkToFooter(
    href: string,
    title: string,
    options?: { elAttributes?: Record<string, string> },
): void
Add a link to the map footer
Parameters
- href: string
  link href value
- title: string
  link title to display
- Optionaloptions: { elAttributes?: Record<string, string> }
  optional object with the following optional properties: elAttributes - additional attributes to add to the link anchor tag
Returns void

addLivemapTileLayer

addLivemapTileLayer(layerName: { layerName: string }): void
Add Waze Livemap tile layer. Tiles are loaded from the Waze Livemap Mapnik server matching the deployment environment and region code.
Parameters
- layerName: { layerName: string }
  unique name to reference the layer
Returns void

addMapDataNoticesLinkToFooter

addMapDataNoticesLinkToFooter(linkText: string): void
Parameters
- linkText: string
Returns void

addMarker

addMarker(
    layerName: string,
    shape: DataMarkerShape,
    options?: { style?: FeatureStyle; useLayerStyle?: boolean },
    attributes?: Record<string, string | number | boolean>,
): string
Add a marker at a location on the map. Markers can be added to any data layer.
Parameters
- layerName: string
  the layer name to add the marker to
- shape: DataMarkerShape
  lon/lat or GeoJSON geometry of the marker
- Optionaloptions: { style?: FeatureStyle; useLayerStyle?: boolean }
  containes optional style: custom style for marker
- Optionalattributes: Record<string, string | number | boolean>
Returns string
the marker id which can be used as a reference to the marker

addMarkers

addMarkers(
    layerName: string,
    markers: {
        attributes?: Record<string, string | number | boolean>;
        options?: { style?: FeatureStyle; useLayerStyle?: boolean };
        shape: DataMarkerShape;
    }[],
): string[]
Add markers at a location on the map. Markers can be added to any data layer.
Parameters
- layerName: string
  the layer name to add the marker to
- markers: {
      attributes?: Record<string, string | number | boolean>;
      options?: { style?: FeatureStyle; useLayerStyle?: boolean };
      shape: DataMarkerShape;
  }[]
  object with marker position and optional style
Returns string[]
an array of marker ids which can be used as a reference to the marker

addMousePositionToFooter

addMousePositionToFooter(): void
Returns void

addNavigationControl

addNavigationControl(): void
Adds a navigation control to the map. The navigation control handles map browsing and zooming with mouse events (dragging, double-clicking, and scrolling the wheel).

Returns void

addRasterTileLayer

addRasterTileLayer(
    layerName: string,
    layerUrl: { fileName: string; params?: ObjectLiteral; servers: string[] },
    layerOptions: RasterTileLayerOptions,
): void
Add a layer to display pre-rendered tiles arranged by a standard XYZ grid, loaded from a URL
Parameters
- layerName: string
  a unique name used as reference to the layer
- layerUrl: { fileName: string; params?: ObjectLiteral; servers: string[] }
  an object with the layer URL properties: servers (string[]) - array of server domains (e.g. ["https://editor-tiles-na-1.waze.com", "https://editor-tiles-na-2.waze.com"]) fileName (string) - file path template with XYZ parameters (e.g. tiles/gps/${z}/${x}/${y}/tile.png) params (object)
- layerOptions: RasterTileLayerOptions
  configuration options for layer rendering
Returns void

addRoadsRasterLayer

addRoadsRasterLayer(
__namedParameters: { layerName: string; mapnikServers?: string[] },
): void
Add tile layer for roads. By default, tiles are loaded from the Waze Node Mapnik server matching the deployment environment and region code.
Parameters
- __namedParameters: { layerName: string; mapnikServers?: string[] }
Returns void

addRulerControl

addRulerControl<MS extends "imperial" | "metric">(
props?: RulerProps<MS>,
): MapControlHandle
Adds a measure-over-a-path control and returns a handle. Call destroy method of the handle to remove the control from the map.
Type Parameters
- MS extends "imperial" | "metric"
Parameters
- Optionalprops: RulerProps<MS>
  Ruler props
Returns MapControlHandle
Ruler control handler
Example
```
const { activate } = map.addRulerControl({ onMeasurePartial });
button.addEventListener("click", () => activate());
```

addSatelliteImageryLayer

addSatelliteImageryLayer(
__namedParameters: { googleMapsApiKey: string; layerName: string },
): void
Add Google Satellite images layer.
Parameters
- __namedParameters: { googleMapsApiKey: string; layerName: string }
Returns void

addScaleLineToFooter

addScaleLineToFooter(isImperial: boolean): void
Add a scale line to the map footer indicating the currently viewed map scale
Parameters
- isImperial: boolean
  if true, the scale will be displayed in imperial units
Returns void

addSelectionMediator

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

addSnappingControl

addSnappingControl(
    layerName: string,
    targetLayerName: string,
    snapOnlyToEdges?: boolean,
): void
Parameters
- layerName: string
  The name of editable layer. Features from this layer that are digitized or modified may have vertices snapped to the features of the target layer.
- targetLayerName: string
  The name of the target layer.
- OptionalsnapOnlyToEdges: boolean
  (optional) Whether snapping is only occurs to the edges
Returns void
Deprecated
Use the SnappingHandler instead. Adds a snapping control to the map.

addTermsOfServiceLinkToFooter

addTermsOfServiceLinkToFooter(linkText: string): void
Parameters
- linkText: string
Returns void

addWebtilesCitiesPolygonsRasterLayer

addWebtilesCitiesPolygonsRasterLayer(layerName: { layerName: string }): void
Add Webtiles tile layer for cities polygons. By default, tiles are loaded from the Webtiles server matching the deployment environment and region code.
Parameters
- layerName: { layerName: string }
  unique name to reference the layer
Returns void

addWebtilesGPSPointsRasterLayer

addWebtilesGPSPointsRasterLayer(layerName: { layerName: string }): void
Add Webtiles tile layer for GPS points. By default, tiles are loaded from the Webtiles server matching the deployment environment and region code.
Parameters
- layerName: { layerName: string }
  unique name to reference the layer
Returns void

addWebtilesLivemapBetaLayer

addWebtilesLivemapBetaLayer(layerName: { layerName: string }): void
Add Waze Webtiles Livemap tile layer. Tiles are loaded from the Waze Webtiles server matching the deployment environment and region code.
Parameters
- layerName: { layerName: string }
  unique name to reference the layer
Returns void

addWebtilesRoadsRasterLayer

addWebtilesRoadsRasterLayer(layerName: { layerName: string }): void
Add Webtiles tile layer for roads. By default, tiles are loaded from the Webtiles server matching the deployment environment and region code.
Parameters
- layerName: { layerName: string }
  unique name to reference the layer
Returns void

addWKT

addWKT(layerName: string, wkt: string): void
Add WKT data to a data layer.
Parameters
- layerName: string
  the layer name to add data to
- wkt: string
  the WKT data to add to the layer
Returns void

addZoomControl

addZoomControl(): void
Adds a zoom control to the map. The zoom control is a pair of +/- links for zooming in and out.

Returns void

calculateBounds

calculateBounds(): BBox
Returns BBox

clearLayerContainerZIndex

clearLayerContainerZIndex(): void
Returns void

createDragElementControl

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

createDrawControl

createDrawControl(
    options: {
        autoDestroy?: boolean;
        geometry: "point" | "line" | "polygon";
        layerName: string;
    },
): MapControlHandle
Create a draw control instance
Parameters
- options: {
      autoDestroy?: boolean;
      geometry: "point" | "line" | "polygon";
      layerName: string;
  }
Returns MapControlHandle
A control handler

createDrawEllipseControl

createDrawEllipseControl(
callbacks: EllipseHandlerCallback,
options?: EllipseHandlerOptions,
): MapControlHandle
Create a draw ellipse control instance
Parameters
- callbacks: EllipseHandlerCallback
- Optionaloptions: EllipseHandlerOptions
Returns MapControlHandle
A control handler

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>
Add a snapping control to the map. It allows to snap features to other features on the map.
Type Parameters
- EditedFeature extends WazeFeature
- TargetFeature extends WazeFeature
Parameters
- options: SnappingHandlerOptions<EditedFeature, TargetFeature>
  The SnappingHandler config.
Returns SnappingHandler<EditedFeature, TargetFeature>
a new snapping handler

createWazeBigJunctionsLayer

createWazeBigJunctionsLayer<F extends BigJunction = BigJunction>(
layerName: string,
): BigJunctionFeatureLayer<F>
Type Parameters
- F extends BigJunction = BigJunction
Parameters
- layerName: string
Returns BigJunctionFeatureLayer<F>

createWazeCamerasLayer

createWazeCamerasLayer<F extends Camera = Camera>(
layerName: string,
): CameraFeatureLayer<F>
Type Parameters
- F extends Camera = Camera
Parameters
- layerName: string
Returns CameraFeatureLayer<F>

createWazeCommentsLayer

createWazeCommentsLayer<F extends Comment = Comment>(
layerName: string,
): CommentFeatureLayer<F>
Type Parameters
- F extends Comment = Comment
Parameters
- layerName: string
Returns CommentFeatureLayer<F>

createWazeFeatureLayer

createWazeFeatureLayer<F extends WazeFeature = WazeFeature>(
layerName: string,
options?: WazeFeatureLayerOptions<F>,
): WazeFeatureLayer<F>
Type Parameters
- F extends WazeFeature = WazeFeature
Parameters
- layerName: string
- Optionaloptions: WazeFeatureLayerOptions<F>
Returns WazeFeatureLayer<F>

createWazeNodesLayer

createWazeNodesLayer<F extends Node = Node>(
layerName: string,
): NodeFeatureLayer<F>
Type Parameters
- F extends Node = Node
Parameters
- layerName: string
Returns NodeFeatureLayer<F>

createWazeRailroadCrossingsLayer

createWazeRailroadCrossingsLayer<F extends RailroadCrossing = RailroadCrossing>(
layerName: string,
): RailroadCrossingFeatureLayer<F>
Type Parameters
- F extends RailroadCrossing = RailroadCrossing
Parameters
- layerName: string
Returns RailroadCrossingFeatureLayer<F>

createWazeSegmentsLayer

createWazeSegmentsLayer<F extends Segment = Segment>(
layerName: string,
): SegmentFeatureLayer<F>
Type Parameters
- F extends Segment = Segment
Parameters
- layerName: string
Returns SegmentFeatureLayer<F>

createWazeVenuesLayer

createWazeVenuesLayer<F extends Venue = Venue>(
layerName: string,
): VenueFeatureLayer<F>
Type Parameters
- F extends Venue = Venue
Parameters
- layerName: string
Returns VenueFeatureLayer<F>

destroy

destroy(): void
Destroy the current map and all its dependencies. This will remove all layers and controls from the map.

Returns void

disableFeatureEvents

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

displayPopup

displayPopup(
    __namedParameters: {
        addCloseButton?: boolean;
        autoSize?: boolean;
        htmlContent: string;
        lonLat: LonLat;
    },
): string
Parameters
- __namedParameters: {
      addCloseButton?: boolean;
      autoSize?: boolean;
      htmlContent: string;
      lonLat: LonLat;
  }
Returns string

drawEllipse

drawEllipse(
callbacks: EllipseHandlerCallback,
options?: EllipseHandlerOptions,
): void
Parameters
- callbacks: EllipseHandlerCallback
- Optionaloptions: EllipseHandlerOptions
Returns void

drawFeature

drawFeature(
options: { geometry: "point" | "line" | "polygon"; layerName: string },
): void
Draw a feature on the map in a given layer. Click on the map to draw the feature based on the geometry. For lines or polygons, double-click to finish drawing, or hold down the shift key while drawing to activate freehand mode.
Parameters
- options: { geometry: "point" | "line" | "polygon"; layerName: string }
Returns void

drawLine

drawLine(options: { layerName: string }): void
Shorthand for drawFeature("layer", "line", options) See documentation for drawFeature
Parameters
- options: { layerName: string }
  Contains the layer name
Returns void

drawPoint

drawPoint(options: { layerName: string }): void
Shorthand for drawFeature("layer", "point", options) See documentation for drawFeature
Parameters
- options: { layerName: string }
  Contains the layer name
Returns void

drawPolygon

drawPolygon(options: { layerName: string }): void
Shorthand for drawFeature("layer", "polygon", options) See documentation for drawFeature
Parameters
- options: { layerName: string }
  Contains the layer name
Returns void

enableFeatureEvents

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

focus

focus(): void
Returns void

getCenter

getCenter(): LonLat
Returns LonLat

getContainerElement

getContainerElement(): HTMLElement
Returns HTMLElement

getExtent

getExtent(): BBox
Returns BBox

getFeatureAsWkt

getFeatureAsWkt(layerName: string, featureId: string | number): null | string
Get a feature from layer in WKT format
Parameters
- layerName: string
  the layer name to get feature from
- featureId: string | number
  the feature to retrieve
Returns null | string
feature in WKT format

getFeatureAtPoint

getFeatureAtPoint(
layerName: string,
point: { x: number; y: number },
): Feature<Geometry, GeoJsonProperties>
Get first feature from layer found at specific point
Parameters
- layerName: string
  the layer name to get feature from
- point: { x: number; y: number }
  feature position
Returns Feature<Geometry, GeoJsonProperties>
first feature found at point or null if there are none from the layer

getFeatureById

getFeatureById(
layerName: string,
featureId: string | number,
): null | Feature<Geometry, GeoJsonProperties>
Get a feature from a layer by the feature id
Parameters
- layerName: string
  the layer name to retrieve from
- featureId: string | number
  the feature to retrieve
Returns null | Feature<Geometry, GeoJsonProperties>
the feature with the id, or null if it does not exist in the layer

getFeatureCollection

getFeatureCollection(layerName: string): FeatureCollection
Get all features currently in a layer as a FeatureCollection
Parameters
- layerName: string
  the layer name to retrieve features from
Returns FeatureCollection
FeatureCollection

getFeaturesAsWKT

getFeaturesAsWKT(layerName: string): string
Get the layer features in WKT format
Parameters
- layerName: string
  the layer name to add data to
Returns string
all the features currently in the layer in WKT format

getFeaturesAtPoint

getFeaturesAtPoint(
layerName: string,
point: { x: number; y: number },
): FeatureCollection<Geometry, GeoJsonProperties>
Get all features from layer at specific point
Parameters
- layerName: string
  the layer name to get features from
- point: { x: number; y: number }
  feature position
Returns FeatureCollection<Geometry, GeoJsonProperties>
feature collection of features found at point

getFeaturesByProperty

getFeaturesByProperty(
    layerName: string,
    propertyName: string,
    propertyValue: unknown,
): FeatureCollection
Get a FeatureCollection with features matching a property key/value in the layer
Parameters
- layerName: string
  the layer name to retrieve from
- propertyName: string
  the name of the property to match
- propertyValue: unknown
  the value of the property to match The property values are compared using strict equality (i.e. ===).
Returns FeatureCollection
a FeatureCollection with matching features

getHTMLMarkerElement

getHTMLMarkerElement(layerName: string, markerId: string): HTMLElement
Get a container HTML element of the HTML marker previously added to the map.
Parameters
- layerName: string
  the name of the marker layer
- markerId: string
  id of the marker to get the container for
Returns HTMLElement
a HTML marker element

getHTMLMarkerLayer

getHTMLMarkerLayer(layerName: string): HTMLMarkerLayer
Get an HTMLMarkerLayer instance by layer name.
Parameters
- layerName: string
  the name of the HTMLMarkerLayer
Returns HTMLMarkerLayer
an HTMLMarkerLayer instance

Throws
an error if layer doesn't exist or isn't a HTMLMarkerLayer

getLayerByName

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

getLayerIndex

getLayerIndex(layer: Layer): number
Parameters
- layer: Layer
Returns number

getLayers

getLayers(): Layer[]
Returns Layer[]

getLayersBy

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

getLayersByName

getLayersByName(name: string): Layer[]
Parameters
- name: string
Returns Layer[]

getLonLatFromViewPortPx

getLonLatFromViewPortPx(viewPortPx: Pixel): LonLat
Returns unprojected (WGS84) coordinates from screen coordinates
Parameters
- viewPortPx: Pixel
Returns LonLat

getNavigationControl

getNavigationControl(): null | Navigation
Returns null | Navigation
the map navigation control if exists, otherwise null

Deprecated
Working directly with OpenLayers.Control is discouraged and will be removed.

getOLMap

getOLMap(): Map
Returns Map
the underlying OpenLayers.Map instance

Deprecated
Access to the OpenLayers.Map instance is discouraged and will be removed. Use a WazeMap wrapper method instead.

getPixelFromLonLat

getPixelFromLonLat(lonLat: LonLat): Pixel
Return screen coordinates that match unprojected (WGS84) geo coordinates
Parameters
- lonLat: LonLat
Returns Pixel

getProjectedCenter

getProjectedCenter(): LonLat
Returns LonLat

getProjectionObject

getProjectionObject(): Projection
Returns Projection

getResolution

getResolution(): number
Returns number

getSize

getSize(): Size
Returns Size

getViewportElement

getViewportElement(): HTMLElement
Returns HTMLElement

getZoom

getZoom(): ZoomLevel
Returns ZoomLevel

getZoomForExtent

getZoomForExtent(boundingBox: BBox, closest?: boolean): ZoomLevel
Parameters
- boundingBox: BBox
  coordinates that match unprojected (WGS84) geo coordinates
- Optionalclosest: boolean
  Find the zoom level that most closely fits the specified bounds. Note that this may result in a zoom that does not exactly contain the entire extent. Default is false.
Returns ZoomLevel

isValidLonLat

isValidLonLat(lonLat: LonLat): boolean
Parameters
- lonLat: LonLat
Returns boolean

isValidZoomLevel

isValidZoomLevel(zoom: ZoomLevel): boolean
Parameters
- zoom: ZoomLevel
Returns boolean

moveHTMLMarker

moveHTMLMarker(layerName: string, markerId: string, lonLat: LonLat): void
Move an existing HTML marker to the new location on the map.
Parameters
- layerName: string
  the name of the HTML marker layer that contains the marker
- markerId: string
  id of the marker
- lonLat: LonLat
  lon/lat indicating where to place the marker
Returns void

moveTo

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

moveToProjectedLonLat

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

panDown

panDown(): void
Pan the map down

Returns void

panLeft

panLeft(): void
Pan the map left

Returns void

panRight

panRight(): void
Pan the map right

Returns void

panTo

panTo(lonLat: LonLat): void
Pan the map to the given LonLat.
Parameters
- lonLat: LonLat
Returns void

panUp

panUp(): void
Pan the map up

Returns void

projectLonLat

projectLonLat(lonLat: LonLat): LonLat
Parameters
- lonLat: LonLat
Returns LonLat

redrawFeature

redrawFeature(layerName: string, feature: Feature): void
Redraw a feature based on new data
Parameters
- layerName: string
  the layer including the feature
- feature: Feature
  the updated feature data Redrawing a feature is supported only for features with an 'id' property. If no feature with the passed 'id' is found in the layer, nothing will happen.
Returns void

registerDataLayerEvent

registerDataLayerEvent(
    options: {
        eventName: DataLayerEvent;
        handler: DataLayerEventHandler;
        layerName: string;
    },
): void
Parameters
- options: { eventName: DataLayerEvent; handler: DataLayerEventHandler; layerName: string }
Returns void

registerMapEvent

registerMapEvent(
    options:
        | { eventName: MapEvent; handler: MapEventHandler }
        | { eventName: "click" | "rightclick"; handler: MapClickEventHandler },
): void
Parameters
- options:
  | { eventName: MapEvent; handler: MapEventHandler }
  | { eventName: "click" | "rightclick"; handler: MapClickEventHandler }
Returns void

registerOLLayerEvent

registerOLLayerEvent<T>(
    layerName: string,
    eventName: OLMapEvent,
    callback: OLLayerEventHandler<T>,
    scope?: unknown,
): void
Type Parameters
- T
Parameters
- layerName: string
- eventName: OLMapEvent
  the map event to register
- callback: OLLayerEventHandler<T>
  the handler to register
- Optionalscope: unknown
  (optional) the execution scope of the registered handler
Returns void
Deprecated
Registering to an OL layer is discouraged and will be removed. Prefer using 'registerDataLayerEvent' instead.

Register a layer event handler which directly accepts OpenLayers callback arguments

registerOLMapEvent

registerOLMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
  the map event to register
- callback: OLMapEventHandler
  the handler to register
- Optionalscope: unknown
  (optional) the execution scope of the registered handler
Returns void
Deprecated
Relying on OpenLayers instances in callbacks is discouraged and will be removed. Prefer using registerMapEvent instead.

Register a map event handler which directly accepts OpenLayers callback arguments

registerPriorityOLMapEvent

registerPriorityOLMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
  the map event to register
- callback: OLMapEventHandler
  the handler to register
- Optionalscope: unknown
  (optional) the execution scope of the registered handler
Returns void
Deprecated
Relying on OpenLayers instances in callbacks is discouraged and will be removed.

Register a priority map event handler which directly accepts OpenLayers callback arguments Priority handlers will take precedence and be executed before other handlers registered to the event.

registerSnappingEvent

registerSnappingEvent(
eventName: SnappingEvent,
handler: SnappingEventHandler,
): void
Register a snapping control event handler
Parameters
- eventName: SnappingEvent
  the snapping event to register
- handler: SnappingEventHandler
  the handler to register
Returns void
Deprecated
Use the SnappingHandler instead.

removeAllFeatures

removeAllFeatures(layerName: string): void
Remove all features from a layer
Parameters
- layerName: string
  the layer to remove features from
Returns void

removeAllHTMLMarkers

removeAllHTMLMarkers(layerName: string): void
Remove all HTML markers from a HTML marker layer
Parameters
- layerName: string
  the HTML marker layer name to remove markers from
Returns void

removeControl

removeControl(control: Control): void
Parameters
- control: Control
Returns void
Deprecated
Creating an instance of OpenLayers.Control is discouraged and will be removed. Instead, either implement a shared control internally and expose it via the map API, or create an external element which relies on the existing map API functions.

Remove a control from the map

removeDataLayer

removeDataLayer(layerName: string): void
Parameters
- layerName: string
  the name of the layer to remove
Returns void
Deprecated
use the WazeMap.removeLayerByName(layerName) instead. Remove a data layer previously added to the map.

removeDrawingDoneCallback

removeDrawingDoneCallback(): void
Returns void

removeFeature

removeFeature(layerName: string, featureId: string | number): void
Remove a feature from a layer by feature id
Parameters
- layerName: string
  the layer including the feature
- featureId: string | number
  the feature id to remove
Returns void

removeFeaturesByProperty

removeFeaturesByProperty(
    layerName: string,
    propertyName: string,
    propertyValue: unknown,
): void
Remove features from a layer with matching property name and value
Parameters
- layerName: string
  the layer to remove features from
- propertyName: string
  the name of the property to match
- propertyValue: unknown
  the value of the property to match The property values are compared using strict equality (i.e. ===).
Returns void

removeGraticuleControl

removeGraticuleControl(): void
Removes the graticule (grid) control from the map.

Returns void

removeHTMLMarker

removeHTMLMarker(layerName: string, markerId: string): void
Remove a HTML marker from a HTML marker layer
Parameters
- layerName: string
  the HTML marker layer name to remove the marker from
- markerId: string
  id of the marker to remove
Returns void

removeLayer

removeLayer(layer: Layer, setNewBaseLayer?: boolean): void
Parameters
- layer: Layer
- OptionalsetNewBaseLayer: boolean
Returns void

removeLayerByName

removeLayerByName(layerName: string): void
Remove a layer previously added to the map.
Parameters
- layerName: string
  the name of the layer to remove
Returns void

removeMarker

removeMarker(layerName: string, markerId: string): void
Remove a marker from a layer
Parameters
- layerName: string
  the layer name to remove the marker from
- markerId: string
  id of the marker to remove
Returns void

removePopup

removePopup(id: string): void
Parameters
- id: string
Returns void

render

render(containerElementId: string): void
Render the map to a specified container.
Parameters
- containerElementId: string
  id of the DOM element to render the map into
Returns void

setCenter

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

setFooterVisibility

setFooterVisibility(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void

setLayerIndex

setLayerIndex(layer: Layer, idx: number): void
Parameters
- layer: Layer
- idx: number
Returns void

setLineStringsWithDirectionArrows

setLineStringsWithDirectionArrows(
    layerName: string,
    lineStringFeatures: Feature<LineString, GeoJsonProperties>[],
    arrowsDistance: number,
    arrowsStyle: FeatureStyle,
): void
Set arrow markers on the segments of equal distance along the line
Parameters
- layerName: string
  the layer name to set arrow markers to
- lineStringFeatures: Feature<LineString, GeoJsonProperties>[]
  features of linestring indicating the lines to place the arrow markers
- arrowsDistance: number
  distance between arrow markers
- arrowsStyle: FeatureStyle
  style for arrow markers
Returns void

setMinZoomLevel

setMinZoomLevel(minZoomLevel: ZoomLevel): void
Parameters
- minZoomLevel: ZoomLevel
Returns void

setProjectedCenter

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

stopDrawFeature

stopDrawFeature(): void
Stop drawing a feature on the map.

Returns void

toggleClass

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

unregisterDataLayerEvent

unregisterDataLayerEvent(
    options: {
        eventName: DataLayerEvent;
        handler: DataLayerEventHandler;
        layerName: string;
    },
): void
Parameters
- options: { eventName: DataLayerEvent; handler: DataLayerEventHandler; layerName: string }
Returns void

unregisterMapEvent

unregisterMapEvent(
    options:
        | { eventName: MapEvent; handler: MapEventHandler }
        | { eventName: "click" | "rightclick"; handler: MapClickEventHandler },
): void
Parameters
- options:
  | { eventName: MapEvent; handler: MapEventHandler }
  | { eventName: "click" | "rightclick"; handler: MapClickEventHandler }
Returns void

unregisterOLLayerEvent

unregisterOLLayerEvent<T>(
    layerName: string,
    eventName: OLMapEvent,
    callback: OLLayerEventHandler<T>,
    scope?: unknown,
): void
Type Parameters
- T
Parameters
- layerName: string
- eventName: OLMapEvent
  the map event to register
- callback: OLLayerEventHandler<T>
  the handler to register
- Optionalscope: unknown
  (optional) the execution scope of the registered handler
Returns void
Deprecated
Registering to an OL layer is discouraged and will be removed. Prefer using 'unregisterDataLayerEvent' instead.

Unregister a layer event handler previously registered with 'registerOLLayerEvent'.

unregisterOLMapEvent

unregisterOLMapEvent(
    eventName: OLMapEvent,
    callback: OLMapEventHandler,
    scope?: unknown,
): void
Parameters
- eventName: OLMapEvent
  the map event to unregister
- callback: OLMapEventHandler
  the handler to unregister
- Optionalscope: unknown
  (optional) the scope of the registered handler
Returns void
Deprecated
Relying on OpenLayers instances in callbacks is discouraged and will be removed. Prefer using unregisterMapEvent instead.

Unregister a map event handler previously registered via 'registerOLMapEvent'

unregisterSnappingEvent

unregisterSnappingEvent(
eventName: SnappingEvent,
handler: (event: { point: { x: number; y: number } }) => void,
): void
Unregister a snapping control event handler
Parameters
- eventName: SnappingEvent
  the snapping event to unregister
- handler: (event: { point: { x: number; y: number } }) => void
  the handler to unregister
Returns void
Deprecated
Use the SnappingHandler instead.

updateHeight

updateHeight(height: number): void
Parameters
- height: number
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

zoomToProjectedExtent

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

Class WazeMap

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WazeMap

Methods

addAlertsLayer

Parameters

Returns void

addCitiesRasterLayer

Parameters

Returns void

addClosuresFeatures

Parameters

Returns void

addClosuresLayer

Parameters

Returns void

addControl

Parameters

Returns void

Deprecated

addControls

Parameters

Returns void

Deprecated

addControlToFooter

Parameters

Returns void

Deprecated

addDataLayer

Parameters

Returns void

addDrawingDoneCallback

Parameters

Returns void

addEarthEngineLayer

Parameters

Returns void

addElementToFooter

Parameters

Returns void

addGeoJSON

Parameters

Returns void

addGoogleMapPermalinkToFooter

Returns void

addGPSPointsRasterLayer

Parameters

Returns void

addGraticuleControl

Returns void

addHTMLMarker

Parameters

Returns string

addHTMLMarkerLayer

Parameters

Returns HTMLMarkerLayer

addImageryAttributionToFooter

Returns void

addJamsLayer

Parameters

Returns void

addLayer

Parameters

Returns void

addLayers

Parameters

Returns void

addLinkToFooter

Parameters

Returns void

addLivemapTileLayer

Parameters

Returns void

addMapDataNoticesLinkToFooter

Parameters