@meridian/web-sdk
    Preparing search index...

    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: Partial<CreateMapOptions>) => void;
        zoomToDefault: () => void;
        zoomToPoint: (options: { scale: number; x: number; y: number }) => void;
    }
    Index

    Properties

    centerMap destroy isDestroyed update zoomToDefault zoomToPoint

    Properties

    centerMap: () => void

    Center the map while retaining the current scale.

    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.

    isDestroyed: boolean

    Has this map been destroyed

    update: (updatedOptions: Partial<CreateMapOptions>) => void

    Update the Meridian map to have new options.

    zoomToDefault: () => void

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

    zoomToPoint: (options: { scale: number; x: number; y: number }) => void

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

    Settings

    Member Visibility

    On This Page

    Properties