This is the documentation of version 0.62.0. Go to the latest version, 1.0.0-rc.5.

Type Alias PlacesBeforeLayerConfig

PlacesBeforeLayerConfig: PartsBeforeLayerConfig<"places" | "connections">

Where the places module's layers sit in the map's layer stack: one target for everything it draws, or one per part of it.

Remarks

The parts, named after the module's event scopes, and where each sits by default:

places — the markers and their labels, selected places, clusters with their badges and counts, and entry points. Above the map's layers, except the small POI dots the base-map and pin-clustered marker types draw, which sit below the map's place labels. A target puts them all beneath it, the dots right under the markers.
connections — the lines PlacesModule.showConnections draws, and their labels. Below the map's labels.

Each part keeps its own layers' order wherever it goes. A target the style lacks puts the part on top.

Example

// The markers under the map's labels, the connections where they are
const underLabels: PlacesBeforeLayerConfig = { places: 'lowestLabel' };
// Everything on top of the map
const everything: PlacesBeforeLayerConfig = 'top';