Lypomania: 1 revision imported

2026-01-18T08:06:21Z

1 revision imported

← Older revision	Revision as of 08:06, 18 January 2026
(No difference)

Wikipedia>Hooman Mallahzadeh: /* Customizing which features are displayed */

2025-11-25T18:11:05Z

Customizing which features are displayed

New page

{{Documentation subpage}}

{{High-use}}
{{lua|Module:Infobox mapframe}}
{{Uses Wikidata|P625}}
{{Tracks Wikidata|P402|cat=Infobox mapframe without OSM relation ID on Wikidata}}
{{Sister project
|image=[[File:Openstreetmap logo.svg|40x40px]]
|text=This template uses the [[OpenStreetMap]] tag:
*'''''[https://wiki.openstreetmap.org/wiki/Key:wikidata wikidata]''''' (see [https://wiki.openstreetmap.org/wiki/Talk:Key:wikidata talk]; [https://taginfo.openstreetmap.org/keys/wikidata taginfo])
}}
{{Lua sidebar}}

This template generates a mapframe map, suitable for infoboxes, with minimal user input. This template only works with single features (points, lines, or shapes); use {{tlx|maplink}} if more advanced options, such as displaying multiple features, are required.

*A point marker will be displayed if local coordinates are supplied or if the page's Wikidata item does have an {{Q|P402}} or a {{Q|P3896}}.
*Shapes/lines will be displayed if local coordinates are not supplied or if the Wikidata item has either an {{Q|P402}} or a {{Q|P3896}}.
*No map will be shown if local coordinates are not supplied and if the Wikidata item does not have a {{Q|P625}}.

*See [[:Category:Infobox mapframe without OSM relation ID on Wikidata]] for pages which have items without an OSM Relation or a Geoshape.
*Troubleshooting shapes guidance is found at [[Module talk:mapframe/FAQ]]

== Usage ==
'''Note:''' When in mainspace, parameter {{para|id}} is not required (except to use a different page's data)

===Basic===
<syntaxhighlight lang="wikitext">{{Infobox mapframe}}</syntaxhighlight>
When used without parameters, or with only {{para|id}}, the map will display shape/line features, if they are available at OpenStreet Map.
*If the Wikidata item does not specify an {{Q|P402}}, a point marker will be additionally shown.
{{cot|Basic usage examples}}
Point feature (Wikidata coordinates):
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q7270550}}</syntaxhighlight>
{{Infobox mapframe |id=Q7270550}}
Line feature:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q1318331}}</syntaxhighlight>
{{Infobox mapframe |id=Q1318331}}
Shape feature:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q61}}</syntaxhighlight>
{{Infobox mapframe |id=Q61}}
{{cob}}

===Using specified coordinates instead of Wikidata===
Point feature only, no shapes or lines:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |coord=}}</syntaxhighlight>
Point feature and shape/line feature if available:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |wikidata=yes |coord=}}</syntaxhighlight>

Specify coordinates using the {{tlx|Coord}} templates, e.g. {{para|coord|2={{tlx|Coord|32.1|S|116.2|E}}}}
*If {{para|coord}} is specified, then a point marker will always been shown and shape/line features will be shown only if the Wikidata item has an {{Q|P402}} or a {{Q|P3896}}.
*If {{para|coord}} is specified and {{para|wikidata|yes}} is used, then the point marker and any shape/line features will always be shown (if available on OpenStreetMap).
{{cot|Specified coordinates examples}}
Point feature (with coordinates specified, no shape/line feature from Wikidata item):
<syntaxhighlight lang="wikitext">{{infobox mapframe |coord={{coord|31|56|S|115|58|E}} }}</syntaxhighlight>
{{infobox mapframe |id=Q45935 |coord={{coord|31|56|S|115|58|E}} }}
Point feature (with coordinates specified, along with shape/line feature from Wikidata item):
<syntaxhighlight lang="wikitext">{{infobox mapframe |wikidata=yes |coord={{coord|31|56|S|115|58|E}} }}</syntaxhighlight>
{{infobox mapframe |id=Q45935 |wikidata=yes |coord={{coord|31|56|S|115|58|E}} }}
{{cob}}

===Customizing which features are displayed===
====Inverse shape====
<syntaxhighlight lang="wikitext">{{Infobox mapframe |shape=inverse}}</syntaxhighlight>
Replace the shape with an inverse-shape (geomask) by setting {{para|shape|inverse}}
{{cot|Inverse shape example}}
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q61 |shape=inverse}}</syntaxhighlight>
{{Infobox mapframe |id=Q61}}
{{cob}}
{{Infobox mapframe |id=Q61}}

====Turn point marker on or off====
Force point marker to be displayed:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |point=on}}</syntaxhighlight>
Prevent point marker from being displayed:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |point=none}}</syntaxhighlight>

====Turn shape feature off====
Prevent shape feature from being displayed:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |shape=none}}</syntaxhighlight>

====Turn line feature off====
Prevent line feature from being displayed:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |line=none}}</syntaxhighlight>

===Show a geomask from a related Wikidata item===
<syntaxhighlight lang="wikitext">{{Infobox mapframe |geomask=}}</syntaxhighlight>
Set {{para|geomask}} to a Wikidata item id (Q-number), or property id (P-number) such as {{Q|P17}}
{{cot|Geomask examples}}
Use the item linked from the {{q|P17}} statement as a geomask:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q3239281 |geomask=P17}}</syntaxhighlight>
{{Infobox mapframe |id=Q3239281 |geomask=P17}}
Use the item {{q|Q1199}} as a geomask:
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q3239281 |geomask=Q1199}}</syntaxhighlight>
{{Infobox mapframe |id=Q3239281 |geomask=Q1199}}
{{cob}}

===Setting the zoom level===
The zoom level of the map can always be set by an editor via {{para|zoom}}. If not explicitly set, the zoom is determined automatically:
* If the Wikidata item has an {{Q|P402}} or {{Q|P3896}}, then the center and zoom of the image is set to nicely frame the shape/line.
* If the Wikidata item has an {{Q|P6592}}, it will be used as the zoom level
* Any of the following parameters will specify a zoom level:
**{{para|length_km}}
**{{para|length_mi}}
**{{para|width_km}}
**{{para|width_mi}}
**{{para|area_km2}}
**{{para|area_mi2}}
**{{para|area_ha}}
**{{para|area_acre}}
*The zoom will be set by specifying the {{para|type}} of the object, with the same usage as {{tl|coord}}. For example, {{para|type|city}}. In the case of a city, the population can determine the zoom by specifying {{para|population}}.

{{cot|Zoom examples}}
Set zoom manually
<syntaxhighlight lang="wikitext">{{Infobox mapframe|coord={{coord|37|45|N|119|32|W}}|zoom=8}}</syntaxhighlight>
{{Infobox mapframe|coord={{coord|37|45|N|119|32|W}}|zoom=8}}

Determine zoom from object length in kilometres or miles
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q1318331 |length_km=5.6}}</syntaxhighlight>
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q1318331 |length_mi=3.5}}</syntaxhighlight>
{{Infobox mapframe |id=Q1318331 |length_km=5.6}}

Determine zoom from object area in square kilometres or square miles
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q100 |area_km2=232.14}}</syntaxhighlight>
<syntaxhighlight lang="wikitext">{{Infobox mapframe |id=Q100 |area_mi2=89.63}}</syntaxhighlight>
{{Infobox mapframe |id=Q100 |area_km2=232.14}}
{{cob}}

==Parameters==
All parameters are optional.

{{Infobox mapframe/doc/parameters|noprefix=yes|deprecated=yes}}

==Use within templates==

Please use [[Module:Infobox mapframe#Automatic maps in infoboxes]].

==FAQ==
{{Module talk:mapframe/FAQ}}

==Template Data==
{{TemplateData header}}
{{collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
<templatedata>
{
"params": {
"mapframe": {
"label": "Show mapframe map",
"description": "Specify yes or no to show or hide the map, overriding the default",
"example": "yes",
"type": "string",
"default": "no",
"suggested": true
},
"caption": {
"label": "Mapframe caption",
"description": "Caption for the map. If geomask is set, then the default is \"Location in <<geomask's label>>\"",
"type": "string"
},
"custom": {
"label": "Custom mapframe",
"description": "Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, other mapframe parameters will be ignored.",
"type": "wiki-template-name"
},
"id": {
"aliases": [
"id",
"qid"
],
"label": "Mapframe Wikidata item",
"description": "Id (Q-number) of Wikidata item to use.",
"type": "string",
"default": "(item for current page)"
},
"coordinates": {
"aliases": [
"coord",
"coordinates",
"coord"
],
"label": "Mapframe coordinates ",
"description": "Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template.",
"example": "{{Coord|12.34|N|56.78|E}}",
"type": "wiki-template-name",
"default": "(coordinates from Wikidata)"
},
"wikidata": {
"label": "Mapframe shapes from Wikidata",
"description": "et to yes to show shape/line features from the wikidata item, if any, when coordinates are specified by parameter",
"example": "yes",
"type": "string"
},
"shape": {
"label": "Mapframe shape feature",
"description": "Override display of mapframe shape feature. Turn off by setting to \"none\". Use an inverse shape (geomask) instead of a regular shape by setting to \"inverse\"",
"type": "string"
},
"point": {
"label": "Mapframe point feature",
"description": "Override display of mapframe point feature. Turn off display of point feature by setting to \"none\". Force point marker to be displayed by setting to \"on\"",
"type": "string"
},
"geomask": {
"label": "Mapframe geomask",
"description": "Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country, or P131 for located in the administrative territorial entity)",
"example": "Q100",
"type": "wiki-page-name"
},
"switcher": {
"label": "Mapframe switcher",
"description": "Set to \"auto\" or \"geomasks\" or \"zooms\" to enable Template:Switcher-style switching between multiple mapframes. IF SET TO auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country. IF SET TO geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the geomask parameter. IF SET TO zooms – switch between \"zoomed in\"/\"zoomed midway\"/\"zoomed out\", where \"zoomed in\" is the default zoom (with a minimum of 3), \"zoomed out\" is 1, and \"zoomed midway\" is the average.",
"type": "string"
},
"frame-width": {
"aliases": [
"width"
],
"label": "Mapframe width",
"description": "Frame width in pixels",
"type": "number",
"default": "270"
},
"frame-height": {
"aliases": [
"height"
],
"label": "Mapframe height",
"description": "Frame height in pixels",
"type": "number",
"default": "200"
},
"shape-fill": {
"label": "Mapframe shape fill",
"description": "Color used to fill shape features",
"type": "string",
"default": "#606060"
},
"shape-fill-opacity": {
"label": "Mapframe shape fill opacity",
"description": "Opacity level of shape fill, a number between 0 and 1",
"type": "number",
"default": "0.1"
},
"stroke-color": {
"aliases": [
"stroke-colour"
],
"label": "Mapframe stroke color",
"description": "Color of line features, and outlines of shape features",
"type": "string",
"default": "#ff0000"
},
"stroke-width": {
"label": "Mapframe stroke width",
"description": "Width of line features, and outlines of shape features",
"type": "number",
"default": "2"
},
"marker": {
"label": "Mapframe marker",
"description": "Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options",
"example": "museum",
"type": "string"
},
"marker-color": {
"aliases": [
"marker-colour"
],
"label": "Mapframe marker color",
"description": "Background color for the marker",
"type": "string",
"default": "#5E74F3"
},
"geomask-stroke-color": {
"aliases": [
"geomask-stroke-colour"
],
"label": "Mapframe geomask stroke color",
"description": "Color of outline of geomask shape",
"type": "string",
"default": "#555555"
},
"geomask-stroke-width": {
"label": "Mapframe geomask stroke width",
"description": "Width of outline of geomask shape",
"type": "number",
"default": "1"
},
"geomask-fill": {
"label": "Mapframe geomask fill",
"description": "Color used to fill outside geomask features",
"type": "string",
"default": "#606060"
},
"geomask-fill-opacity": {
"label": "Mapframe geomask fill opacity",
"description": "Opacity level of fill outside geomask features, a number between 0 and 1",
"type": "number",
"default": "0.25"
},
"zoom": {
"label": "Mapframe zoom",
"description": "Set the zoom level, from \"1\" to \"18\", to used if the zoom level cannot be determined automatically from object length or area. NB: default may also be set by Kartographer automatically based on the features rendered.",
"example": "12",
"type": "number",
"default": "10"
},
"length_km": {
"label": "Mapframe length (km)",
"description": "Object length in kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
"type": "number"
},
"length_mi": {
"label": "Mapframe length (mi)",
"description": "Object length in miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
"type": "number"
},
"area_km2": {
"label": "Mapframe area (km^2)",
"description": "Object arean square kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
"type": "number"
},
"area_mi2": {
"label": "Mapframe area (mi^2)",
"description": "Object area in square miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
"type": "number"
},
"frame-coordinates": {
"aliases": [
"frame-coord"
],
"label": "Mapframe frame coordinates",
"description": "Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}",
"example": "{{Coord|12.35|N|56.71|E}}",
"type": "wiki-template-name"
},
"line": {
"label": "Mapframe line feature",
"description": "Turn off display of line feature by setting to none. Force display of line by setting to on.",
"type": "string"
},
"type": {
"label": "Mapframe type",
"description": "Type of the object rendered in the mapframe, like with {{coord}}.",
"type": "string"
},
"line-stroke-color": {
"aliases": [
"line-stroke-colour"
],
"label": "Mapframe line stroke color",
"description": "Color of line features",
"type": "string",
"default": "#ff0000"
},
"line-stroke-width": {
"label": "Mapframe line stroke width",
"description": "Width of line features",
"type": "number",
"default": "5"
},
"shape-stroke-color": {
"aliases": [
"shape-stroke-colour"
],
"label": "Mapframe shape stroke color",
"description": "Color of outlines of shape features",
"type": "string",
"default": "#ff0000"
},
"shape-stroke-width": {
"label": "Mapframe shape stroke width",
"description": "Width of outlines of shape features",
"type": "number",
"default": "2"
}
},
"paramOrder": [
"mapframe",
"caption",
"custom",
"id",
"coordinates",
"wikidata",
"point",
"shape",
"frame-width",
"frame-height",
"shape-fill",
"shape-fill-opacity",
"stroke-color",
"stroke-width",
"line-stroke-color",
"line-stroke-width",
"shape-stroke-color",
"shape-stroke-width",
"marker",
"marker-color",
"geomask",
"geomask-stroke-color",
"geomask-stroke-width",
"geomask-fill",
"geomask-fill-opacity",
"zoom",
"length_km",
"length_mi",
"area_km2",
"area_mi2",
"frame-coordinates",
"switcher",
"line",
"type"
]

}
</templatedata>
{{collapse bottom}}

== Tracking category ==
*{{clc|Category:Pages using infobox mapframe with unknown parameters}}
*{{clc|Category:Pages using infobox mapframe with missing coordinates}}
*{{clc|Category:Pages using infobox mapframe with forced centering}}

== See also ==
* [[Wikipedia:Mapframe maps in infoboxes]], inclusion of this kind of functionality in infoboxes by default
* [[Wikipedia:Maps for Wikipedia]], a list of mapping tools available on Wikipedia

<includeonly>{{sandbox other||


}}</includeonly>

Template:Infobox mapframe/doc - Revision history

Lypomania: 1 revision imported

Wikipedia>Hooman Mallahzadeh: /* Customizing which features are displayed */