Interface MeridianMap

Returned from createMap, this object allows you to manipulate a map that has already been created in the page.

interface MeridianMap {
    centerMap: (() => void);
    destroy: (() => void);
    isDestroyed: boolean;
    update: ((updatedOptions) => void);
    zoomToDefault: (() => void);
    zoomToPoint: ((options) => void);
}

Properties

centerMap destroy isDestroyed update zoomToDefault zoomToPoint

Properties

centerMap

centerMap: (() => void)

Center the map while retaining the current scale.

Type declaration

    • (): void

    • Returns void

destroy

destroy: (() => void)

Remove the Meridian Map from the DOM and clean up all ongoing network connections.

If you are writing a single page app you MUST use this call before hiding the Meridian Map, or you will having network connections that keep going in the background.

Type declaration

    • (): void

    • Returns void

isDestroyed

isDestroyed: boolean

Has this map been destroyed

update

update: ((updatedOptions) => void)

Update the Meridian map to have new options.

Type declaration

    • (updatedOptions): void

    • Parameters

      Returns void

zoomToDefault

zoomToDefault: (() => void)

Set zoom to the default level and pan to the default position.

Type declaration

    • (): void

    • Returns void

zoomToPoint

zoomToPoint: ((options) => void)

Pan to x/y coordinate and scale to a given zoom factor.

Type declaration

    • (options): void

    • Parameters

      • options: {
            scale: number;
            x: number;
            y: number;
        }
        • scale: number
        • x: number
        • y: number

      Returns void

Settings

Member Visibility

Theme

On This Page

centerMapdestroyisDestroyedupdatezoomToDefaultzoomToPoint