Function show3dMap

Render a Mappedin map into the given DOM container and return its MapView.

This is the main entry point for Mappedin JS. Combine with getMapData to load venue data and render an interactive 3D map.

Example

const mapData = await getMapData({ key: '...', secret: '...', mapId: '...' });
const mapView = await show3dMap(document.getElementById('mappedin-map')!, mapData);
  • show3dMap(
        el: HTMLElement,
        mapData: MapData,
        options?: TShow3DMapOptions,
    ): Promise<MapView>

    Parameters

    • el: HTMLElement

      The container element to render the map into. Must be attached to the DOM and have non-zero size.

    • mapData: MapData

      Venue data, typically obtained from getMapData.

    • Optionaloptions: TShow3DMapOptions

      Optional TShow3DMapOptions to customize the initial state, UI, and behavior of the map.

    Returns Promise<MapView>

    A promise that resolves to a MapView once the map has been initialized.

Settings

Member Visibility