View source for Module:CarouselMap/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
This module inserts an interactive map that cycles daily among locations specified in a configuration module.

== Configuration ==
Each of the functions below relies on a subpage of [[Module:CarouselMap]] to determine the map's contents on a given day. Each subpage is a Lua module that returns a table of ''places'' specifying the map's parameters. When embedding a carousel in a new article, create a corresponding configuration module based on an existing module (as well as a /doc page containing any relevant documentation):

{{Special:PrefixIndex/Module:CarouselMap/config/|stripprefix=1}}

== <code>slippymap</code> ==
Inserts an interactive [[Leaflet]] map based on the given configuration module. Appropriate for raster tile layers.

Parameters:

; {{para|1}} : The configuration module's subpage name. Defaults to the current page's subpage name.
; {{para|height}} : The map's height in pixels.
; {{para|width}} : The map's width in pixels, or {{para|width|full}} to fill the available space.

== <code>vectormap</code> ==
Inserts an interactive [[MapLibre]] GL map based on the given configuration module. Similar to [[#slippymap|<code>slippymap</code>]], but with support for rendering vector tiles on the client side. Displays an interactive comparison between two maps if either {{para|layer2}} or {{para|date2}} is specified.

Parameters:

; {{para|1}} : The configuration module's subpage name. Defaults to the current page's subpage name.
; {{para|height}} : The map's height in pixels.
; {{para|width}} : The map's width in pixels, or {{para|width|full}} to fill the available space.
; {{para|layer2}} : The layer ID on the right-hand side of the map comparison, overriding the <code>layer</code> field in the configuration.
; {{para|date2}} : The ISO&nbsp;8601-1 date to filter the right-hand side of the map comparison, overriding the <code>date</code> field in the configuration.

== <code>description</code> ==
Inserts the <code>description</code> field of the configuration.

Parameters:

; {{para|1}} : The configuration module's subpage name. Defaults to the current page's subpage name.

== <code>externalURL</code> ==
Inserts a URL to the full version of the embedded map.

Parameters:

; {{para|1}} : The configuration module's subpage name. Defaults to the current page's subpage name.
; {{para|site}} : The ID of the website to link to.

== See also ==
* [[Module:Slippymap]]

<includeonly>
<!-- CATEGORIES HERE, THANKS -->
[[Category:Modules for maps]]
</includeonly>