Instance Method

overlaysAtPoint

Returns an array of overlays at a given point on the webpage.

Declaration

mapkit.Overlay[] overlaysAtPoint(DOMPoint point);

Parameters

point

A point in the page's coordinate system, such as new DOMPoint(event.pageX, event.pageY) when handling a mouse event.

Return Value

Returns an array of overlays. If there are no overlays at the point, the array is empty.

Discussion

If the point is above an overlay fill or stroke, the overlay is returned. Overlays are returned in the order they are displayed, with the first overlay in the array closest to the background, and the last overlay closest to the foreground.

Similar to overlay selection events, this method considers the overlay's style at the point.

For example, the following cases do not return an overlay:

  • The point is on an overlay's fill, but the fill color is null.

  • The point is on an overlay's stroke, but the stroke color is null.

  • The point is on an overlay's stroke, but the line width is 0.

Opacity is not considered and can have any value. For example, if the point is on an overlay whose opacity is set to 0, that overlay is returned.

See Also

Adding and Removing Overlays

overlays

An array of all of the map's overlays.

selectedOverlay

The overlay on the map that is selected.

addOverlay

Adds an overlay to the map.

addOverlays

Adds multiple overlays to the map.

removeOverlay

Removes an overlay from the map.

removeOverlays

Removes multiple overlays from the map.

topOverlayAtPoint

Returns the topmost overlay at a given point on the webpage.