Javascript Hooks

Hook into events in the lifecycle of your map

A "hook" in our parlance is, like in Wordpress generally, a place where you can "hang" a function that you want to run. Every hook recieves certain variables and can be registered to run on a specific map.

For example, let's say we need to resize the map in some special way after the page loads.

We'll register our hook before the map runs:

mwm.add_action('map_set', (map) => {
  // Do something with the map
  map.on('load', () => {
    map.setZoom(12);
  })
})

If you want to only target a specific map on a specific page, you can also pass the map ID (found by hovering over the map in the Maps > Maps screen, or in the URL when editing the map) to the hook function as follows:

mwm.add_action('map_set/mapster-7314', (map) => {
  // Do something with the map
  map.on('load', () => {
    map.setZoom(12);
  })
})

See below for lists of hooks as well as what data they provide. Get in touch if what you need isn't here!

General Hooks

Hook Name

Variables Passed

Description

access_token_set

After Access Token is set, if present.

data_fetched

postResponse

After all data to load map is fetched.

map_size_set

After map DOM element size is initially set.

map_library_set

mapLibrary

After map library (MapLibre, Mapbox, or Google Maps) is set.

map_set

map

After map variable is initialized.

set_interactivity

After map interactivity is enabled or disabled.

set_terrain

After map 3D terrain is enabled.

loading_icon_started

After loading icon appears.

loading_icon_done

After loading is completed.

map_resize_set

Whenever map is resized during runtime.

map_markers_set

markers

After markers are set onto map.

map_features_set

After map features set as Mapbox layers are placed onto map.

map_datalayers_set

dataLayers

After map features set as Google Maps data layers are placed onto map.

set_clustering

After map layers clustering has completed.

set_customscripts

After custom scripts are run.

set_mapstyle

After anytime the map style changes.

Controls Hooks

Hook Name

Variables Passed

Description

zoom_control_set

zoomControl