leaflet-city-mapper 0.0.9 → 0.1.0

package/src/controls/cameraDragMove.js

@@ -1,11 +1,15 @@
-import { degrees } from '../globals/degrees.js';
-import { dragStates } from '../weakmaps/dragStates.js';
-
-import { mapStopPitchBearingAnimation } from '../animations/mapStopPitchBearingAnimation.js';
-import { mapSetPitchAndBearing } from '../camera/mapSetPitchAndBearing.js';
-import { mapGetPitch } from '../camera/mapGetPitch.js';
-import { mapGetBearing } from '../camera/mapGetBearing.js';
-
+import { degrees } from '../globals/degrees.js';
+import { dragStates } from '../weakmaps/dragStates.js';
+import { mapStopPitchBearingAnimation } from '../animations/mapStopPitchBearingAnimation.js';
+import { mapSetPitchAndBearing } from '../camera/mapSetPitchAndBearing.js';
+import { mapGetPitch } from '../camera/mapGetPitch.js';
+import { mapGetBearing } from '../camera/mapGetBearing.js';
+
+/**
+ * Update camera pitch and bearing from an active pointer drag.
+ *
+ * @param {PointerEvent} event Pointer-move event.
+ */
 export function cameraDragMove(event) {
   const state = dragStates.value.get(this);
   if (!state.drag || state.drag.id !== event.pointerId) return;

package/src/controls/changeCameraTouch.js

@@ -1,11 +1,9 @@
-import { cameraTouchStateByMap } from '../weakmaps/cameraTouchStateByMap.js';
-import { touchPitchByMap } from '../weakmaps/touchPitchByMap.js';
-import { touchRotateByMap } from '../weakmaps/touchRotateByMap.js';
-
-
-
-import { endCameraTouch } from './endCameraTouch.js';
-
+import { cameraTouchStateByMap } from '../weakmaps/cameraTouchStateByMap.js';
+import { touchPitchByMap } from '../weakmaps/touchPitchByMap.js';
+import { touchRotateByMap } from '../weakmaps/touchRotateByMap.js';
+import { endCameraTouch } from './endCameraTouch.js';
+
+/** Coordinate this map's native touch zoom with its camera touch handlers. */
 export function changeCameraTouch() {
   const state = cameraTouchStateByMap.get(this), { map, container } = state;
   const active = touchRotateByMap.get(map).enabled() || touchPitchByMap.get(map).enabled();

package/src/controls/cleanupCameraTouch.js

@@ -1,18 +1,15 @@
 import { cameraTouchStateByMap } from '../weakmaps/cameraTouchStateByMap.js';
 import { rotateControlByMap } from '../weakmaps/rotateControlByMap.js';
-
 import { cameraTouchStates } from '../globals/cameraTouchStates.js';
 import { touchByContainer } from '../weakmaps/touchByContainer.js';
-
-
 import { endCameraTouch } from './endCameraTouch.js';
 import { startCameraTouch } from './startCameraTouch.js';
 import { moveCameraTouch } from './moveCameraTouch.js';
 import { endCameraTouchEvent } from './endCameraTouchEvent.js';
-
 import { endAllCameraTouches } from './endAllCameraTouches.js';
 import { changeCameraTouch } from './changeCameraTouch.js';
 
+/** Remove this map's camera touch listeners, state and rotate control. */
 export function cleanupCameraTouch() {
   const state = cameraTouchStateByMap.get(this);
   if (!state) return;

package/src/controls/compassAddHooks.js

@@ -1,6 +1,7 @@
 import { compassOrientation } from './compassOrientation.js';
 import { finishCompassPermission } from './finishCompassPermission.js';
 
+/** Request device compass permission for this handler and install listeners when granted. */
 export function compassAddHooks() {
   this._compassGeneration = (this._generation = (this._generation || 0) + 1);
   this._orientation = /* alloc */ { handler: this, handleEvent: compassOrientation };

package/src/controls/compassOrientation.js

@@ -1,4 +1,10 @@
-import { mapSetBearing } from '../camera/mapSetBearing.js';
+import { mapSetBearing } from '../camera/mapSetBearing.js';
+
+/**
+ * Update the handler's map bearing from a device orientation event.
+ *
+ * @param {DeviceOrientationEvent} event Device orientation reading.
+ */
 export function compassOrientation(event) {
   const handler = this.handler;
   const bearing = Number.isFinite(event.webkitCompassHeading) ? -event.webkitCompassHeading : event.alpha;

package/src/controls/compassRemoveHooks.js

@@ -1,3 +1,4 @@
+/** Invalidate pending compass permission and remove this handler's orientation listeners. */
 export function compassRemoveHooks() {
   this._generation++;
   window.removeEventListener('deviceorientation', this._orientation);

package/src/controls/containerResizeAddHooks.js

@@ -1,5 +1,6 @@
 import { resizeMap } from './resizeMap.js';
 
+/** Observe this handler's map container for size changes. */
 export function containerResizeAddHooks() {
   const container = this._map.getContainer();
   container._containerResizeMap = this._map;

package/src/controls/containerResizeRemoveHooks.js

@@ -1,3 +1,4 @@
+/** Disconnect this handler's container resize observer. */
 export function containerResizeRemoveHooks() {
   const container = this._map.getContainer();
   this._observer.disconnect();

package/src/controls/dragCamera.js

@@ -1,8 +1,6 @@
 import { cameraDragSensitivity } from '../globals/cameraDragSensitivity.js';
 import { dragStates } from '../weakmaps/dragStates.js';
 import { cameraDrags } from '../globals/cameraDrags.js';
-
-
 import { cameraDragDown } from './cameraDragDown.js';
 import { cameraDragMove } from './cameraDragMove.js';
 import { cameraDragEnd } from './cameraDragEnd.js';
@@ -10,6 +8,17 @@ import { cameraDragClick } from './cameraDragClick.js';
 import { cameraDragContextMenu } from './cameraDragContextMenu.js';
 import { endAllCameraDrags } from './endAllCameraDrags.js';
 
+/**
+ * Install camera drag listeners on an element.
+ *
+ * @param {L.Map} map Map to manipulate.
+ * @param {HTMLElement} element Drag target.
+ * @param {Function} accept Predicate for starting a drag.
+ * @param {Array<number>} [sensitivity] Bearing and pitch sensitivities.
+ * @param {boolean} [orbit] Whether horizontal movement can orbit around the map center.
+ *
+ * @returns {Object} Registered drag state.
+ */
 export function dragCamera(map, element, accept, sensitivity = cameraDragSensitivity, orbit = false) {
   const state = /* alloc */ { map, element, accept, sensitivity, orbit, drag: null, moved: false };
   dragStates.value.set(element, state);

package/src/controls/endAllCameraDrags.js

@@ -1,8 +1,7 @@
 import { cameraDrags } from '../globals/cameraDrags.js';
-
-
 import { finishCameraDrag } from './finishCameraDrag.js';
 
+/** Finish every active camera drag, such as when the window loses focus. */
 export function endAllCameraDrags() {
   let state;
   for (state of cameraDrags.value) finishCameraDrag(state);

package/src/controls/endAllCameraTouches.js

@@ -1,8 +1,7 @@
 import { cameraTouchStates } from '../globals/cameraTouchStates.js';
-
-
 import { endCameraTouch } from './endCameraTouch.js';
 
+/** End all active camera touch gestures. */
 export function endAllCameraTouches() {
   let state;
   for (state of cameraTouchStates) endCameraTouch(state);

package/src/controls/endCameraTouch.js

@@ -1,3 +1,9 @@
+/**
+ * End a camera touch gesture and restore map dragging and zoom snapping.
+ *
+ * @param {Object} state Camera touch state.
+ * @param {TouchEvent} [event] Touch completion event.
+ */
 export function endCameraTouch(state, event) {
   if (!state.touch) return;
   if (event?.touches?.length >= 2) return;

package/src/controls/endCameraTouchEvent.js

@@ -1,8 +1,11 @@
 import { touchByContainer } from '../weakmaps/touchByContainer.js';
-
-
 import { endCameraTouch } from './endCameraTouch.js';
 
+/**
+ * End the camera touch gesture associated with this container.
+ *
+ * @param {TouchEvent} event Touch completion event.
+ */
 export function endCameraTouchEvent(event) {
   endCameraTouch(touchByContainer.get(this), event);
 }

package/src/controls/failCompassPermission.js

@@ -1,3 +1,9 @@
+/**
+ * Disable a compass handler and emit its permission error.
+ *
+ * @param {Object} handler Compass handler.
+ * @param {Error} error Permission or listener error.
+ */
 export function failCompassPermission(handler, error) {
   handler.disable();
   handler._map.fire('error', /* alloc */ { error });

package/src/controls/finishCameraDrag.js

@@ -1,3 +1,9 @@
+/**
+ * Finish an active camera drag and restore pointer capture, map dragging and cursor.
+ *
+ * @param {Object} state Camera drag state.
+ * @param {PointerEvent} [event] Pointer completion event.
+ */
 export function finishCameraDrag(state, event) {
   if (!state?.drag) return;
   if (event?.pointerId !== undefined && event.pointerId !== state.drag.id) return;

package/src/controls/finishCompassPermission.js

@@ -1,5 +1,12 @@
 import { failCompassPermission } from './failCompassPermission.js';
 
+/**
+ * Install compass listeners if the current permission request succeeded.
+ *
+ * @param {Array<Object>} results Settled handler-generation and permission results.
+ *
+ * @returns {*} Permission failure handler result when permission is unavailable or denied.
+ */
 export function finishCompassPermission([handlerResult, permissionResult]) {
   const { handler, generation } = handlerResult.value;
   if (!handler.enabled() || handler._generation !== generation) return;

package/src/controls/isEditableTarget.js

@@ -1,3 +1,10 @@
+/**
+ * Find an editable ancestor of an event target.
+ *
+ * @param {Element} target Event target.
+ *
+ * @returns {Element|null|undefined} Editable ancestor, if supported and found.
+ */
 export function editable(target) {
   return target.closest?.('input,textarea,select,[contenteditable="true"]');
 }

package/src/controls/loadCameraControls.js

@@ -1,3 +1,12 @@
+/**
+ * Load and initialize camera controls for a map that is still mounted.
+ *
+ * @param {L.Map} map Map receiving the controls.
+ *
+ * @returns {Promise<void>} Completion of control loading.
+ *
+ * @throws {Error} If loading or initialization fails, after emitting a map error.
+ */
 export async function loadCameraControls(map) {
   try {
     const { cameraControls } = await import('./cameraControls.js');

package/src/controls/moveCameraTouch.js

@@ -1,11 +1,14 @@
-import { touchPitchByMap } from '../weakmaps/touchPitchByMap.js';
-import { touchRotateByMap } from '../weakmaps/touchRotateByMap.js';
-
-import { degrees } from '../globals/degrees.js';
-import { touchByContainer } from '../weakmaps/touchByContainer.js';
-
+import { touchPitchByMap } from '../weakmaps/touchPitchByMap.js';
+import { touchRotateByMap } from '../weakmaps/touchRotateByMap.js';
+import { degrees } from '../globals/degrees.js';
+import { touchByContainer } from '../weakmaps/touchByContainer.js';
 import { mapSetPitchAndBearing } from '../camera/mapSetPitchAndBearing.js';
 
+/**
+ * Update camera angles and anchored zoom during a two-finger gesture.
+ *
+ * @param {TouchEvent} event Touch-move event.
+ */
 export function moveCameraTouch(event) {
   const state = touchByContainer.get(this), { map, container, touch } = state;
   if (!touch || event.touches.length !== 2) return;

package/src/controls/notifyCameraTouchChange.js

@@ -1 +1,2 @@
+/** Notify this handler's map that its camera touch configuration changed. */
 export function notifyCameraTouchChange() { this._map.fire('cameratouchchange'); }

package/src/controls/pitchDragAddHooks.js

@@ -2,7 +2,7 @@ import { cameraDragSensitivity } from '../globals/cameraDragSensitivity.js';
 import { dragCamera } from './dragCamera.js';
 import { acceptPitchDrag } from './acceptPitchDrag.js';
 
-
+/** Install camera pitch and orbit dragging on this handler's map container. */
 export function pitchDragAddHooks() {
   this._dragState = dragCamera(this._map, this._map.getContainer(), acceptPitchDrag, cameraDragSensitivity, true);
 }

package/src/controls/pitchDragRemoveHooks.js

@@ -1,5 +1,6 @@
 import { removeCameraDrag } from './removeCameraDrag.js';
 
+/** Remove this handler's camera drag listeners. */
 export function pitchDragRemoveHooks() {
   removeCameraDrag(this._dragState);
 }

package/src/controls/refreshRotateControl.js

@@ -1,6 +1,8 @@
 import { radians } from '../globals/radians.js';
 import { mapGetPitch } from '../camera/mapGetPitch.js';
 import { mapGetBearing } from '../camera/mapGetBearing.js';
+
+/** Update this rotate control's arrow, accessible description and visibility. */
 export function refreshRotateControl() {
   const map = this._map, pitch = this.options.visualizePitch ? mapGetPitch(map) : 0;
   this._arrow.style.transform = `scale(${1 / Math.sqrt(Math.max(0.01, Math.abs(Math.cos(pitch * radians))))}) rotateX(${pitch}deg) rotate(${mapGetBearing(map)}deg)`;

package/src/controls/refreshRotateFocus.js

@@ -1,5 +1,6 @@
-import { refreshRotateControl } from './refreshRotateControl.js';
-
+import { refreshRotateControl } from './refreshRotateControl.js';
+
+/** Refresh the rotate control associated with this button after focus changes. */
 export function refreshRotateFocus() {
   refreshRotateControl.call(this._rotateControl);
 }

package/src/controls/removeCameraDrag.js

@@ -1,15 +1,18 @@
-import { dragStates } from '../weakmaps/dragStates.js';
-import { cameraDrags } from '../globals/cameraDrags.js';
-
-import { finishCameraDrag } from './finishCameraDrag.js';
-import { cameraDragDown } from './cameraDragDown.js';
-import { cameraDragMove } from './cameraDragMove.js';
-import { cameraDragEnd } from './cameraDragEnd.js';
-import { cameraDragClick } from './cameraDragClick.js';
-import { cameraDragContextMenu } from './cameraDragContextMenu.js';
-
-import { endAllCameraDrags } from './endAllCameraDrags.js';
-
+import { dragStates } from '../weakmaps/dragStates.js';
+import { cameraDrags } from '../globals/cameraDrags.js';
+import { finishCameraDrag } from './finishCameraDrag.js';
+import { cameraDragDown } from './cameraDragDown.js';
+import { cameraDragMove } from './cameraDragMove.js';
+import { cameraDragEnd } from './cameraDragEnd.js';
+import { cameraDragClick } from './cameraDragClick.js';
+import { cameraDragContextMenu } from './cameraDragContextMenu.js';
+import { endAllCameraDrags } from './endAllCameraDrags.js';
+
+/**
+ * Finish a drag and remove its element and shared blur listeners.
+ *
+ * @param {Object} state Registered camera drag state.
+ */
 export function removeCameraDrag(state) {
   finishCameraDrag(state);
   const { element } = state;

package/src/controls/resizeMap.js

@@ -1,3 +1,8 @@
+/**
+ * Invalidate the map size associated with the first observed container.
+ *
+ * @param {Array<ResizeObserverEntry>} entries Resize observer entries.
+ */
 export function resizeMap(entries) {
   entries[0]?.target._containerResizeMap.invalidateSize();
 }

package/src/controls/rotateButtonClick.js

@@ -1,7 +1,12 @@
-import { cameraFocusOptions } from '../globals/cameraFocusOptions.js';
+import { cameraFocusOptions } from '../globals/cameraFocusOptions.js';
 import { mapResetNorthPitch } from '../camera/mapResetNorthPitch.js';
 import { mapResetNorth } from '../camera/mapResetNorth.js';
 
+/**
+ * Reset bearing and optionally pitch from the rotate control button.
+ *
+ * @param {MouseEvent} event Button click event.
+ */
 export function rotateButtonClick(event) {
   const control = this._rotateControl, map = control._map;
   event.preventDefault();

package/src/controls/rotateButtonKeydown.js

@@ -1,7 +1,13 @@
-import { mapSetBearing } from '../camera/mapSetBearing.js';
-import { mapGetBearing } from '../camera/mapGetBearing.js';
-import { mapSetPitch } from '../camera/mapSetPitch.js';
-import { mapGetPitch } from '../camera/mapGetPitch.js';
+import { mapSetBearing } from '../camera/mapSetBearing.js';
+import { mapGetBearing } from '../camera/mapGetBearing.js';
+import { mapSetPitch } from '../camera/mapSetPitch.js';
+import { mapGetPitch } from '../camera/mapGetPitch.js';
+
+/**
+ * Adjust camera angles or reset the rotate control using keyboard shortcuts.
+ *
+ * @param {KeyboardEvent} event Button key event.
+ */
 export function rotateButtonKeydown(event) {
   const control = this._rotateControl, map = control._map, step = event.shiftKey ? 15 : 5;
   if (event.key === 'ArrowLeft') mapSetBearing(map, mapGetBearing(map) - step);

package/src/controls/rotateControl.js

@@ -1,4 +1,12 @@
-import { L } from '../globals/L.js';
+import { L } from '../globals/L.js';
+
+/**
+ * Create a rotate control.
+ *
+ * @param {Object} options Control options.
+ *
+ * @returns {L.Control.Rotate} New control.
+ */
 export function rotateControl(options) {
   return /* alloc */ new L.Control.Rotate(options);
 }

package/src/controls/rotateOnAdd.js

@@ -8,7 +8,13 @@ import { dragCamera } from './dragCamera.js';
 import { acceptRotateDrag } from './acceptRotateDrag.js';
 import { refreshRotateFocus } from './refreshRotateFocus.js';
 
-
+/**
+ * Create this rotate control's accessible button and attach camera interactions.
+ *
+ * @param {L.Map} map Map receiving the control.
+ *
+ * @returns {HTMLElement} Control container.
+ */
 export function rotateOnAdd(map) {
   const container = L.DomUtil.create('div', 'leaflet-control-rotate leaflet-bar');
   const button = L.DomUtil.create('a', 'leaflet-control-rotate-toggle', container);

package/src/controls/rotateOnRemove.js

@@ -1,5 +1,10 @@
 import { pitchDragRemoveHooks } from './pitchDragRemoveHooks.js';
 
+/**
+ * Remove this rotate control's map listeners and drag interaction.
+ *
+ * @param {L.Map} map Map containing the control.
+ */
 export function rotateOnRemove(map) {
   map.off('rotate pitch', this._refresh, this);
   pitchDragRemoveHooks.call(this);

package/src/controls/shiftRotateAddHooks.js

@@ -1,7 +1,7 @@
 import { cameraListenerOptions } from '../globals/cameraListenerOptions.js';
 import { shiftRotateWheel } from './shiftRotateWheel.js';
 
-
+/** Install this handler's Shift-wheel rotation listener. */
 export function shiftRotateAddHooks() {
   const container = this._map.getContainer();
   container._cameraShiftRotate = this;

package/src/controls/shiftRotateRemoveHooks.js

@@ -1,3 +1,4 @@
+/** Remove this handler's Shift-wheel rotation listener. */
 export function shiftRotateRemoveHooks() {
   const container = this._map.getContainer();
   container.removeEventListener('wheel', this._wheel, true);

package/src/controls/shiftRotateWheel.js

@@ -1,7 +1,12 @@
-import { mapSetBearing } from '../camera/mapSetBearing.js';
-import { mapGetBearing } from '../camera/mapGetBearing.js';
-import { editable } from './isEditableTarget.js';
-
+import { mapSetBearing } from '../camera/mapSetBearing.js';
+import { mapGetBearing } from '../camera/mapGetBearing.js';
+import { editable } from './isEditableTarget.js';
+
+/**
+ * Rotate the map for Shift-wheel events outside editable targets and controls.
+ *
+ * @param {WheelEvent} event Wheel event.
+ */
 export function shiftRotateWheel(event) {
   const handler = this._cameraShiftRotate;
   if (!event.shiftKey || editable(event.target) || event.target.closest('.leaflet-control')) return;

package/src/controls/startCameraTouch.js

@@ -1,13 +1,16 @@
 import { touchPitchByMap } from '../weakmaps/touchPitchByMap.js';
 import { touchRotateByMap } from '../weakmaps/touchRotateByMap.js';
-
 import { L } from '../globals/L.js';
 import { touchByContainer } from '../weakmaps/touchByContainer.js';
-
 import { mapStopPitchBearingAnimation } from '../animations/mapStopPitchBearingAnimation.js';
 import { mapGetBearing } from '../camera/mapGetBearing.js';
 import { mapGetPitch } from '../camera/mapGetPitch.js';
 
+/**
+ * Start a two-finger camera gesture and retain its initial anchor and map state.
+ *
+ * @param {TouchEvent} event Touch-start event.
+ */
 export function startCameraTouch(event) {
   const state = touchByContainer.get(this), { map, container } = state;
   if (state.touch || event.touches.length !== 2 || event.target.closest('.leaflet-control')) return;

package/src/core/README.md

@@ -0,0 +1,28 @@
+# Leaflet integration
+
+[Source guide](../README.md) | [Project README](../../README.md)
+
+Contains Leaflet compatibility hooks and camera-aware behavior for native map
+layers, markers, popups and tooltips. The public entry point installs these hooks.
+
+## Compatibility boundary
+
+```mermaid
+flowchart LR
+  Entry["index.js"] --> Version{"Leaflet version"}
+  Version -->|1| Prototype["Hook native layer prototype"]
+  Version -->|2| Constructor["Compatible constructor + native prototype"]
+  Prototype --> Router["Source routing"]
+  Constructor --> Router
+  Entry --> Overlays["Camera-aware markers / popups / grids"]
+```
+
+The public contract remains `L.Layer`, including `instanceof`.
+[whenReady.js](./whenReady.js) returns a registered readiness promise or
+resolves immediately when none exists; source errors belong to initializers.
+
+- [constructLayer.js](./constructLayer.js): construct the compatible layer.
+- [layerCallInitHooks.js](./layerCallInitHooks.js): coordinate layer initialization hooks.
+- [whenReady.js](./whenReady.js): expose asynchronous readiness.
+
+Related: [scene](../scene/README.md), [camera](../camera/README.md), [native](../native/README.md).

package/src/core/adjustCameraMarkerPan.js

@@ -1,12 +1,17 @@
 import { L } from '../globals/L.js';
 import { dragByHandler } from '../weakmaps/dragByHandler.js';
-
 import { mapGetPitch } from '../camera/mapGetPitch.js';
 import { mapGetBearing } from '../camera/mapGetBearing.js';
-
 import { pointOf } from '../projections/toPoint.js';
 import { scheduleMarkerPan } from '../animations/scheduleMarkerPan.js';
 
+/**
+ * Auto-pan during marker dragging using screen-space movement under the camera.
+ *
+ * @param {Object} event Marker drag event.
+ *
+ * @returns {*} Original Leaflet handler result when the camera is untransformed.
+ */
 export function adjustCameraMarkerPan(event) {
   const marker = this._marker, map = marker._map;
   if (!mapGetPitch(map) && !mapGetBearing(map)) return dragByHandler.get(this)._cameraOriginalAdjustPan.call(this, event);

package/src/core/cameraCircleBounds.js

@@ -1,7 +1,11 @@
 import { boundsMethods } from '../weakmaps/boundsMethods.js';
 import { projectNativePath } from './projectNativePath.js';
 
-
+/**
+ * Project this circle when mapped and return its original Leaflet bounds.
+ *
+ * @returns {L.LatLngBounds} Circle bounds.
+ */
 export function cameraCircleBounds() {
   if (this._map) projectNativePath(this);
   return boundsMethods.get(this).call(this);

package/src/core/cameraMarkerDrag.js

@@ -1,9 +1,8 @@
 import { dragByHandler } from '../weakmaps/dragByHandler.js';
-
-
 import { cameraMarkerOnDrag } from './cameraMarkerOnDrag.js';
 import { adjustCameraMarkerPan } from './adjustCameraMarkerPan.js';
 
+/** Install camera-aware drag and auto-pan handlers on this marker once. */
 export function cameraMarkerDrag() {
   if (!this.dragging || dragByHandler.has(this.dragging)) return;
   const drag = this.dragging, original = drag._onDrag, adjustPan = drag._adjustPan;

package/src/core/cameraMarkerOnDrag.js

@@ -1,8 +1,11 @@
-import { L } from '../globals/L.js';
-import { dragByHandler } from '../weakmaps/dragByHandler.js';
-
-
+import { L } from '../globals/L.js';
+import { dragByHandler } from '../weakmaps/dragByHandler.js';
 
+/**
+ * Convert this marker's drag position through the camera before invoking Leaflet's handler.
+ *
+ * @param {Object} event Marker drag event.
+ */
 export function cameraMarkerOnDrag(event) {
   const map = this._marker._map;
   const screen = L.DomUtil.getPosition(this._marker._icon).add(map._getMapPanePos());

package/src/core/closestCameraLayerPoint.js

@@ -1,7 +1,13 @@
 import { closestMethods } from '../weakmaps/closestMethods.js';
 import { projectNativePath } from './projectNativePath.js';
 
-
+/**
+ * Project this path and find its closest layer point using Leaflet's original method.
+ *
+ * @param {L.Point} point Layer point to compare.
+ *
+ * @returns {L.Point} Closest point on the path.
+ */
 export function closestCameraLayerPoint(point) {
   projectNativePath(this);
   this._parts = this._rings;

package/src/core/constructLayer.js

@@ -1,6 +1,13 @@
 import { leafletLayer } from '../globals/leafletLayer.js';
 import { layerInitialize } from '../scene/layerInitialize.js';
 
+/**
+ * Construct a Leaflet layer, initialize its source and run initialization hooks.
+ *
+ * @param {Object} options Layer options.
+ *
+ * @returns {L.Layer} Constructed layer.
+ */
 export function constructLayer(options) {
   const layer = Reflect.construct(leafletLayer, /* alloc */ [], new.target);
   layerInitialize.call(layer, options);

package/src/core/extendLeafletClass.js

@@ -1,5 +1,12 @@
 import { L } from '../globals/L.js';
 
+/**
+ * Obtain a compatible Leaflet class, extending it on Leaflet 1.
+ *
+ * @param {Function} parent Parent Leaflet class.
+ *
+ * @returns {Function} Parent or extended class.
+ */
 export function extendLeafletClass(parent) {
   return L.version.startsWith('2.') ? parent : parent.extend(/* alloc */ {});
 }

package/src/core/extendTerrainPixelBounds.js

@@ -6,6 +6,16 @@ import { mapElevationOf } from '../terrain/mapElevationOf.js';
 import { groundBounds } from '../projections/groundBounds.js';
 import { animationPoint } from '../projections/transformZoomAnimationPoint.js';
 
+/**
+ * Extend tiled pixel bounds to include the visible footprint at cached terrain elevation extremes.
+ *
+ * @param {L.GridLayer} layer Grid layer with the tile zoom.
+ * @param {L.Bounds} result Bounds to extend in place.
+ * @param {Object} stream Terrain stream and elevation cache.
+ * @param {L.LatLng} origin Scene origin.
+ *
+ * @returns {L.Bounds} Extended bounds.
+ */
 export function extendTerrainPixelBounds(layer, result, stream, origin) {
   const map = layer._map;
   let minimum = Infinity, maximum = -Infinity, key, entry;