Optional
clearbackground color for sections where the painter doesn't draw to
Default is rgba(0, 0, 0, 0)
(transparent)
Optional
constrainStrictly a WM Projection property. Force the view to fill.
Defaults to false
.
Optional
descriptiondescription of the style - not used for anything other than debugging
Optional
duplicateStrictly a WM Projection property. Render the world map as necessary to fill the screen horizontally.
Defaults to true
.
Optional
Experimental
experimentalUtilize WIP experimental components that still have bugs in them.
Optional
fontsFonts and how to fetch them
ex.
"fonts": {
"robotoMedium": "/api/glyphs-v2/RobotoMedium"
}
Optional
glyphsGlyph Data (both fonts and icons) and how to fetch them
ex.
"glyphs": {
"robotoMedium": "/api/glyphs-v2/RobotoMedium",
"streets": "/api/glyphs-v2/streets"
}
Optional
iconsIcons and how to fetch them
ex.
"icons": {
"streets": "/api/glyphs-v2/streets"
}
Optional
imagesImage names and where to fetch
ex.
"images": {
"pattern": "/images/pattern.jpg"
Optional
layersLayers are the main way to render data on the map. Your layer options are:
Optional
maxThe maximum latitude position. Useful for the S2 Projection to avoid wonky movemeny at low zooms
Optional
maxzoomThe closest you allow the camera to get to the planet
Optional
minThe minimum latitude position. Useful for the S2 Projection to avoid wonky movemeny at low zooms
Optional
minzoomThe furthest away from the planet you allow
Optional
namename of the style - not used for anything other than debugging
Optional
noAllow the camera to go past the max-min latitudes. Useful for animations.
Optional
projectionUse Either The Web Mercator "WM" or the "S2" Projection. [Default: "S2"
]
Optional
skyboxSkybox is often used as a background feature for raster data. Uses a skybox image to render to the screen.
See UrlMap to use your own scheme/protocol for the URL path.
ex.
"skybox": {
"path": "baseURL://backgrounds/milkyway",
"loadingBackground": "rgb(9, 8, 17)",
"size": 2048,
"type": "webp"
}
Optional
sourcesWhere to fetch data and JSON guides on how to fetch them. If JSON data, it can be included directly in the source
ex.
"sources": {
"countries": "/s2json/countriesHD.s2json",
"earthquakes": "/s2json/earthquakes.s2json"
}
Optional
spritesSprites names and where to fetch
Sprites have a default expectancy of a png
image.
If you want to use a different format, you can use an object instead of a string.
See UrlMap to use your own scheme/protocol for the URL path.
ex.
"sprites": {
"streets": "/sprites/streets/sprite@2x"
}
ex.
"sprites": {
"streets": {
"path": "/sprites/streets/sprite@2x",
"fileType": "jpg"
}
}
Optional
timeTime series data is a WIP. Is a guide on how to render &/ animate data at various timestamps
Optional
versionversion of the style - not used for anything other than debugging
Optional
viewSet the camera view. Properties include:
zoom
: the zoom level of the maplon
: the longitude of the maplat
: the latitude of the mapbearing
: the bearing/compass of the map camerapitch
: the pitch/vertical-angle of the map cameraOptional
wallpaperWallpaper is often used with vector data. Control the coloring of the background.
ex.
"wallpaper": {
"background": "#030a2d",
"fade1": "rgb(138, 204, 255)",
"fade2": "rgb(217, 255, 255)",
"halo": "rgb(230, 255, 255)"
}
Optional
zzFar is a parameter for the camera. Recommend not touching
Optional
zzNear is a parameter for the camera. Recommend not touching
Optional
zoomOften times to improve the quality of raster data, you can apply a zoomOffset for tiles to render.
STYLE DEFINITION
Description
This is the user defined guide for how to render the map. This definition includes directions of what data to render, where to get said data, and how to style each data as layers.
Rendering Properties
projection
: [See Projection]"S2"
(Spherical Geometry) or"WM"
(Web Mercator). Defaults to S2sources
: [See Sources] Most critical, a list of source data, how to fetch for renderingtimeSeries
: [See TimeSeriesStyle] Time series data is a WIP. Is a guide on how to render &/ animate data at various timestampslayers
: [See LayerStyle] array of layer definitions, describing how to render the sceneglyphs
: [See Glyphs] Glyph Data (both fonts and icons) and how to fetch themicons
: [See Icons] Icon sources and how to fetch themfonts
: [See Fonts] Font sources and how to fetch themsprites
: [See Sprites] Sprites sources, where to fetch, can be a string or an objectimages
: Image names and where to fetch themskybox
: [See SkyboxStyle] Skybox is often used as a background feature for raster data. Uses a skybox image to render to the screen.wallpaper
: [See WallpaperStyle] Wallpaper is often used with vector data. Control the coloring of the background.clearColor
: Background color for sections where the painter doesn't draw to. Defaults torgba(0, 0, 0, 0)
Camera Properties
view
: [See View]zoom
,lon
,lat
,bearing
,pitch
. Defaults to 0 for all.zNear
: zNear is a parameter for the camera. Recommend not touching.zFar
: zFar is a parameter for the camera. Recommend not touching.minzoom
: The furthest away from the planet you allowmaxzoom
: The closest to the planet you allowminLatPosition
: The minimum latitude position. Useful for the S2 Projection to avoid wonky movemeny at low zoomsmaxLatPosition
: The maximum latitude position. Useful for the S2 Projection to avoid wonky movemeny at low zoomszoomOffset
: Often times to improve the quality of raster data, you can apply a zoomOffset for tiles to render.Base Properties
version
: version of the style - not used for anything other than debuggingname
: name of the style - not used for anything other than debuggingdescription
: description of the style - not used for anything other than debuggingFlags
constrainZoomToFill
: Strictly a WM Projection property. Force the view to fill. Defaults tofalse
duplicateHorizontally
: Strictly a WM Projection property. Render the world map as necessary to fill the screen horizontally. Defaults totrue
noClamp
: Allow the camera to go past the max-min latitudes. Useful for animations. Defaults tofalse
experimental
: Enable experimental features