geotools-18.4-userguide.zip_Geotools_mile8ai

Mapbox Style Specification ========================== A Mapbox style is a document that defines the visual appearance of a map: what data to draw, the order to draw it in, and how to style the data when drawing it. A style document is a `JSON <http://www.json.org/>`__ object with specific root level and nested properties. This specification defines and describes these properties. The intended audience of this quick reference includes: - Advanced designers and cartographers who want to write styles by hand - GeoTools developers using the mbstyle module - Authors of software that generates or processes Mapbox styles. - Feature support is provided for the `Mapbox GL JS <https://www.mapbox.com/mapbox-gl-js/api/>`__, `Open Layers <https://npmjs.com/package/ol-mapbox-style>`__ and the GeoTools mbstyle module. - Where appropriate examples have been changed to reference `GeoWebCache <http://geowebcache.org/>`__. .. note:: The `Mapbox Style Specification <https://www.mapbox.com/mapbox-gl-style-spec>`__ is generated from the BSD `Mapbox GL JS <https://github.com/mapbox/mapbox-gl-js>`__ github repository, reproduced here with details on this GeoTools implementation. Root Properties --------------- Root level properties of a Mapbox style specify the map's layers, tile sources and other resources, and default values for the initial camera position when not specified elsewhere. :: { "version": 8, "name": "Mapbox Streets", "sprite": "sprites/streets-v8", "glyphs": "{fontstack}/{range}.pbf", "sources": {...}, "layers": [...] } version ~~~~~~~ *Required* :ref:`types-enum`. Style specification version number. Must be 8. :: "version": 8 name ~~~~ *Optional* :ref:`types-string`. A human-readable name for the style. :: "name": "Bright" metadata ~~~~~~~~ *Optional* Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions. .. note:: *unsupported.* center ~~~~~~ *Optional* :ref:`types-array`. Default map center in longitude and latitude. The style center will be used only if the map has not been positioned by other means (e.g. map options or user interaction). :: "center": [ -73.9749, 40.7736 ] .. note:: *unsupported* zoom ~~~~ *Optional* :ref:`types-number`. Default zoom level. The style zoom will be used only if the map has not been positioned by other means (e.g. map options or user interaction). :: "zoom": 12.5 bearing ~~~~~~~ *Optional* :ref:`types-number`. *Units in degrees. Defaults to* 0. Default bearing, in degrees clockwise from true north. The style bearing will be used only if the map has not been positioned by other means (e.g. map options or user interaction). :: "bearing": 29 .. note:: *unsupported* pitch ~~~~~ *Optional* :ref:`types-number`. *Units in degrees. Defaults to* 0. Default pitch, in degrees. Zero is perpendicular to the surface, for a look straight down at the map, while a greater value like 60 looks ahead towards the horizon. The style pitch will be used only if the map has not been positioned by other means (e.g. map options or user interaction). :: "pitch": 50 light ~~~~~ The global light source. :: "light": { "anchor": "viewport", "color": "white", "intensity": 0.4 } sources ~~~~~~~ *Required* :ref:`sources`. Data source specifications. :: "sources": { "mapbox-streets": { "type": "vector", "url": "mapbox://mapbox.mapbox-streets-v6" } } sprite ~~~~~~ *Optional* :ref:`types-string`. A base URL for retrieving the sprite image and metadata. The extensions ``.png``, ``.json`` and scale factor ``@2x.png`` will be automatically appended. This property is required if any layer uses the ``background-pattern``, ``fill-pattern``, ``line-pattern``, ``fill-extrusion-pattern``, or ``icon-image`` properties. :: "sprite" : "/geoserver/styles/mark" glyphs ~~~~~~ *Optional* :ref:`types-string`. A URL template for loading signed-distance-field glyph sets in PBF format. The URL must include ``{fontstack}`` and ``{range}`` tokens. This property is required if any layer uses the ``text-field`` layout property. :: "glyphs": "{fontstack}/{range}.pbf" transition ~~~~~~~~~~ *Required* :ref:`transition`. A global transition definition to use as a default across properties. :: "transition": { "duration": 300, "delay": 0 } layers ~~~~~~ *Required* :ref:`types-array`. Layers will be drawn in the order of this array. :: "layers": [ { "id": "water", "source": "sf:roads", "source-layer": "water", "type": "fill", "paint": { "fill-color": "#00ffff" } } ] Light ----- A style's ``light`` property provides global light source for that style. :: "light": { "anchor": "viewport", "color": "white", "intensity": 0.4 } anchor ~~~~~~ *Optional* :ref:`types-enum`. *One of* map, viewport. *Defaults to* viewport. Whether extruded geometries are lit relative to the map or viewport. map The position of the light source is aligned to the rotation of the map. viewport The position of the light source is aligned to the rotation of the viewport. :: "anchor": "map" .. list-table:: :widths: 19, 27, 27, 27 :header-rows: 1 * - Support - Mapbox - GeoTools - OpenLayers * - basic functionality - >= 0.27.0 - Not yet supported - Not yet supported position ~~~~~~~~ *Optional* :ref:`types-array`. *Defaults to* 1.15,210,30. Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when ``light.anchor`` is set to ``viewport`` corresponds to the top of the viewport, or 0° when ``light.anchor`` is set to ``map`` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below). :: "position": [ 1.5, 90, 80 ] .. list-table:: :widths: 19, 27, 27, 27 :header-rows: 1 * - Support - Mapbox - GeoTools - OpenLayers * - basic functionality - >= 0.27.0 - Not yet supported - Not yet supported color ~~~~~ *Optional* :ref:`types-color`. *Defaults to* #ffffff. Color tint for lighting extruded geometries. .. list-table:: :widths: 19, 27, 27, 27 :header-rows: 1 * - Support - Mapbox - GeoTools - OpenLayers * - basic functionality - >= 0.27.0 - Not yet supported - Not yet supported intensity ~~~~~~~~~ *Optional* :ref:`types-number`. *Defaults to* 0.5. Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast. .. list-table:: :widths: 19, 27, 27, 27 :header-rows: 1 * - Support - Mapbox - GeoTools - OpenLayers * - basic functionality - >= 0.27.0 - Not yet supported - Not yet supported .. _sources: Sources ------- Sources supply data to be shown on the map. The type of source is specified by the ``"type"`` property, and must be one of vector, raster, geojson, image, video, canvas. Adding a source won't immediately make data appear on the map because sources don't contain styling details like color or width. Layers refer to a source and give it a visual representation. This makes it possible to style the same source in different ways, like differentiating between types of roads in a highways layer. Tiled sources (vector and raster) must specify their details in terms of the `TileJSON specification <https://github.com/mapbox/tilejson-spec>`__. This can be done in several ways: - By supply