Editing Template:Map/doc

{{documentation}}
Used to generate regular, square, or pin maps or links. Default is a regular mapframe. For a list of available parameters see [[#Parameters|below]].

To find coordinates of a specific map square, tools such as https://mejrs.github.io/osrs can be used.

==Usage==
===Single===
The caption is optional, for all other available parameters see [[#Parameters|below]].
{| class="center"
! Simple Map !! Pin Map
|-
| <code><nowiki>{{Map|2613,3294|caption=Map Caption}}</nowiki></code>
| <code><nowiki>{{Map|x=2613|y=3294|mtype=pin|group=pinex}}</nowiki></code>
|-
| {{Map|2613,3294|caption=Map Caption}}
| {{Map|x=2613|y=3294|mtype=pin|group=pinex}}
|}

===Shapes===
Squares and rectangles can be drawn using the <code>mtype</code> parameter. Note that the point provided defines the centre of the shape. For squares, <code>r</code> defines half of the length of the square's edges, i.e. the shortest distance from its centre to one of its edges.
{| class="center"
! Square !! Rectangle
|-
| <code><nowiki>{{Map|3028,3306|r=3|mtype=square}}</nowiki></code>
| <code><nowiki>{{Map|3028,3306|squareX=3|squareY=8|mtype=rectangle}}</nowiki></code>
|-
| {{Map|3028,3306|r=3|mtype=square}}
| {{Map|3028,3306|squareX=3|squareY=8|mtype=rectangle}}
|}

===Multiple===
Multiple points can be combined on one map, or used to create lines and shapes. Individual points can have their own specific parameters, for all available parameters see [[#Parameters|below]]. Points should be represented as unnamed arguments in the format <code>|x,y|</code> or <code>|param:value,param2:value...|</code>.

{|
! Pins
| <code><nowiki>{{Map|2900,3000|x:2930,y:3020,desc:This is a description,title:Pin title |x:2870,y:3080,iconWikiLink:You_are_here.gif,title:Image|mtype=pin|icon=redPin}}</nowiki></code>
| {{Map|2900,3000|x:2930,y:3020,desc:This is a description,title:Pin title |x:2870,y:3080,iconWikiLink:You_are_here.gif,title:Image|mtype=pin|icon=redPin}}
|-
! Line
| <code><nowiki>{{Map|2900,3000|x:2930,y:3020|3000,3020|mtype=line}}</nowiki></code>
| {{Map|2900,3000|x:2930,y:3020|3000,3020|mtype=line}}
|-
! Polygon
| <code><nowiki>{{Map|2500,3100|2500,3130|2520,3140|2540,3115|2520,3090|mtype=polygon}}</nowiki></code>
| {{Map|2500,3100|2500,3130|2520,3140|2540,3115|2520,3090|mtype=polygon}}
|-
! Polygon and pins
| <code><nowiki>{{Map|2500,3100|x:2500,y:3130,desc:This is a description,title:Pin title |2520,3140|2540,3115|2520,3090|mtype=pin-polygon|icon=greenPin|group=example}}</nowiki></code>
| {{Map|2500,3100|x:2500,y:3130,desc:This is a description,title:Pin title |2520,3140|2540,3115|2520,3090|mtype=pin-polygon|icon=greenPin|group=example}}
|}

===Maplinks===
Any map can be rendered as a maplink instead of a mapframe by using <code>|type=maplink</code>. The <code>|text=</code> parameter can be used to change the text of the link.

====Examples====
<code><nowiki>{{Map|2613,3294|type=maplink}}</nowiki></code>

{{Map|2613,3294|type=maplink}}


<code><nowiki>{{Map|2613,3294|type=maplink|text=Maplink Text}}</nowiki></code>

{{Map|2613,3294|type=maplink|text=Maplink Text}}


<code><nowiki>{{Map|2613,3294|type=maplink|text=}}</nowiki></code>

{{Map|2613,3294|type=maplink|text=}}


<code><nowiki>{{Map|x=2613|y=3294|type=maplink|mtype=pin|group=pinex}}</nowiki></code> 

{{Map|x=2613|y=3294|type=maplink|mtype=pin|group=pinex}}


<code><nowiki>{{Map|2500,3100|x:2500,y:3130,desc:This is a description,title:Pin title|2520,3140|2540,3115|2520,3090|type=maplink|mtype=pin-polygon|icon=greenPin|group=example}}</nowiki></code>

{{Map|2500,3100|x:2500,y:3130,desc:This is a description,title:Pin title|2520,3140|2540,3115|2520,3090|type=maplink|mtype=pin-polygon|icon=greenPin|group=example}}

==Parameters==
If pin type map is chosen and only x/y parameters are given (<code><nowiki>{{Map|x=2520|y=3140|mtype=pin}}</nowiki></code>) these x/y are also used as the pin location. 

===Template===
* <code>type</code> - Render as link to map, instead of map: <code>|type=maplink</code>
* <code>mapID</code> - Map id (see [[RuneScape:Map/mapIDs]] for a list) defaults to 0 (surface)
* <code>plane</code> - The map plane (0 is surface)
* <code>mtype</code> - Type of map, one of: <code>pin, square, rectangle, polygon, line, pin-polygon, pin-line, circle</code>
* <code>r</code> - Radius of the marked area (in tiles) with <code>|mtype=square</code> or <code>|mtype=circle</code>
* <code>squareX</code> - Width of the marked area with (in tiles) with <code>|mtype=rectangle</code>
* <code>squareY</code> - Height of the marked area with (in tiles) with <code>|mtype=rectangle</code>
* <code>ptype</code> - Type of pin description format, one of: <code>item, object, npc, monster</code> (defaults to XY coordinate description if no ''desc'' is provided)
* <code>caption</code> - A caption for the map (has no effect with <code>|type=maplink</code>)
* <code>text</code> - The text to show as a link instead of ''Maplink'' (used with <code>|type=maplink</code>)
* <code>align</code> - The alignment, defaults to center
* <code>width</code> - Width of the map (in px)
* <code>height</code> - height of the map (in px)
* <code>zoom</code> - override default zoom
* <code>x</code> - X-coordinate for the center of the map
* <code>y</code> - Y-coordinate for the center of the map
* <code>group</code> - Group (all pins, shapes etc in the same group, on the same page, will appear on each others maps)
* <code>showPins</code> - Displays a link to a new map of pinned objects below a mapframe. '''Only use with Infobox Map param!''' This sets mtype to square by default. (Pass in a desc param to make the pins have adequate descriptions)
* If ''mtype'' is square, polygon or combos:
** <code>title</code> - Title of the polygon (displays in popup on click)
** <code>description</code> - Description of the polygon (displays in popup on click)
* <code>nopreprocess</code> - Any value causes the template to output the html element and json instead of rendering the map/link
* <code>smw</code> - Set to <code>yes</code> to set the [[Property:Location JSON|Location JSON]] property. Set to <code>hist</code> to set the [[Property:Historic Location JSON|Historic Location JSON]] property. When not defined, no SMW properties are set.

===Per Point===
Will override the template params
* <code>plane</code> - The map plane (0 is surface)
* <code>desc</code> - Pin description (is appended to templates desc)
* <code>icon</code> - The type of icon (pin) to display. Default is a green pin, possible values are: <code> redPin, greenPin, bluePin, cyanPin, magentaPin, yellowPin, greyPin</code>
* <code>iconWikiLink</code> - Use an image on the wiki as a pin. Spaces should be replaced with <code>_</code>
::For the following params if the param name is used, 1 number is expected and used for x and y, to specify individually use <code>paramNameX</code> and <code>paramNameY</code> eg <code>...,iconSizeX:20,...</code>
:* <code>iconSize</code> - Size of the image used as a pin (resizes image)
:* <code>iconAnchor</code> - Location of the map point relative to the image, default is top left (top left of image is specified point on map), positive numbers run down and to the right
:* <code>popupAnchor</code> - Location of the popup relative to the image, default is iconAnchor (top left unless specified), [0,0] is the iconAnchor, positive numbers run down and to the right