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

Function preparePlacesForDisplay

preparePlacesForDisplay<P extends CommonPlaceProps = CommonPlaceProps>(
shownPlaces: ShownPlaces,
config?: PlacesModuleConfig<P>,
): Places<DisplayPlaceProps>
Prepares places as PlacesModule.show does 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 if it's a function, otherwise buildPlaceTitle.
- iconID - The image the marker type and PlaceIconConfig pick.
- category and group, under the base-map and pin-clustered marker types.
- baseMapIconID, under the pin-clustered marker type.
- Every PlacesModuleConfig.extraFeatureProps entry.
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
```