Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Please sign up or log in to edit the wiki.

Module:DataMaps schema table/v17.1.json

From Tolkien Gateway
$defs
BoxOverlay
additionalPropertiesfalse
properties
name
anyOf
type"string"
type"null"
defaultnull
title"Name"
at
maxItems2
minItems2
prefixItems
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
title"At"
type"array"
color
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
title"Color"
borderColor
anyOf
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
title"Bordercolor"
required
"at"
title"BoxOverlay"
type"object"
CircularMarkerGroup
additionalPropertiesfalse
properties
name
minLength1
title"Name"
type"string"
description
anyOf
minLength1
type"string"
type"null"
defaultnull
description" Shown in the legend right under. "
title"Description"
icon
anyOf
type"string"
type"null"
defaultnull
description" Shown in the legend. "
title"Icon"
article
anyOf
type"string"
type"null"
defaultnull
description" If set, all markers in this group will link to this article. "
title"Related article"
isDefault
defaulttrue
title"Isdefault"
type"boolean"
isCollectible
defaultfalse
enum
false
true
"individual"
"group"
"globalGroup"
title"Iscollectible"
isSwitchable
defaulttrue
description" If set to false, this group will not be shown in the legend. "
title"Can be switched?"
type"boolean"
autoNumberInChecklist
defaultfalse
title"Autonumberinchecklist"
type"boolean"
canSearchFor
defaulttrue
title"Cansearchfor"
type"boolean"
fillColor
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
title"Fillcolor"
size
default12.5
title"Size"
type"number"
extraMinZoomSize
anyOf
type"number"
type"null"
defaultnull
title"Extraminzoomsize"
strokeColor
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
title"Strokecolor"
strokeWidth
default1
title"Strokewidth"
type"number"
required
"name"
"fillColor"
title"CircularMarkerGroup"
type"object"
CoordinateSystem
additionalPropertiesfalse
properties
order
default"yx"
enum
"yx"
"latlon"
"xy"
title"Order"
type"string"
topLeft
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
default
0
0
title"Topleft"
bottomRight
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
default
100
100
title"Bottomright"
rotation
anyOf
type"number"
type"null"
defaultnull
title"Rotation"
title"CoordinateSystem"
type"object"
IconMarkerGroup
additionalPropertiesfalse
properties
name
minLength1
title"Name"
type"string"
description
anyOf
minLength1
type"string"
type"null"
defaultnull
description" Shown in the legend right under. "
title"Description"
icon
title"Icon"
type"string"
article
anyOf
type"string"
type"null"
defaultnull
description" If set, all markers in this group will link to this article. "
title"Related article"
isDefault
defaulttrue
title"Isdefault"
type"boolean"
isCollectible
defaultfalse
enum
false
true
"individual"
"group"
"globalGroup"
title"Iscollectible"
isSwitchable
defaulttrue
description" If set to false, this group will not be shown in the legend. "
title"Can be switched?"
type"boolean"
autoNumberInChecklist
defaultfalse
title"Autonumberinchecklist"
type"boolean"
canSearchFor
defaulttrue
title"Cansearchfor"
type"boolean"
size
anyOf
type"number"
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
default32
title"Size"
required
"name"
"icon"
title"IconMarkerGroup"
type"object"
ImageBackground
additionalPropertiesfalse
properties
name
anyOf
type"string"
type"null"
defaultnull
description" This name will be shown to a viewer in the background selection dropdown. "
title"Display name"
associatedLayer
anyOf
minLength1
pattern"^[\w\d\-\._]+$"
type"string"
type"null"
defaultnull
title"Associatedlayer"
pixelated
defaultfalse
title"Pixelated"
type"boolean"
overlays
default
Empty array
items
anyOf
$ref"#/$defs/ImageOverlay"
$ref"#/$defs/PolylineOverlay"
$ref"#/$defs/BoxOverlay"
title"Overlays"
type"array"
image
title"Image to use"
type"string"
at
anyOf
maxItems2
minItems2
prefixItems
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
type"array"
type"null"
defaultnull
description" Bounds to fit the image in. "
title"Bounds"
required
"image"
title"ImageBackground"
type"object"
ImageOverlay
additionalPropertiesfalse
properties
name
anyOf
type"string"
type"null"
defaultnull
title"Name"
image
title"Image"
type"string"
at
maxItems2
minItems2
prefixItems
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
title"At"
type"array"
pixelated
defaultfalse
title"Pixelated"
type"boolean"
reduceGaps
defaultfalse
title"Reducegaps"
type"boolean"
required
"image"
"at"
title"ImageOverlay"
type"object"
LatLonMarker
additionalPropertiesfalse
properties
id
anyOf
minLength1
type"string"
type"integer"
type"null"
defaultnull
title"Id"
icon
anyOf
type"string"
type"null"
defaultnull
title"Icon"
scale
default1
title"Scale"
type"number"
name
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Name"
description
anyOf
items
type"string"
type"array"
minLength1
type"string"
type"null"
defaultnull
title"Description"
isWikitext
defaultnull
enum
null
false
true
title"Iswikitext"
image
anyOf
type"string"
type"null"
defaultnull
title"Image"
article
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Article"
canSearchFor
defaulttrue
title"Cansearchfor"
type"boolean"
searchKeywords
anyOf
items
maxItems2
minItems2
prefixItems
minLength1
type"string"
type"number"
type"array"
type"array"
minLength1
type"string"
default
Empty array
title"Searchkeywords"
lat
title"Lat"
type"number"
lon
title"Lon"
type"number"
required
"lat"
"lon"
title"LatLonMarker"
type"object"
MarkerCategory
additionalPropertiesfalse
properties
name
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Name"
subtleText
anyOf
type"string"
type"null"
defaultnull
title"Subtletext"
overrideIcon
anyOf
type"string"
type"null"
defaultnull
title"Overrideicon"
title"MarkerCategory"
type"object"
NamedPoint
additionalPropertiesfalse
properties
x
title"X"
type"number"
y
title"Y"
type"number"
required
"x"
"y"
title"NamedPoint"
type"object"
PinMarkerGroup
additionalPropertiesfalse
properties
name
minLength1
title"Name"
type"string"
description
anyOf
minLength1
type"string"
type"null"
defaultnull
description" Shown in the legend right under. "
title"Description"
icon
anyOf
type"string"
type"null"
defaultnull
description" Shown in the legend. "
title"Icon"
article
anyOf
type"string"
type"null"
defaultnull
description" If set, all markers in this group will link to this article. "
title"Related article"
isDefault
defaulttrue
title"Isdefault"
type"boolean"
isCollectible
defaultfalse
enum
false
true
"individual"
"group"
"globalGroup"
title"Iscollectible"
isSwitchable
defaulttrue
description" If set to false, this group will not be shown in the legend. "
title"Can be switched?"
type"boolean"
autoNumberInChecklist
defaultfalse
title"Autonumberinchecklist"
type"boolean"
canSearchFor
defaulttrue
title"Cansearchfor"
type"boolean"
pinColor
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
title"Pincolor"
size
default32
title"Size"
type"number"
strokeColor
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
title"Strokecolor"
strokeWidth
default1
title"Strokewidth"
type"number"
required
"name"
"pinColor"
title"PinMarkerGroup"
type"object"
PolylineOverlay
additionalPropertiesfalse
properties
name
anyOf
type"string"
type"null"
defaultnull
title"Name"
path
items
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
title"Path"
type"array"
color
anyOf
maxItems4
minItems4
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum1
minimum0
type"number"
type"array"
pattern"^#([a-fA-F0-9]{4}|[a-fA-F0-9]{8})$"
type"string"
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
title"Color"
thickness
anyOf
type"number"
type"null"
defaultnull
title"Thickness"
required
"path"
title"PolylineOverlay"
type"object"
Settings
additionalPropertiesfalse
properties
allowFullscreen
defaulttrue
description" 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" "
title"Allowfullscreen"
type"boolean"
backdropColor
anyOf
maxItems3
minItems3
prefixItems
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
maximum255
minimum0
type"integer"
type"array"
pattern"^#([a-fA-F0-9]{3}|[a-fA-F0-9]{6})$"
type"string"
type"null"
defaultnull
description" The backdrop colour, i.e. the one filling areas with no background image over them. TODO: wording "
title"Backdropcolor"
enableTooltipPopups
defaultfalse
description" 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. "
title"Enabletooltippopups"
type"boolean"
enableSearch
defaulttrue
description" Whether marker search will be enabled for this map. TODO: document modes "
enum
false
true
"tabberWide"
title"Enablesearch"
hideLegend
defaultfalse
description" 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. "
enum
false
true
"collapsed"
title"Hidelegend"
interactionModel
default"keybinds"
description" Changes interaction delay model. Keybinds require extra keys to be held to zoom in (CTRL/Super), sleep is primarily time-based. "
enum
"keybinds"
"sleep"
title"Interactionmodel"
type"string"
iconRenderer
default"auto"
description" 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. "
enum
"auto"
"DOM"
"canvas"
title"Iconrenderer"
type"string"
requireCustomMarkerIDs
defaultfalse
description" 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. "
title"Requirecustommarkerids"
type"boolean"
showCoordinates
defaulttrue
description" Whether coordinates from under the mouse cursor will be shown on this map in the bottom-left corner. "
title"Show coordinates?"
type"boolean"
sortChecklistsBy
default"groupDeclaration"
description" 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. "
enum
"groupDeclaration"
"amount"
title"Checklist sort order"
type"string"
zoom
anyOf
$ref"#/$defs/ZoomSettings"
type"null"
defaultnull
title"Zoom configuration"
leaflet
defaultfalse
description" Check https://leafletjs.com/reference.html#map-option for reference. Some options are not supported. "
title"Custom Leaflet parameters"
type"object"
title"Settings"
type"object"
Tile
additionalPropertiesfalse
properties
position
anyOf
type"number"
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
description" Position in this tile in the grid. 1 unit is one tile as big as the size specified. "
title"Position"
image
title"Image to use"
type"string"
required
"position"
"image"
title"Tile"
type"object"
TiledBackground
additionalPropertiesfalse
properties
name
anyOf
type"string"
type"null"
defaultnull
description" This name will be shown to a viewer in the background selection dropdown. "
title"Display name"
associatedLayer
anyOf
minLength1
pattern"^[\w\d\-\._]+$"
type"string"
type"null"
defaultnull
title"Associatedlayer"
pixelated
defaultfalse
title"Pixelated"
type"boolean"
overlays
default
Empty array
items
anyOf
$ref"#/$defs/ImageOverlay"
$ref"#/$defs/PolylineOverlay"
$ref"#/$defs/BoxOverlay"
title"Overlays"
type"array"
at
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
default
0
0
title"Starting position of the tile set"
tileSize
anyOf
type"number"
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
title"Size of an individual tile"
tiles
items
$ref"#/$defs/Tile"
title"Tiles"
type"array"
required
"tileSize"
"tiles"
title"TiledBackground"
type"object"
XyMarker
additionalPropertiesfalse
properties
id
anyOf
minLength1
type"string"
type"integer"
type"null"
defaultnull
title"Id"
icon
anyOf
type"string"
type"null"
defaultnull
title"Icon"
scale
default1
title"Scale"
type"number"
name
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Name"
description
anyOf
items
type"string"
type"array"
minLength1
type"string"
type"null"
defaultnull
title"Description"
isWikitext
defaultnull
enum
null
false
true
title"Iswikitext"
image
anyOf
type"string"
type"null"
defaultnull
title"Image"
article
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Article"
canSearchFor
defaulttrue
title"Cansearchfor"
type"boolean"
searchKeywords
anyOf
items
maxItems2
minItems2
prefixItems
minLength1
type"string"
type"number"
type"array"
type"array"
minLength1
type"string"
default
Empty array
title"Searchkeywords"
x
title"X"
type"number"
y
title"Y"
type"number"
required
"x"
"y"
title"XyMarker"
type"object"
ZoomSettings
additionalPropertiesfalse
properties
tryFitEverything
defaulttrue
title"Tryfiteverything"
type"boolean"
min
default0.05
exclusiveMaximum24
exclusiveMinimum-15
title"Minimum level"
type"number"
max
default6
exclusiveMaximum24
exclusiveMinimum-15
title"Maximum level"
type"number"
lock
defaultfalse
description" 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. "
title"Locked?"
type"boolean"
scrollSpeed
default1
exclusiveMaximum5
exclusiveMinimum0
title"Scroll speed scaler"
type"number"
title"ZoomSettings"
type"object"
additionalPropertiesfalse
oneOf
required
"background"
required
"backgrounds"
properties
$fragment
defaultfalse
title"$Fragment"
type"boolean"
include
anyOf
items
type"string"
type"array"
type"null"
defaultnull
description"List of fragments that must be imported."
title"Include"
crs
anyOf
$ref"#/$defs/CoordinateSystem"
maxItems2
minItems2
prefixItems
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
anyOf
maxItems2
minItems2
prefixItems
type"number"
type"number"
type"array"
$ref"#/$defs/NamedPoint"
type"array"
default
0
0
100
100
title"Crs"
settings
anyOf
$ref"#/$defs/Settings"
type"null"
defaultnull
background
anyOf
type"string"
$ref"#/$defs/ImageBackground"
$ref"#/$defs/TiledBackground"
title"Background"
backgrounds
items
anyOf
$ref"#/$defs/ImageBackground"
$ref"#/$defs/TiledBackground"
title"Backgrounds"
type"array"
groups
default
Empty object
patternProperties
^[\w\d\-\._]+$
anyOf
$ref"#/$defs/CircularMarkerGroup"
$ref"#/$defs/PinMarkerGroup"
$ref"#/$defs/IconMarkerGroup"
title"Groups"
type"object"
categories
default
Empty object
patternProperties
^[\w\d\-\._]+$
$ref"#/$defs/MarkerCategory"
title"Categories"
type"object"
disclaimer
anyOf
minLength1
type"string"
type"null"
defaultnull
title"Disclaimer"
markers
additionalProperties
items
anyOf
$ref"#/$defs/LatLonMarker"
$ref"#/$defs/XyMarker"
type"array"
default
Empty object
title"Markers"
type"object"
custom
anyOf
type"object"
type"null"
defaultnull
title"Custom"
required
Empty object
title"DataMap"
type"object"