road_labels

Content: default, road_labels
Geometry: line
Zoom: 5–17

🚧
Deprecated
The road_labels layer is deprecated and will be removed in January 2027.
Instead, use the roads layer that provides similar data.

The road_labels layer refers to the textual information associated with road features on a map. These labels provide important details about roads and highways, making it easier for users to navigate and understand the geography.

The road_labels layer serves as an optional component, offering deduplicated labeling properties (name, ref, network, and shield_text) and streamlined label placement geometries for various types of transportation, encompassing but not limited to highways, major roads, minor roads, paths, and ferries, all of which are part of the roads layer.

Within the roads layer, each road segment carries labeling properties, and these properties often repeat, especially for consecutive road segments. To eliminate duplicates and streamline data for more efficient client-side processing, the road_labels layer retains pre-merged and simplified representations of consecutive road segments that share the same name properties. However, you have the flexibility to choose between the roads and road_labels layers depending on your specific requirements for labeling properties.

Example

The following code snippet shows sample vector data for a road_labels feature in the GeoJSON format:

{
  "type": "Feature",
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [
        13.428640365600586,
        52.51817948774524
      ],
      [
        13.430078029632568,
        52.518192544944384
      ],
      [
        13.448081016540527,
        52.51635144156805
      ]
    ]
  },
  "properties": {
    "kind": "major_road",
    "kind_detail": "secondary",
    "name": "Karl-Marx-Allee",
    "name:de": "Karl-Marx-Allee",
    "ref": "B1",
    "all_route_types": "3;3",
    "shield_text": "1",
    "all_shield_texts": "1;5",
    "all_networks": "DE:BS;DE:BS",
    "all_refs": "B1;B5",
    "network": "DE:BS",
    "vt_layer": "road_labels"
  }
}

Properties

kind | kind_detail | all_networks | all_refs | all_route_types | all_shield_texts | fclass | is_link | name | name:{language_code} | network | ref | service | shield_text | translit:{language_code}

Common properties specific to Japan - core map

source

kind

Type: string
Always present

Value	Zoom	Description
`aerialway`	14–17	Represents aerial transportation systems such as gondolas, chairlifts, or cable cars.
`ferry`	7–17	Denotes ferry routes or paths across bodies of water.
`highway`	5–17	Represents roads, streets, or thoroughfares designed for vehicular traffic.
`major_road`	6–17	Represents roads of significant importance or size within a road network.
`minor_road`	10–17	Denotes roads of lesser significance or size within a road network.
`path`	12–17	Represents pathways or trails designated for pedestrians, cyclists, or specific non-motorized transport.
`piste`	14–17	Denotes ski slopes or trails for skiing or snowboarding.
`rail`	12–17	Depicts railway tracks or routes for trains or other rail transport.

kind_detail

Type: string
Always present

Value	Description	Associated `kind`
`chair_lift`	A type of aerial lift carrying seated passengers on chairs, commonly used at ski resorts.	`aerialway`
`downhill`	A ski slope or trail designated for downhill skiing.	`piste`
`ferry`	Denotes the kind_detail for ferry routes or crossings across bodies of water.	`ferry`
`footway`	A path or lane designated primarily for pedestrian use.	`path`
`motorway`	A high-capacity divided highway designed for high-speed traffic, typically with controlled access.	`highway`
`pedestrian`	A road or path in urban areas designated primarily for pedestrian traffic.	`path`
`primary`	A major road forming part of the primary network within a region.	`major_road`
`rail`	Standard railway tracks used for train services.	`rail`
`residential`	A road primarily intended for residential access, typically within housing areas.	`minor_road`
`secondary`	A road of regional importance, typically connecting smaller towns and settlements.	`major_road`
`service`	A road used to access services such as parking lots, fuel stations, or industrial areas.	`minor_road`
`tertiary`	A less significant road, typically connecting villages and minor settlements.	`major_road`
`trunk`	A high-capacity road of regional or national importance, below motorway classification.	`highway`

all_networks

Type: string
Array
Optional

All the networks associated with the particular road. These networks are presented as a collection of network values separated by semicolons. For further details, see the network property definition.

all_refs

Type: string
Array
Optional

Encompasses all the references associated with this road. These references are presented as a sequence of ref values separated by semicolons. For further details, see the ref property definition.

all_route_types

Type: int|string
Array: element type: int
Present when kind is: ferry, highway, major_road, minor_road, path, rail · Present when kind_detail is: ferry, footway, motorway, pedestrian, primary, rail, residential, secondary, service, tertiary, trunk

Lists all the route types to which a road segment belongs as a list of semicolon-separated numeric codes and is used in shield styling, taking into account country-specific conventions.

all_shield_texts

Type: string
Array
Optional

Lists all the shield texts associated with the particular road. These texts are presented as a collection of shield_text values separated by semicolons. For further details, see the shield_text property definition.

fclass

Type: int
Present when kind is: ferry, highway, major_road, minor_road, path · Present when kind_detail is: ferry, footway, motorway, pedestrian, primary, residential, secondary, tertiary, trunk

This property indicates a functional class numeric value for roads with kind_detail:motorway and kind_detail:motorway_link.

Values

Value
`1`
`2`
`3`
`4`
`5`

Values specific to Japan - core map

Value
`6`
`7`
`8`

is_link

Type: flag
Present when kind is: highway, major_road, minor_road · Present when kind_detail is: motorway, primary, residential, secondary, service, tertiary, trunk · Present when zoom is: 9, 10, 11, 12, 13, 14, 15, 16

Set to true and present only if the road is part of a highway link or ramp.

name

Type: string
Optional

The common local name for the road feature, in the local language script. For more information, see Feature names.

name:{language_code}

Type: string
Optional

The name of the feature in the specified language. If no data is available for the requested language code, the value may be compiled from an English or Latin transliteration of existing language representations. For more information, see Name localization.

network

Type: string
Optional

A useful property for shields and road selections, network contains road network types, such as US:I for the United States Interstate network. For more information, see Road network values.

ref

Type: string
Optional

Serves as a commonly recognized reference for roads, this property includes identifiers like I 90 for Interstate 90, especially useful when used with road shields.

service

Type: string
Present when kind is: minor_road · Present when kind_detail is: service · Present when zoom is: 14, 15, 16

Value
`parking_aisle`

shield_text

Type: string
Optional

Contains the text to be shown on shields. For example, I 90 corresponds to a network of US:I and a shield_text of 90. This simplifies shield display, eliminating the need for further processing. Some roads may include non-numeric characters in this property, as seen with the M1 motorway in the UK, where shield_text is M1 instead of just 1.

translit:{language_code}

Type: string
Optional

The localized transliteration of the default name (name). For more information, see Name localization.

Common properties specific to Japan - core map

source

See source.