Interface MapBinding

Live connection between one controller and one host map, created by a MapAdapter.

A binding owns only the layers, markers and interactions it adds. Optional members are capabilities: editors hide controls whose method is absent.

interface MapBinding {
    cancelDrawing(): void;
    capture?(): Promise<MapCapture>;
    detach(): void;
    finishDrawing?(): void;
    fitOverlay(): void;
    navigateHistory?(direction: -1 | 1): void;
    resize?(): void;
}

Index

Methods

cancelDrawing capture? detach finishDrawing? fitOverlay navigateHistory? resize?

Methods

cancelDrawing

cancelDrawing(): void
Abort an unfinished sketch and any pending control-point pair.

Returns void
- Defined in packages/core/src/map/binding.ts:42

`Optional`capture

capture?(): Promise<MapCapture>
Capture the currently rendered map for reports.

Returns Promise<MapCapture>
- Defined in packages/core/src/map/binding.ts:50

detach

detach(): void
Remove every owned layer, interaction and listener and abort reference requests. Idempotent. The host map, its layers and its view are preserved.

Returns void
- Defined in packages/core/src/map/binding.ts:38

`Optional`finishDrawing

finishDrawing?(): void
Complete the active line or polygon sketch. Present when digitizing is supported.

Returns void
- Defined in packages/core/src/map/binding.ts:46

fitOverlay

fitOverlay(): void
Fit the host view to the current preview overlay; no-op without a preview.

Returns void
- Defined in packages/core/src/map/binding.ts:40

`Optional`navigateHistory

navigateHistory?(direction: -1 | 1): void
Step through recorded map views: -1 goes back, 1 goes forward.
Parameters
- direction: -1 | 1
Returns void
- Defined in packages/core/src/map/binding.ts:48

`Optional`resize

resize?(): void
Recompute the map size after its container changed size.

Returns void
- Defined in packages/core/src/map/binding.ts:44