Help:Interactive Maps

Interactive Maps is a feature available on Fandom that enables communities to design their own customized maps. It is available to any community that wishes to use it.

Getting Started
Map creation and editing is currently limited to those with the user right, which is automatically given to administrators and Fandom Staff. There is an "Interactive map tester" usergroup that administrators and above can give to users to enable them to create and edit Maps.

Once you have the permission to edit Maps, you can find a link to create an Interactive Map in the Explore menu of the top navigation, or you can directly navigate to the creation tool by visiting Special:AllMaps on your wiki, which will also display a list of every Map that exists on your community.

All Interactive Maps have to be created in the  content namespace, e.g.  . Maps created in any other namespace, including as a userspace subpage, will not be correctly generated.

Unless you have set your preferences to use the source editor, the "Edit" button at the top right of any page in the Map namespace will open the visual Interactive Maps Editor, which is a user-friendly option to edit Maps quickly and easily. Clicking "Edit source" from the dropdown menu will instead take you to the source editor and load the base JSON structure for the Map. If you have the source editor selected as your preference, these options will be reversed.

Map Display
This section allows you to view your Map name, upload a Map image as your background, and group markers that are in close proximity.


 * Map Name: This is the title of your Map. Your Map will be viewable using the URL.
 * Map Image: Click on this area to upload the image you would like to use for your Map. You can upload a .jpg, .jpeg, .png, or .svg. The maximum file size is 10 MB.
 * Group Markers: Toggle this option "on" to simplify the number of markers on a Map by grouping ones that are in close proximity. If you click on a grouped location, it will zoom in and show a sub-group or individual markers in a selected location. We recommend grouping large numbers of markers for a better viewing experience.

Categories
Organize markers of a similar kind by grouping them into categories. This list will appear next to the Map and allows you to filter markers by categories. Click the "Add Category" button to create a new one, click on the color to the left of the category to change the color of the category, and use the icons to the right of the category to either delete or re-order the categories in the list.

Markers
To add a marker to your Map, click the pin icon in the top right-hand corner. Move your cursor to the desired placement on the Map and click to drop it. After you place the marker, a menu will come up with several options that control how your marker will appear on the Map:
 * Title: This is the name of your marker/location. It must be 50 characters or less.
 * Description: This description will be displayed under your title in the pop-up window when your marker is clicked on. It must be 150 characters or less.
 * Link (optional): You have the option to link to any article on your wiki (perhaps one that gives more detail on the selected marker/location).
 * Page title: Put the name of the article you would like to link in this field. It does not matter whether you use spaces or underscores for article names.
 * Link display text: Choose how you would like the link text to be displayed. It could be the same name as the article or something like "See more". This field is required if you link a page title.
 * Category: Select which category you would like your marker to be grouped in. Each marker must be associated with a category to better group similar markers.

Once a marker is created, you can drag it to a different location on the Map if you so choose. You can also click on the marker to bring up options to edit or delete the marker.

Additional Functions

 * Zooming: Use the + and - buttons in the bottom right corner to zoom in and out of your Map.
 * Protection: Click the three dots in the upper right corner to select options for protecting your Map or switching to source editor.

As you are making edits, the preview window will display your changes in real time, so you can see how your Map will look before you save it. When you are finished, click the "Save" button and your new Map will now appear on the wiki!

Using JSON in Source Editor
Every Interactive Map is defined in JSON (JavaScript Object Notation). The following fields should be defined in order to generate the Map:
 * (required) – name of the file that will be used as the map background image. The image must be uploaded to the wiki (e.g. using ). The following file extensions are supported:   /   /   /
 * (required) – bounds defining the edges of the map, given as a  matrix of integers
 * (required) – list of categories that will be displayed in the filters list (the dropdown menu found top-left of the map)
 * (required) – list of markers that will be displayed on the map. Each marker must be associated with a defined category
 * – location of the origin point [0,0] in the coordinate system
 * Possible values:  (default) or
 * – order of coordinates used in defining map bounds and marker positions
 * Possible values:  (default) or

Categories
Categories are a group of markers of the same kind. Each marker category is defined through the following fields:
 * (required) – uniquely defined ID for each category, matched with the  property of each marker. Any string is valid as an "id".
 * (required) – name of the category, which will be displayed in the filters list
 * (required) – color each marker category will appear with. Both hex colors and named colors are valid. Categories with an invalid color field will display as black.

Markers
Each individual marker is defined through the following fields:
 * (required) – category associated to the marker
 * (required) – coordinate position of the marker, within the given  and in the order defined by
 * (required) – properties of the pop-up box that appears when a marker is clicked on:
 * (required) – title of the marker. Each marker title has a strict 50 character limit
 * (required) – description to be displayed in the pop-up. Each marker description has a strict 150 character limit
 * – article link to be added to the pop-up. Marker links are optional, but if included must be defined with both a  (the article title to be linked to) and a   (the link text to be displayed). The URL can link to both full articles and article sections.

Example
{ "origin": "bottom-left", "coordinateOrder": "xy", "mapImage": "File:MapBackground.jpg", "mapBounds": 0, 0], [1000, 1000, "categories": [ { "id": "1", "name": "Artifacts", "color": "#ff00ff" }, { "id": "2", "name": "Dungeons", "color": "#00ff00" } ], "markers": [ {     "categoryId": "1", "position": [500, 300], "popup": { "title": "A Sword", "description": "Very important artifact", "link": { "url": "Article_about_a_sword", "label": "See more" }     }     },    {      "categoryId": "2", "position": [300, 500], "popup": { "title": "A Cave", "description": "Very scary dungeon", "link": { "url": "Article_about_a_cave", "label": "See more" }     }     }  ] }

Marker clusters
For ease of display, markers are grouped locally into clusters. Hovering over a cluster will show an outline of the area of the markers contained within that cluster, with the number indicating the quantity. Clicking on a cluster will zoom into that area.

There is currently no way to adjust the sensitivity of the clustering, or to disable the feature altogether.

Embedding a Map
To get more eyes on your Map, you can embed it into a mainspace article if you wish. Once the Map has been created, it can be transcluded into an article using  wikitext syntax. More than one Map can be embedded in an article. Maps embedded in articles will have an edit button at the top right of the Map. Clicking this will open the map editor in a new tab, allowing it to be edited directly.

Useful links

 * First announcement of Interactive Maps
 * 2022 update for Interactive Maps

Map examples

 * Map of the World of Avatar