Mapbox Indoor v1

Source id:
mapbox.indoor-v1

This is a guide to the layers and data inside the Mapbox Indoor vector tile source to help with styling.

Beta

The Mapbox Indoor tileset is in beta and is subject to potential changes. For access to this tileset, email sales@mapbox.jp.

Overview

This tileset provides floor plans and points of interests inside buildings. It can be used independently or together with the Mapbox Streets v8 tileset.

Data sources & updates

This tileset only covers Japan. It uses data from Zenrin and is updated with every new Zenrin data release every 3 months.

When you publicly use styles or software that use Mapbox Indoor vector tiles, you must display proper attribution.

The current supported version of the Mapbox Indoor vector tiles receives regular data updates as new information becomes available and existing information is improved.

Data stability

As we make ongoing data updates to reflect changes in the world or integrate new data vendors, we may also add new layers, fields, and values to Mapbox Indoor tiles. Our goal is to do this in a way that preserves compatibility with existing styles. Here's what you need to know about how Mapbox Indoor v1 may change in the future:

  • Layers
    • Existing layers will not be renamed or removed.
    • New layers may be added.
  • Fields
    • Existing fields will not be renamed or removed.
    • New fields may be added to any layer.
  • Field values
    • The meanings of existing values will not change.
    • Values of specific features may change to correct errors or reflect real-world changes.
    • New values may be added to any field unless otherwise noted in this documentation.

Common fields

There are several fields that are used across several layers. These fields are detailed below instead of being duplicated for each relevant layer in the Layer reference section.

name text and name_<lang-code> text

Label names are available in many languages. The name_* value is null if no translation data is available for a given feature.

If the name field is null for a particular feature, then all the language-specific name_* fields is also null. This means that name should always be the final fallback value if you want to include it in your set of label languages.

If the name field contains text that is meant to be rendered on multiple lines (horizontally or vertically) the text is separated by zero-width space characters.

FieldDescription
nameThe name (or names) used locally for the place.
name_jaJapanese

name_script text

Wherever there is a name field, there is also a name_script field that describes the primary script used in that text. This can be helpful for customizing fonts or language fallback conditions. Values include:

Han
Hiragana
Katakana
Latin

The value is null if name is also null.

maki text

Some layers have a maki field designed to make it easier to assign icons using the Maki icon project or other icons that follow the same naming scheme. Note that not all icons from the Maki project are used in Mapbox Indoor. Each layer uses a different subset of the names, but the full list of values used in Mapbox Indoor is compiled here so you can make sure your style has all the icons needed across different layers.

indoor_poi_label:

bank
cafe
car-rental
clothing-store
convenience
fast-food
furniture
grocery
ice-cream
information
junction
marker
mobile-phone
parking
pharmacy
police
post
restaurant
restaurant-noodle
shoe
shop
suitcase
toilet

indoor_structure:

defibrillator
emergency-phone
marker
telephone
waste-basket

maki_beta text

Maki icons that might be supported in future versions of Mapbox Indoor are in maki_beta field. Possible values include, but are not limited to:

indoor_poi_label:

atm
mall
restaurant-casual
restaurant-sushi
smoking
station-office
ticket
toilet-female
toilet-male

indoor_structure:

arrow
bench
elevator
entrance
escalator
locker
moving-walkway
platform
ramp
ticket
turnstile
vending-machine

maki_modifier text

Localized Maki icons are enabled with the maki_modifier field. The value of maki_modifer corresponds to an ISO country code. If it's present on a feature, you can use it to swap out a default Maki icon with a country-specific one.

For example, the widely recognized symbol for banks in Japan is different than that for the US. In the indoor_poi_label layer, all features that represent banks have a maki field with value bank. Of those features, the ones located in Japan also have a maki_modifer field with a value of JP. This allows you to specify the bank-JP Maki icon rather than the bank icon when styling your map.

floor_id number

Floor number is a sequence number for a floor; for example, -1, 0, 1, 2, 3, 4.

Note that a floor_id of 0 does not necessarily mean ground floor (consider a building built on a slope). Mezzanine floors are also represented by an integer value.

floor_level text

Floor level is the abbreviated name of a floor; for example: B1F, MB1F, 1F, M2F.

facility_id text

Unique ID of a facility. All features in the same facility has the same facility_id, regardless of which floor they are on.

Note that a facility is not equivalent to a building. For example, a building can host a train station above ground and an underground mall, in which case the train station is one facility and the mall is another facility.

Layer Reference

The Mapbox Indoor v1 tileset contains the following layers. For reference, the current minimum-available zoom level for each layer is mentioned, but please that this is subject to change as we make updates and improvements. It also does not apply to all features within a layer. Only the most prominent features are available at lower-numbered zoom levels, and more features are available as you zoom in. Labels for physically-large features also have a maximum zoom level based on their size.

indoor_floorplan

min zoom level: 13buffer: 2

This layer contains the polygon footprint of stores, corridors, common areas, floors and facilities in a building.

A floor polygon is the aggregation of all stores, corridors, and common area polygons on the same floor in the same facility. (Note that a facility is not necessarily equivalent to a building.)

A facility polygon is the aggregation of all floor polygons in the same facility.

Here's a list of fields in the indoor_floorplan layer:

FieldData typeNullableDescription
classtextNoMapbox class that best describes the purpose of the space inside the polygon.
typetextYesMapbox type that best describes the purpose of the space inside the polygon.
facility_idtextNoUnique ID of a facility.
floor_idnumberYesFloor level in integer; null for facility polygons.
floor_leveltextYesFloor level abbreviation; null for facility polygons.

class text

Indoor floorplan class values include but are not limited to:

area
arts_and_entertainment
commercial_services
facility
floor
food_and_drink
food_and_drink_stores
landmark
medical
public_facilities
room
store_like
visitor_amenities

type text

Indoor floorplan type values include but are not limited to:

Amusement arcade
Area
Atm
Bank
Beauty
Books
Bureau de change
Cafe
Car rental
Childcare
Clothes
Convenience
Courier
Electronics
Fast food
Fountain
Furniture
Greengrocer
Ice cream
Information
Juice bar
Key cutter
Kiosk
Lost and found
Massage
Mobile phone
Office
Pharmacy
Photo booth
Platform
Police
Post office
Ramen
Rental
Restaurant
Restricted
Room
Shoes
Shop
Smoking area
Soba
Sports
Staff
Supermarket
Ticket
Toilets
Waiting room
Facility
Floor

indoor_poi_label

min zoom level: 5buffer: 64

This layer is used to place icons and labels for various points of interest (POIs). This layer includes centroid point(s) of every floor of a facility as well as the centroid of the entire facility as a whole.

See names and name_script in for information about names and translations available for label text.

See maki and maki_beta for more information about using these fields for assigning icons.

Here's a list of fields in the indoor_poi_label layer:

FieldData typeNullableDescription
classtextNoMapbox class that best describes the content of the polygon.
typetextYesMapbox type that best describes the content of the polygon.
brandtextYesStandardized brand name for chain stores.
nametextYesName label.
name_jatextYesName in Japanese.
name_scripttextYesPrimary script for name attribute.
makitextYesMaki icon value. See maki.
maki_betatextYesMaki icons that might be supported in future versions of Mapbox Indoor. See maki_beta.
maki_modifiertextYesRegion modifier for maki icon. See maki_modifier.
source_idtextYesUnique ID of a POI.
facility_idtextNoUnique ID of a facility.
floor_idnumberYesFloor level in integer; null for facility polygons.
floor_leveltextYesFloor level abbreviation; null for facility polygons.

class text

Indoor POI class values include but are not limited to:

arts_and_entertainment
building
commercial_services
food_and_drink
food_and_drink_stores
landmark
medical
motorist
public_facilities
room
store_like
visitor_amenities

type text

Indoor POI type values include but are not limited to:

Amusement arcade
Atm
Bank
Beauty
Books
Bureau de change
Cafe
Car rental
Childcare
Clothes
Convenience
Courier
Electronics
Fast food
Furniture
Greengrocer
Ice cream
Information
Juice bar
Key cutter
Kiosk
Lost and found
Mall
Massage
Mobile phone
Office
Parking
Pharmacy
Photo booth
Police
Post office
Ramen
Rental
Restaurant
Shoes
Shop
Smoking area
Soba
Sports
Supermarket
Ticket
Toilets
Waiting room

brand text

Indoor POI brand values include but are not limited to all brand values in Mapbox Streets V8 and the following:

kiosk
metros
midori-no-madoguchi
newdays

source_id text

An indoor POI's source_id is a unique ID created by concatenating Zenrin's prefecture code, industry code, and sequence number. source_id is not guaranteed to be stable.

indoor_structure

min zoom level: 13buffer: 4

This layer includes points, lines, and polygons for features such as coin lockers, ticket machines, elevators, wall, signage, etc.

The fields in the indoor_structure layer are:

FieldData typeNullableDescription
classtextNoMapbox class that best describes the content of the polygon.
typetextYesMapbox type that best describes the content of the polygon.
nametextYesName label.
name_jatextYesName in Japanese.
name_scripttextYesPrimary script for name attribute.
makitextYesMaki icon value. See maki.
maki_betatextYesMaki icons that might be supported in future versions of Mapbox Indoor. See maki_beta.
maki_modifiertextYesRegion modifier for maki icon. See maki_modifier.
directionnumberYesAngle of rotation for an arrow.
source_idtextYesUnique ID of a point feature.
facility_idtextNoUnique ID of a facility.
floor_idnumberYesFloor level in integer; null for facility polygons.
floor_leveltextYesFloor level abbreviation; null for facility polygons.

class text

Indoor structure class values include but are not limited to:

area
commercial_services
corridor
door
general
railway
road
room
visitor_amenities
wall

type text

Indoor structure type values include but are not limited to:

Bench
Corridor
Defibrillator
Elevator
Entrance
Escalator
Exit
Help point
Locker
Moving walkway
Phone
Platform
Public transport tickets
Rail
Ramp
Road
Steps
Tactile map
Telephone
Turnstile
Vending machine
Wall
Waste basket

direction text

An integer between 0 degrees and 359 degrees for rotating an arrow icon.

directionArrow Orientation
0Arrow points to the left (east)
90Arrow points to the bottom (south)
180Arrow points to the right (west)
270Arrow points to the top (north)

To use the direction value to rotate an icon in Mapbox Studio, the formula is:

["get", "direction"]

source_id text

source_id is a unique ID created by concatenating Zenrin's prefecture code, industry code, and sequence number. source_id is not guaranteed to be stable. Only point structures can have a source_id.

Was this page helpful?