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

Function preparePlacesForDisplay

preparePlacesForDisplay<P extends CommonPlaceProps = CommonPlaceProps>(
shownPlaces: ShownPlaces,
config?: PlacesModuleConfig<P>,
): Places<DisplayPlaceProps>
What PlacesModule.show does to the places it is given before drawing them.
Type Parameters
- P extends CommonPlaceProps = CommonPlaceProps
Parameters
- shownPlaces: ShownPlaces
- config: PlacesModuleConfig<P> = {}
Returns Places<DisplayPlaceProps>
Remarks
show() calls it itself; call it to see what the layers, layers.* overrides and click handlers read. Each place keeps its properties and gains the PlaceDisplayProps:
- id: the place's, or a generated one, copied into properties for MapLibre's promoteId
- title: PlaceLabelConfig.title when it is a function, else buildPlaceTitle
- iconID: the image the marker type and PlaceIconConfig pick
- category and group under the base-map and pin-clustered marker types
- every PlacesModuleConfig.extraFeatureProps entry, and the EV availability ones when EVAvailabilityConfig.enabled is set
An iconID naming an image the module adds itself, the default pin or a PlaceIconConfig.categoryIcons entry, is the first module's name for it. PlacesModule.getShown returns a given module's places as it drew them.
Example
```
const [first] = preparePlacesForDisplay(await discoverPlaces({ query: 'coffee' }), { markerType: 'base-map' }).features;
first.properties.title; // what the label shows
first.properties.category; // what the base-map look keys its colour on
```