This template adds a box to the right of the page, which includes a link to display map data – either from:
- data stored in GeoJSON format on Commons
- line/polygon features in OpenStreetMap.
- coordinates, either supplied or from Wikidata
- raw GeoJSON, preferably transcluded from another page
Note:
{{Mapbox}} utilises Template:Maplink. As a result, usage of the two templates is very similar.
Basic usage
| Type |
Code |
Notes |
Example
|
| Data page on Commons |
{{mapbox|from=}} |
specify .map data page in from=, excluding the Data prefix |
|
| Raw GeoJSON data |
{{mapbox|raw=}} |
e.g. {{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}} |
|
| Line of a border or a linear feature from OSM |
{{mapbox|type=line|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Shape from OSM |
{{mapbox|type=shape|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Inverted shape from OSM |
{{mapbox|type=shape-inverse|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Point feature from Wikidata coordinates |
{{mapbox|type=point|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Point feature from specified coordinates |
{{mapbox|type=point|coord=}} |
Use {{Coord}} template to specify coordinates |
|
Full parameter set – data page
{{mapbox
|from=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – raw data
{{maplink
|raw= <!-- preferably {{Wikipedia:Map data/subpage}} -->
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – OSM features
{{mapbox
|type=
|id=
|title=
|description=
|stroke-color=
|stroke-width=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – point features/coordinates
{{mapbox
|type=point
|id=
|title=
|description=
|coord=
|marker=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Up to five links can be included within the one box by adding "2", "3", "4" or "5" to the end of the parameter name - e.g.data2 or description2. All parameters support this except for above, below and text-left. Unlike the first link (where it is optional), the text parameter is required for links 2-5.
- type
- Type of data. Valid values are:
line – a geoline feature from OSM (e.g. a road)shape – a geoshape feature from OSM (e.g. a state or province)shape-inverse – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath)data – a geoJSON data page on Commons (parameter is optional in this case)point – a point feature (coordinates)
- id
- (or ids)
- Wikidata id (Q-number) that the OSM feature is tagged with. Separate multiple ids with a comma. Defaults to the current page's Wikidata id (if
|from= not set).
- from
- The JSON (.map) file from Commons to display (excluding the
Data: prefix)
- raw
- raw GeoJSON (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See below for more information.
- title
- Title of the feature (for features from OSM), displayed when the feature is clicked on; default is the page title
- description
- Description of the feature (for features from OSM), displayed when the feature is clicked on; optional
- coord
- Coordinates to display for a point feature. Use {{Coord}} template to specify coordinates. If not set, coordinates will be retrieved from Wikidata.
- marker
- Name of Maki marker image to display at the point feature. See mw:Maps/Icons for options. Defaults to
marker (plain marker) if not set.
- stroke-color
- (or stroke-colour)
- Colour code for the colour used to draw the feature (for features from OSM); default is
#555555 ( )
- stroke-width
- Width for the lines used to draw the feature (for features from OSM); default is
5
- zoom
- Zoom level, from
1 to 19 (larger numbers zoom in further); will be automatically determined if not set
- above
- Content (such as explanatory text) appearing above the links
- below
- Content (such as explanatory text) appearing below the links
- text
- Text to display for the link; default is "View map"
- text-left
- Set this to
yes to change the link text from centre-aligned to left-aligned
The "raw" parameter allows the same inputs as the full <maplink> function. It allows you to:
- Use GeoJSON data directly
- Use a combination of data sources together (direct GeoJSON, external data from Wikimedia Commons and external data from OpenStreetMap)
- Have more options for directly styling data (data from Commons will inherit the styling specified in the .map page)
- Include multiple pieces of external data from Wikimedia Commons
- Use Wikidata queries to obtain information for the map
- Use templates - if a map includes direct GeoJSON or many components, placing the data in a template will avoid cluttering the article text
- When retrieving lines or shapes from OSM, you can't style the fill colour or the opacity level of fills or strokes (unless you use the
|raw= parameter).
- The following code utilising the
|raw= parameter won't work because the curly brace to close the GeoJSON is adjacent to the curly braces to close the template:
{{Mapbox|raw= {"type": "ExternalData","service": "geoshape","ids": "Q13518258"}}}
- To fix it, put a space before the two template braces or move them to a separate line.
- {{Maplink}}'s multiple features functionality doesn't work; use
|raw= instead.
