< User:Alistair3149 | sandbox
CircularMarkerGroup
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
fillColor | Fillcolor | nil | nil | nil | nil |
description | Description | Shown in the legend right under. | nil | nil | nil |
strokeWidth | Strokewidth | nil | number | 1 | nil |
isCollectible | Iscollectible | nil | nil | false | false,true,individual,group,globalGroup |
static | Is static? | If set to true, these circles will not change size when zooming in or out. | boolean | false | nil |
autoNumberInChecklist | Autonumberinchecklist | nil | boolean | false | nil |
canSearchFor | Cansearchfor | nil | boolean | true | nil |
strokeColor | Strokecolor | nil | nil | nil | nil |
extraMinZoomSize | Extraminzoomsize | nil | nil | nil | nil |
name | Name | nil | string | nil | nil |
isSwitchable | Can be switched? | If set to false, this group will not be shown in the legend. | boolean | true | nil |
isDefault | Isdefault | nil | boolean | true | nil |
size | Size | nil | number | 12.5 | nil |
icon | Icon | Shown in the legend. | nil | nil | nil |
article | Related article | If set, all markers in this group will link to this article. | nil | nil | nil |
NamedPoint
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
y | Y | nil | number | nil | nil |
x | X | nil | number | nil | nil |
ImageOverlay
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
at | At | nil | array | nil | nil |
image | Image | nil | string | nil | nil |
name | Name | nil | nil | nil | nil |
reduceGaps | Reducegaps | nil | boolean | false | nil |
pixelated | Pixelated | nil | boolean | false | nil |
LEGACY_CoordinateSystem
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
order | Order | nil | string | yx | yx,latlon,xy |
bottomRight | Bottomright | nil | nil | 100,100 | nil |
rotation | Rotation | nil | nil | nil | nil |
topLeft | Topleft | nil | nil | 0,0 | nil |
CoordinateSettings
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
order | Order | nil | string | yx | yx,latlon,xy |
rotation | Rotation | nil | nil | nil | nil |
origin | Origin | nil | string | topLeft | topLeft,bottomLeft |
PolylineOverlay
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
color | Color | nil | nil | nil | nil |
path | Path | nil | array | nil | nil |
name | Name | nil | nil | nil | nil |
thickness | Thickness | nil | nil | nil | nil |
TiledBackground
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
overlays | Overlays | nil | array | nil | |
name | Display name | This name will be shown to a viewer in the background selection dropdown. | nil | nil | nil |
tiles | Tiles | nil | array | nil | nil |
pixelated | Pixelated | nil | boolean | false | nil |
tileSize | Size of an individual tile | nil | nil | nil | nil |
associatedLayer | Associatedlayer | nil | nil | nil | nil |
at | Starting position of the tile set | nil | nil | 0,0 | nil |
ImageBackground
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
overlays | Overlays | nil | array | nil | |
image | Image to use | nil | string | nil | nil |
name | Display name | This name will be shown to a viewer in the background selection dropdown. | nil | nil | nil |
pixelated | Pixelated | nil | boolean | false | nil |
associatedLayer | Associatedlayer | nil | nil | nil | nil |
at | Bounds | Bounds to fit the image in. | nil | nil | nil |
MarkerCategory
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
subtleText | Subtletext | nil | nil | nil | nil |
name | Name | nil | nil | nil | nil |
overrideIcon | Overrideicon | nil | nil | nil | nil |
Tile
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
image | Image to use | nil | string | nil | nil |
position | Position | Position in this tile in the grid. 1 unit is one tile as big as the size specified. | nil | nil | nil |
XyMarker
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
description | Description | nil | nil | nil | nil |
searchKeywords | Searchkeywords | nil | nil | nil | |
id | Id | nil | nil | nil | nil |
canSearchFor | Cansearchfor | nil | boolean | true | nil |
y | Y | nil | number | nil | nil |
image | Image | nil | nil | nil | nil |
name | Name | nil | nil | nil | nil |
x | X | nil | number | nil | nil |
isWikitext | Iswikitext | nil | nil | nil | |
scale | Scale | nil | number | 1 | nil |
icon | Icon | nil | nil | nil | nil |
article | Article | nil | nil | nil | nil |
BoxOverlay
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
at | At | nil | array | nil | nil |
color | Color | nil | nil | nil | nil |
name | Name | nil | nil | nil | nil |
borderColor | Bordercolor | nil | nil | nil | nil |
ZoomSettings
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
min | Minimum level | nil | number | -16 | nil |
scrollSpeed | Scroll speed scaler | nil | number | 1 | nil |
tryFitEverything | Tryfiteverything | nil | boolean | true | nil |
max | Maximum level | nil | number | 6 | nil |
lock | Locked? | If set to `true`, zoom level will be fixed at the specified `min` value. All zoom controls on the viewer's side will be disabled. | boolean | false | nil |
Settings
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
backdropColor | Backdropcolor | The backdrop colour, i.e. the one filling areas with no background image over them. TODO: wording | nil | nil | nil |
zoom | Zoom configuration | nil | nil | nil | nil |
enableSearch | Enablesearch | Whether marker search will be enabled for this map. TODO: document modes | nil | true | false,true,tabberWide |
enableTooltipPopups | Enabletooltippopups | Whether simply moving mouse cursor over a marker should cause its popup to become visible.
Such popup will be partially translucent. The user still has to click on the marker for the address bar to update with a permanent link. | boolean | false | nil |
allowFullscreen | Allowfullscreen | Whether full-screen toggle will be shown to the user on this map. TODO: "whether the option to view the map in fullscreen will be offered" | boolean | true | nil |
interactionModel | Interactionmodel | Changes interaction delay model. Keybinds require extra keys to be held to zoom in (CTRL/Super), sleep is primarily time-based. | string | keybinds | keybinds,sleep |
requireCustomMarkerIDs | Requirecustommarkerids | Makes data validation disallow automatically generated marker IDs - the `id` property will need to be specified for each
marker manually. These identifiers are used for persistent links and collectible progress tracking. By default, group and layers the marker is attached to along with its location on map are used to generate the identifier. | boolean | false | nil |
hideLegend | Hidelegend | Forces the legend (collectible checklists and marker filters) to not be loaded on this map. If set to 'collapsed', the legend will be loaded, but will not be expanded on load. | nil | false | false,true,collapsed |
sortChecklistsBy | Checklist sort order | Specifies marker group checklist sort order.
- 'groupDeclaration': Follows the order in which marker groups are declared in source data. - 'amount': Follows the number of markers inside each group. | string | groupDeclaration | groupDeclaration,amount |
showCoordinates | Show coordinates? | Whether coordinates from under the mouse cursor will be shown on this map in the bottom-left corner. | boolean | true | nil |
iconRenderer | Iconrenderer | Renderer preference for graphical icons using images from this wiki (not circular icons or pins).
- DOM renderer provides best reactivity for a small data set (roughly 500 icons), but performance degrades with more markers. However, it comes with animation support for GIFs. - Canvas renderer provides best performance at a cost of zoom update latency, and supports only static icons. This works best for bigger data sets (above 500 icons), and is automatically enabled for such sets (if this option is set to 'auto').Pins always use the DOM renderer. | string | auto | auto,DOM,canvas |
leaflet | Custom Leaflet parameters | Check https://leafletjs.com/reference.html#map-option for reference. Some options are not supported. | object | false | nil |
PinMarkerGroup
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
description | Description | Shown in the legend right under. | nil | nil | nil |
strokeWidth | Strokewidth | nil | number | 1 | nil |
isCollectible | Iscollectible | nil | nil | false | false,true,individual,group,globalGroup |
static | Is static? | If set to true, these circles will not change size when zooming in or out. | boolean | false | nil |
autoNumberInChecklist | Autonumberinchecklist | nil | boolean | false | nil |
canSearchFor | Cansearchfor | nil | boolean | true | nil |
pinColor | Pincolor | nil | nil | nil | nil |
strokeColor | Strokecolor | nil | nil | nil | nil |
name | Name | nil | string | nil | nil |
isSwitchable | Can be switched? | If set to false, this group will not be shown in the legend. | boolean | true | nil |
isDefault | Isdefault | nil | boolean | true | nil |
size | Size | nil | number | 32 | nil |
icon | Icon | Shown in the legend. | nil | nil | nil |
article | Related article | If set, all markers in this group will link to this article. | nil | nil | nil |
LatLonMarker
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
lon | Lon | nil | number | nil | nil |
description | Description | nil | nil | nil | nil |
searchKeywords | Searchkeywords | nil | nil | nil | |
id | Id | nil | nil | nil | nil |
lat | Lat | nil | number | nil | nil |
canSearchFor | Cansearchfor | nil | boolean | true | nil |
image | Image | nil | nil | nil | nil |
name | Name | nil | nil | nil | nil |
isWikitext | Iswikitext | nil | nil | nil | |
scale | Scale | nil | number | 1 | nil |
icon | Icon | nil | nil | nil | nil |
article | Article | nil | nil | nil | nil |
IconMarkerGroup
| Key | Name | Description | Type | Default | Enums |
|---|---|---|---|---|---|
description | Description | Shown in the legend right under. | nil | nil | nil |
isCollectible | Iscollectible | nil | nil | false | false,true,individual,group,globalGroup |
static | Is static? | If set to true, these circles will not change size when zooming in or out. | boolean | false | nil |
autoNumberInChecklist | Autonumberinchecklist | nil | boolean | false | nil |
canSearchFor | Cansearchfor | nil | boolean | true | nil |
name | Name | nil | string | nil | nil |
isSwitchable | Can be switched? | If set to false, this group will not be shown in the legend. | boolean | true | nil |
isDefault | Isdefault | nil | boolean | true | nil |
size | Size | nil | nil | 32 | nil |
icon | Icon | nil | string | nil | nil |
article | Related article | If set, all markers in this group will link to this article. | nil | nil | nil |