Type Alias PlaceConnectionLabelConfig

The labels PlacesModule draws along its connection lines.

type PlaceConnectionLabelConfig = {
    color?: string;
    haloColor?: string;
    title?: (connection: PlaceConnectionDisplay) => string;
}

Properties

color?: string

The colour of the labels. By default, a darker shade of the line colour on a light map, and a lighter one on a dark map.

haloColor?: string

The colour of the halo around the labels. By default, '#FFFFFF' on a light map and '#333333' on a dark one, as for the places' own labels.

title?: (connection: PlaceConnectionDisplay) => string

The text along a connection line.

Receives the original PlaceConnectionDisplay (including any custom metadata). When omitted, no label is rendered.