diff options
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | docs.json | 2269 |
2 files changed, 16 insertions, 2270 deletions
@@ -2,6 +2,19 @@ Great looking and performant maps in Elm using MapboxGl. Discuss in #maps on the Elm Slack. +### High quality mapping in Elm + +There have been [some attempts](https://github.com/gampleman/elm-visualization/wiki/Data-Visualization-Packages#maps) to make native elm mapping packages. However, Mapbox offers a very complex solution that offers some killer features that are difficult to reproduce: + +- client side high quality cartography +- high performance with large datasets + +The way this works, the map accepts a configuration object called a **style**. The main thing in a style is a list of **layers**. Layers control what you see on the screen. Their order controls their layering (duh). Each layer references a data **source** and has a list of properties. Properties are a bit like CSS for maps in the sense that you can use them to specify colors, line thickness, etc. However, unlike CSS, the values that you pass to these use are **expressions** in a little language, that allows you to style based on other factors like the map's zoom level or actual data in any of the **features** being styled. + +**Sources** specify how to get the data that powers the layers. Multiple layers can take in a single source. + +This library allows you to specify the **style** declaratively passing it into a specific element in your view function. However, the map element holds some internal state: mostly about the position of the viewport and all the event handling needed to manipulate it. In my experience this is mostly what you want - the default map interactions tend to be appropriate. So this library includes commands that tell the map to modify its internal state (including stuff like animations etc). + ### How this works This library uses a combination of ports and custom elements. To get going, @@ -153,7 +166,9 @@ The `elmMapbox` function accepts an options object that takes the following opti - `token`: the Mapbox token. If you don't pass it here, you will need to use the `token` Elm attribute. - `easingFunctions`: an object whose values are easing functions (i.e. they take a number between 0..1 and return a number between 0..1). You can refer to these with the `easing` option in the Cmd.Option module. - - `onMount` a callback that gives you access to the mapbox instance whenever a map gets instantiated. Mostly useful for registering plugins. + - `onMount` a callback that gives you access to the mapbox instance whenever a map gets instantiated. Mostly useful for registering [plugins](https://www.mapbox.com/mapbox-gl-js/plugins). + +Furthermore, the elm-mapbox element exposes its internal mapboxgl.js reference as a `map` property, which you can use if necessary (although, worth mentioning on slack if you are needing to do this). ### License diff --git a/docs.json b/docs.json deleted file mode 100644 index 96cb5f9..0000000 --- a/docs.json +++ /dev/null @@ -1,2269 +0,0 @@ -[ - { - "name": "Mapbox.Element", - "comment": " This library wraps a Custom Element that actually renders a map.\n\n@docs map, css, MapboxAttr\n\n\n### Attributes\n\n@docs token, id, maxZoom, minZoom, maxBounds, renderWorldCopies\n\n\n### Events\n\n@docs EventData, TouchEvent, eventFeaturesFilter, eventFeaturesLayers\n\n@docs onMouseDown, onMouseUp, onMouseOver, onMouseMove, onClick, onDblClick, onMouseOut, onContextMenu, onZoom, onZoomStart, onZoomEnd, onRotate, onRotateStart, onRotateEnd, onTouchEnd, onTouchMove, onTouchCancel\n\n", - "aliases": [ - { - "name": "EventData", - "comment": " `point` is the coordinates in pixels in screen space.\n\n`lngLat` is the coordinates as a longitude, latitude in geographic space.\n\n`renderedFeatures` is a geojson that intersect the `lngLat`:\n\nThe properties value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only string and numeric property values are supported (i.e. null, Array, and Object values are not supported).\n\nEach feature includes a top-level layer property whose value is an object representing the style layer to which the feature belongs. Layout and paint properties in this object contain values which are fully evaluated for the given zoom level and feature.\n\nFeatures from layers whose visibility property is \"none\", or from layers whose zoom range excludes the current zoom level are not included. Symbol features that have been hidden due to text or icon collision are not included. Features from all other layers are included, including features that may have no visible contribution to the rendered result; for example, because the layer's opacity or color alpha component is set to 0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by descending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low zoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature geometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple times in query results. For example, suppose there is a highway running through the bounding rectangle of a query. The results of the query will be those parts of the highway that lie within the map tiles covering the bounding rectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile will be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple tiles due to tile buffering.\n\n", - "args": [], - "type": "{ point : ( Int, Int ) , lngLat : LngLat.LngLat , renderedFeatures : List Json.Decode.Value }" - }, - { - "name": "TouchEvent", - "comment": " `touches` will list stuff for every finger involved in a gesture.\n\n`center` refers to the point in the geometric center of `touches`.\n\n", - "args": [], - "type": "{ touches : List Mapbox.Element.EventData , center : Mapbox.Element.EventData }" - } - ], - "types": [ - { - "name": "MapboxAttr", - "comment": " This is the type that all attributes have.\n", - "args": [ - "msg" - ], - "cases": [] - } - ], - "values": [ - { - "name": "css", - "comment": " This is literally:\n\n <link\n href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.46.0/mapbox-gl.css'\n rel='stylesheet' />\n\nYou can include the required styles yourself if it fits better with the way you deploy your assets, this is meant as a quick way to get started.\n\n", - "type": "Html.Html msg" - }, - { - "name": "eventFeaturesFilter", - "comment": " By default the `renderedFeatures` property in events will return\na lot of data. If you don't need it, you can provide a filter to filter that data. This will make things more performant.\n", - "type": "Mapbox.Expression.Expression Mapbox.Expression.DataExpression Bool -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "eventFeaturesLayers", - "comment": " By default the `renderedFeatures` property in events will return\na lot of data. Here you can specify which layers you want to search for intersections. If you don't care about intersecting data at all, you can optimize performance by passing an empty list to this attribute.\n", - "type": "List String -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "id", - "comment": " The element's Id. This should be unique. You will need this if you want to use the Mapbox.Cmd module.\n", - "type": "String -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "map", - "comment": " A Map html element renders a map based on a Style.\n", - "type": "List (Mapbox.Element.MapboxAttr msg) -> Mapbox.Style.Style -> Html.Html msg" - }, - { - "name": "maxBounds", - "comment": " If set, the map will be constrained to the given bounds. The bounds are the `(south-west corner, north-east corner)`.\n", - "type": "( LngLat.LngLat, LngLat.LngLat ) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "maxZoom", - "comment": " The maximum zoom level of the map (0-24). Default 22.\n", - "type": "Float -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "minZoom", - "comment": " The minimum zoom level of the map (0-24).\n", - "type": "Float -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onClick", - "comment": " Fired when a pointing device (usually a mouse) is pressed and released at the same point on the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onContextMenu", - "comment": " Fired when the right button of the mouse is clicked or the context menu key is pressed within the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onDblClick", - "comment": " Fired when a pointing device (usually a mouse) is clicked twice at the same point on the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onMouseDown", - "comment": " Fired when a pointing device (usually a mouse) is pressed within the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onMouseMove", - "comment": " Fired when a pointing device (usually a mouse) is moved within the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onMouseOut", - "comment": " Fired when a point device (usually a mouse) leaves the map's canvas.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onMouseOver", - "comment": " Fired when a pointing device (usually a mouse) is moved within the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onMouseUp", - "comment": " Fired when a pointing device (usually a mouse) is released within the map.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onRotate", - "comment": " Fired repeatedly during a \"drag to rotate\" interaction.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onRotateEnd", - "comment": " Fired when a \"drag to rotate\" interaction ends.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onRotateStart", - "comment": " Fired when a \"drag to rotate\" interaction starts.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onTouchCancel", - "comment": " Fired when a touchcancel event occurs within the map.\n", - "type": "(Mapbox.Element.TouchEvent -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onTouchEnd", - "comment": " Fired when a touchend event occurs within the map.\n", - "type": "(Mapbox.Element.TouchEvent -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onTouchMove", - "comment": " Fired when a touchmove event occurs within the map.\n", - "type": "(Mapbox.Element.TouchEvent -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onZoom", - "comment": " Fired repeatedly during an animated transition from one zoom level to another.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onZoomEnd", - "comment": " Fired just after the map completes a transition from one zoom level to another.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "onZoomStart", - "comment": " Fired just before the map begins a transition from one zoom level to another.\n", - "type": "(Mapbox.Element.EventData -> msg) -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "renderWorldCopies", - "comment": " If true, multiple copies of the world will be rendered, when zoomed out.\n", - "type": "Bool -> Mapbox.Element.MapboxAttr msg" - }, - { - "name": "token", - "comment": " Your [Mapbox API Token](https://www.mapbox.com/help/create-api-access-token/).\n", - "type": "String -> Mapbox.Element.MapboxAttr msg" - } - ], - "generated-with-elm-version": "0.18.0" - }, - { - "name": "Mapbox.Style", - "comment": " 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 object with specific root level and nested properties. This specification defines and describes these properties.\n\n@docs Style, encode , StyleDef\n\n\n### Light\n\n@docs Light, defaultLight\n\n\n### Transition\n\n@docs Transition, defaultTransition\n\n\n### Misc Attributes\n\n@docs MiscAttr, sprite, glyphs, name, defaultCenter, defaultZoomLevel, defaultBearing, defaultPitch, metadata\n\n\n### Predefined styles\n\nYou can also use one of these predefined styles.\n\n@docs streets, outdoors, light, dark, satellite, satelliteStreets\n\n", - "aliases": [ - { - "name": "Light", - "comment": " The global light source.\n\n\n### `anchor`\n\nWhether extruded geometries are lit relative to the map or viewport.\n\n\n### `position`\n\nPosition 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 the `anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `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).\n\n\n### `color`\n\nColor tint for lighting extruded geometries.\n\n\n### `intensity`\n\nIntensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.\n\n", - "args": [], - "type": "{ anchor : Mapbox.Expression.Anchor , position : Mapbox.Expression.Expression Mapbox.Expression.CameraExpression (Array.Array Float) , color : Mapbox.Expression.Expression Mapbox.Expression.CameraExpression Mapbox.Expression.Color , intensity : Mapbox.Expression.Expression Mapbox.Expression.CameraExpression Float }" - }, - { - "name": "StyleDef", - "comment": " This is the core representation of a Mapbox style. It has the following keys:\n\n\n### Layers\n\nThese define what is actually rendered on screen. See the Mapbox.Layer module on how to configure these.\n\n\n### Sources\n\nThese define the data sources that feed the Layers. See the Mapbox.Source module for more.\n\n\n### Misc\n\nThese are all optional attributes.\n\nAll the other keys are values defined below.\n\n", - "args": [], - "type": "{ transition : Mapbox.Style.Transition , light : Mapbox.Style.Light , layers : List Mapbox.Layer.Layer , sources : List Mapbox.Source.Source , misc : List Mapbox.Style.MiscAttr }" - }, - { - "name": "Transition", - "comment": " A transition property controls timing for the interpolation between a transitionable style property's previous value and new value.\n\n\n### `duration`\n\nTime (in ms) allotted for transitions to complete.\n\n\n### `delay`\n\nLength of time (in ms) before a transition begins.\n\n", - "args": [], - "type": "{ duration : Int, delay : Int }" - } - ], - "types": [ - { - "name": "MiscAttr", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Style", - "comment": " A mapbox style.\n\nYou can either create a style spec in Elm (for which the rest of this library is useful :) or load one from a remote URL.\n\nTo load a style from the Mapbox API, you can use a URL of the form `FromUrl \"mapbox://styles/:owner/:style\"`, where `:owner` is your Mapbox account name and `:style` is the style ID.\n\n", - "args": [], - "cases": [ - [ - "Style", - [ - "Mapbox.Style.StyleDef" - ] - ], - [ - "FromUrl", - [ - "String" - ] - ] - ] - } - ], - "values": [ - { - "name": "dark", - "comment": " ", - "type": "Mapbox.Style.Style" - }, - { - "name": "defaultBearing", - "comment": " Default bearing, in degrees. The bearing is the compass direction that is \"up\"; for example, a bearing of 90° orients the map so that east is up. This value will be used only if the map has not been positioned by other means (e.g. map options or user interaction).\n", - "type": "Float -> Mapbox.Style.MiscAttr" - }, - { - "name": "defaultCenter", - "comment": " 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).\n", - "type": "LngLat.LngLat -> Mapbox.Style.MiscAttr" - }, - { - "name": "defaultLight", - "comment": " A decent default light.\n", - "type": "Mapbox.Style.Light" - }, - { - "name": "defaultPitch", - "comment": " 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).\n", - "type": "Float -> Mapbox.Style.MiscAttr" - }, - { - "name": "defaultTransition", - "comment": " The defaults for a transition\n", - "type": "Mapbox.Style.Transition" - }, - { - "name": "defaultZoomLevel", - "comment": " 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).\n", - "type": "Float -> Mapbox.Style.MiscAttr" - }, - { - "name": "encode", - "comment": " Encodes the style into JSON.\n", - "type": "Mapbox.Style.Style -> Json.Encode.Value" - }, - { - "name": "glyphs", - "comment": " 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 `textField` layout property.\n", - "type": "String -> Mapbox.Style.MiscAttr" - }, - { - "name": "light", - "comment": " ", - "type": "Mapbox.Style.Style" - }, - { - "name": "metadata", - "comment": " Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'.\n", - "type": "List ( String, Json.Encode.Value ) -> Mapbox.Style.MiscAttr" - }, - { - "name": "name", - "comment": " A human-readable name for the style.\n", - "type": "String -> Mapbox.Style.MiscAttr" - }, - { - "name": "outdoors", - "comment": " ", - "type": "Mapbox.Style.Style" - }, - { - "name": "satellite", - "comment": " ", - "type": "Mapbox.Style.Style" - }, - { - "name": "satelliteStreets", - "comment": " ", - "type": "Mapbox.Style.Style" - }, - { - "name": "sprite", - "comment": " 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 `backgroundPattern`, `fillPattern`, `linePattern`, `fillExtrusionPattern`, or `iconImage` properties.\n", - "type": "String -> Mapbox.Style.MiscAttr" - }, - { - "name": "streets", - "comment": " ", - "type": "Mapbox.Style.Style" - } - ], - "generated-with-elm-version": "0.18.0" - }, - { - "name": "Mapbox.Cmd.Template", - "comment": " This module has a bunch of essentially imperative commands for your map.\n\nHowever, since a published library can't have ports in it, you will need to do some setup. The easiest way to do this is to copy [this file into your app](https://github.com/gampleman/elm-mapbox/blob/master/examples/MapCommands.elm). You can see the module docs for that [here](https://github.com/gampleman/elm-mapbox/blob/master/docs/MapCommands.md).\n\n@docs Id, Outgoing, Option, Supported\n\nYou can of course customize the module you copy into your codebase to support things like having multiple maps on the page at once, etc.\n\n\n### Moving the map around\n\n@docs panBy, panTo, zoomTo, zoomIn, zoomOut, rotateTo, jumpTo, easeTo, flyTo, stop\n\n\n### Fiting bounds\n\n@docs fitBounds\n\n\n### Other\n\n@docs setRTLTextPlugin, resize\n\n\n### Querying the map\n\n@docs queryResults, getBounds, queryRenderedFeatures\n\n", - "aliases": [ - { - "name": "Id", - "comment": " Every command takes the DOM id of the map that it should operate on.\n", - "args": [], - "type": "String" - }, - { - "name": "Option", - "comment": " This is exported here to simply for convenience. See `Cmd.Option` for more docs.\n", - "args": [ - "support" - ], - "type": "Mapbox.Cmd.Internal.Option support" - }, - { - "name": "Outgoing", - "comment": " The type of a port that you need to provide for this module to work.\n", - "args": [ - "msg" - ], - "type": "Json.Encode.Value -> Platform.Cmd.Cmd msg" - }, - { - "name": "Supported", - "comment": " ", - "args": [], - "type": "Mapbox.Cmd.Internal.Supported" - } - ], - "types": [], - "values": [ - { - "name": "easeTo", - "comment": " Changes any combination of center, zoom, bearing, and pitch, with an animated transition between old and new values. The map will retain its current values for any details not specified in options.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { center : Mapbox.Cmd.Template.Supported , zoom : Mapbox.Cmd.Template.Supported , bearing : Mapbox.Cmd.Template.Supported , pitch : Mapbox.Cmd.Template.Supported , around : Mapbox.Cmd.Template.Supported , duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "fitBounds", - "comment": " Pans and zooms the map to contain its visible area within the specified geographical bounds. This function will also reset the map's bearing to 0 if bearing is nonzero.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { padding : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , linear : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , maxZoom : Mapbox.Cmd.Template.Supported }) -> ( LngLat.LngLat, LngLat.LngLat ) -> Platform.Cmd.Cmd msg" - }, - { - "name": "flyTo", - "comment": " Changes any combination of center, zoom, bearing, and pitch, animating the transition along a curve that evokes flight. The animation seamlessly incorporates zooming and panning to help the user maintain her bearings even after traversing a great distance.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { center : Mapbox.Cmd.Template.Supported , zoom : Mapbox.Cmd.Template.Supported , bearing : Mapbox.Cmd.Template.Supported , pitch : Mapbox.Cmd.Template.Supported , around : Mapbox.Cmd.Template.Supported , duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported , curve : Mapbox.Cmd.Template.Supported , minZoom : Mapbox.Cmd.Template.Supported , speed : Mapbox.Cmd.Template.Supported , screenSpeed : Mapbox.Cmd.Template.Supported , maxDuration : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "getBounds", - "comment": " Responds with the map's geographical bounds. Takes a numerical ID that allows you to associate the question with the answer.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> Int -> Platform.Cmd.Cmd msg" - }, - { - "name": "jumpTo", - "comment": " Changes any combination of center, zoom, bearing, and pitch, without an animated transition. The map will retain its current values for any details not specified in options.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { center : Mapbox.Cmd.Template.Supported , zoom : Mapbox.Cmd.Template.Supported , bearing : Mapbox.Cmd.Template.Supported , pitch : Mapbox.Cmd.Template.Supported , around : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "panBy", - "comment": " Pans the map by the specified offest.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> ( Int, Int ) -> Platform.Cmd.Cmd msg" - }, - { - "name": "panTo", - "comment": " Pans the map to the specified location, with an animated transition.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> LngLat.LngLat -> Platform.Cmd.Cmd msg" - }, - { - "name": "queryRenderedFeatures", - "comment": " Returns an array of GeoJSON Feature objects representing visible features that satisfy the query parameters. Takes a numerical ID that allows you to associate the question with the answer.\n\nThe response: The properties value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only string and numeric property values are supported (i.e. null, Array, and Object values are not supported).\n\nEach feature includes a top-level layer property whose value is an object representing the style layer to which the feature belongs. Layout and paint properties in this object contain values which are fully evaluated for the given zoom level and feature.\n\nFeatures from layers whose visibility property is \"none\", or from layers whose zoom range excludes the current zoom level are not included. Symbol features that have been hidden due to text or icon collision are not included. Features from all other layers are included, including features that may have no visible contribution to the rendered result; for example, because the layer's opacity or color alpha component is set to 0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by descending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low zoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature geometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple times in query results. For example, suppose there is a highway running through the bounding rectangle of a query. The results of the query will be those parts of the highway that lie within the map tiles covering the bounding rectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile will be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple tiles due to tile buffering.\n\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> Int -> List (Mapbox.Cmd.Template.Option { layers : Mapbox.Cmd.Template.Supported , filter : Mapbox.Cmd.Template.Supported , query : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "queryResults", - "comment": " Wraps an incoming port so that you can get nicer subscritions:\n\n port elmMapboxIncoming : (Value -> msg) -> Sub msg\n\n", - "type": "((Json.Encode.Value -> msg) -> Platform.Sub.Sub msg) -> (Int -> ( LngLat.LngLat, LngLat.LngLat ) -> response) -> (Int -> List Json.Encode.Value -> response) -> (String -> response) -> (response -> msg) -> Platform.Sub.Sub msg" - }, - { - "name": "resize", - "comment": " Resizes the map according to the dimensions of its container element.\n\nThis command must be sent after the map's container is resized, or when the map is shown after being initially hidden with CSS.\n\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> Platform.Cmd.Cmd msg" - }, - { - "name": "rotateTo", - "comment": " Rotates the map to the specified bearing, with an animated transition. The bearing is the compass direction that is \"up\"; for example, a bearing of 90° orients the map so that east is up.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> Float -> Platform.Cmd.Cmd msg" - }, - { - "name": "setRTLTextPlugin", - "comment": " Sets the map's [RTL text plugin](https://www.mapbox.com/mapbox-gl-js/plugins/#mapbox-gl-rtl-text). Necessary for supporting languages like Arabic and Hebrew that are written right-to-left. Takes a URL pointing to the Mapbox RTL text plugin source.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> String -> Platform.Cmd.Cmd msg" - }, - { - "name": "stop", - "comment": " Stops any animated transition underway.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> Platform.Cmd.Cmd msg" - }, - { - "name": "zoomIn", - "comment": " Increases the map's zoom level by 1.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "zoomOut", - "comment": " Decreases the map's zoom level by 1.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> Platform.Cmd.Cmd msg" - }, - { - "name": "zoomTo", - "comment": " Zooms the map to the specified zoom level, with an animated transition.\n", - "type": "Mapbox.Cmd.Template.Outgoing msg -> Mapbox.Cmd.Template.Id -> List (Mapbox.Cmd.Template.Option { duration : Mapbox.Cmd.Template.Supported , easing : Mapbox.Cmd.Template.Supported , offset : Mapbox.Cmd.Template.Supported , animate : Mapbox.Cmd.Template.Supported }) -> Float -> Platform.Cmd.Cmd msg" - } - ], - "generated-with-elm-version": "0.18.0" - }, - { - "name": "Mapbox.Cmd.Option", - "comment": "\n\n\n### Animation options\n\nOptions common to map movement commands that involve animation, such as panBy and easeTo, controlling the duration and easing function of the animation. All properties are optional.\n\n@docs duration, easing, offset, animate\n\n@docs curve, minZoom, speed, screenSpeed, maxDuration\n\n\n### Camera Options\n\nOptions common to `jumpTo`, `easeTo`, and `flyTo`, controlling the desired location, zoom, bearing, and pitch of the camera. All properties are optional, and when a property is omitted, the current camera value for that property will remain unchanged.\n\n@docs center, zoom, bearing, pitch, around\n\n\n### Fiting bounds\n\n@docs padding, Padding, linear, maxZoom\n\n\n### Querying rendered features\n\n@docs layers, filter, intersectsPoint, intersectsBox\n\n", - "aliases": [ - { - "name": "Padding", - "comment": " ", - "args": [], - "type": "{ top : Int, right : Int, bottom : Int, left : Int }" - } - ], - "types": [], - "values": [ - { - "name": "animate", - "comment": " If false, no animation will occur.\n", - "type": "Bool -> Mapbox.Cmd.Internal.Option { a | animate : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "around", - "comment": " If `zoom` is specified, `around` determines the point around which the zoom is centered.\n", - "type": "LngLat.LngLat -> Mapbox.Cmd.Internal.Option { a | around : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "bearing", - "comment": " The desired bearing, in degrees. The bearing is the compass direction that is \"up\"; for example, a bearing of 90° orients the map so that east is up.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | bearing : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "center", - "comment": " The desired center.\n", - "type": "LngLat.LngLat -> Mapbox.Cmd.Internal.Option { a | center : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "curve", - "comment": " The zooming \"curve\" that will occur along the flight path.\nA high value maximizes zooming for an exaggerated animation, while a\nlow value minimizes zooming for an effect closer to `easeTo`.\n1.42 is the average value selected by participants in the user study discussed in [van Wijk (2003)](https://www.win.tue.nl/~vanwijk/zoompan.pdf).\nA value of `6 ^ 0.25` would be equivalent to the root mean squared average velocity. A value of 1 would produce a circular motion.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | curve : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "duration", - "comment": " The animation's duration, measured in milliseconds.\n", - "type": "Int -> Mapbox.Cmd.Internal.Option { a | duration : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "easing", - "comment": " The name of an easing function. These must be passed to `elmMapbox`\nin the `easingFunctions` option.\n", - "type": "String -> Mapbox.Cmd.Internal.Option { a | easing : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "filter", - "comment": " A filter to limit query results.\n", - "type": "Mapbox.Expression.Expression Mapbox.Expression.DataExpression Bool -> Mapbox.Cmd.Internal.Option { a | filter : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "intersectsBox", - "comment": " Only include layers that instersect the box (defined as south west / north east corners).\n", - "type": "( LngLat.LngLat, LngLat.LngLat ) -> Mapbox.Cmd.Internal.Option { a | query : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "intersectsPoint", - "comment": " Only include layers that instersect this point.\n", - "type": "LngLat.LngLat -> Mapbox.Cmd.Internal.Option { a | query : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "layers", - "comment": " A list of style layer IDs for the query to inspect. Only features within these layers will be returned. If this parameter is not set, all layers will be checked.\n", - "type": "List String -> Mapbox.Cmd.Internal.Option { a | layers : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "linear", - "comment": " If true, the map transitions using `easeTo` . If false, the map transitions using `flyTo`.\n", - "type": "Bool -> Mapbox.Cmd.Internal.Option { a | linear : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "maxDuration", - "comment": " The animation's maximum duration, measured in milliseconds. If duration exceeds maximum duration, it resets to 0.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | maxDuration : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "maxZoom", - "comment": " The maximum zoom level to allow when the map view transitions to the specified bounds.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | maxZoom : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "minZoom", - "comment": " The zero-based zoom level at the peak of the flight path.\nIf `curve` is specified, this option is ignored.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | minZoom : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "offset", - "comment": " Offset of the target center relative to real map container center at the end of animation.\n", - "type": "( Int, Int ) -> Mapbox.Cmd.Internal.Option { a | offset : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "padding", - "comment": " The amount of padding in pixels to add to the given bounds.\n", - "type": "Mapbox.Cmd.Option.Padding -> Mapbox.Cmd.Internal.Option { a | padding : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "pitch", - "comment": " The desired pitch, in degrees.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | pitch : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "screenSpeed", - "comment": " The average speed of the animation measured in screenfuls per second, assuming a linear timing curve. If `speed` is specified, this option is ignored.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | screenSpeed : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "speed", - "comment": " The average speed of the animation defined in relation to `curve`. A speed of 1.2 means that the map appears to move along the flight path by 1.2 times `curve` screenfuls every second. A screenful is the map's visible span. It does not correspond to a fixed physical distance, but varies by zoom level.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | speed : Mapbox.Cmd.Internal.Supported }" - }, - { - "name": "zoom", - "comment": " The desired zoom level.\n", - "type": "Float -> Mapbox.Cmd.Internal.Option { a | zoom : Mapbox.Cmd.Internal.Supported }" - } - ], - "generated-with-elm-version": "0.18.0" - }, - { - "name": "Mapbox.Layer", - "comment": " Layers specify what is actually rendered on the map and are rendered in order.\n\nExcept for layers of the background type, each layer needs to refer to a source. Layers take the data that they get from a source, optionally filter features, and then define how those features are styled.\n\nThere are two kinds of properties: *Layout* and *Paint* properties.\n\nLayout properties are applied early in the rendering process and define how data for that layer is passed to the GPU. Changes to a layout property require an asynchronous \"layout\" step.\n\nPaint properties are applied later in the rendering process. Changes to a paint property are cheap and happen synchronously.\n\n\n### Working with layers\n\n@docs Layer, SourceId, encode\n\n\n### Layer Types\n\n@docs background, fill, symbol, line, raster, circle, fillExtrusion, heatmap, hillshade\n@docs Background, Fill, Symbol, Line, Raster, Circle, FillExtrusion, Heatmap, Hillshade\n\n\n### General Attributes\n\n@docs LayerAttr\n@docs metadata, sourceLayer, minzoom, maxzoom, filter, visible\n\n\n### Fill Attributes\n\n@docs fillAntialias, fillColor, fillOpacity, fillOutlineColor, fillPattern, fillTranslate, fillTranslateAnchor\n\n\n### Line Attributes\n\n@docs lineBlur, lineCap, lineColor, lineDasharray, lineGapWidth, lineGradient, lineJoin, lineMiterLimit, lineOffset, lineOpacity, linePattern, lineRoundLimit, lineTranslate, lineTranslateAnchor, lineWidth\n\n\n### Circle Attributes\n\n@docs circleBlur, circleColor, circleOpacity, circlePitchAlignment, circlePitchScale, circleRadius, circleStrokeColor, circleStrokeOpacity, circleStrokeWidth, circleTranslate, circleTranslateAnchor\n\n\n### Heatmap Attributes\n\n@docs heatmapColor, heatmapIntensity, heatmapOpacity, heatmapRadius, heatmapWeight\n\n\n### FillExtrusion Attributes\n\n@docs fillExtrusionBase, fillExtrusionColor, fillExtrusionHeight, fillExtrusionOpacity, fillExtrusionPattern, fillExtrusionTranslate, fillExtrusionTranslateAnchor\n\n\n### Symbol Attributes\n\n@docs iconAllowOverlap, iconAnchor, iconColor, iconHaloBlur, iconHaloColor, iconHaloWidth, iconIgnorePlacement, iconImage, iconKeepUpright, iconOffset, iconOpacity, iconOptional, iconPadding, iconPitchAlignment, iconRotate, iconRotationAlignment, iconSize, iconTextFit, iconTextFitPadding, iconTranslate, iconTranslateAnchor, symbolAvoidEdges, symbolPlacement, symbolSpacing, textAllowOverlap, textAnchor, textColor, textField, textFont, textHaloBlur, textHaloColor, textHaloWidth, textIgnorePlacement, textJustify, textKeepUpright, textLetterSpacing, textLineHeight, textMaxAngle, textMaxWidth, textOffset, textOpacity, textOptional, textPadding, textPitchAlignment, textRotate, textRotationAlignment, textSize, textTransform, textTranslate, textTranslateAnchor\n\n\n### Raster Attributes\n\n@docs rasterBrightnessMax, rasterBrightnessMin, rasterContrast, rasterFadeDuration, rasterHueRotate, rasterOpacity, rasterSaturation\n\n\n### Hillshade Attributes\n\n@docs hillshadeAccentColor, hillshadeExaggeration, hillshadeHighlightColor, hillshadeIlluminationAnchor, hillshadeIlluminationDirection, hillshadeShadowColor\n\n\n### Background Attributes\n\n@docs backgroundColor, backgroundOpacity, backgroundPattern\n\n", - "aliases": [ - { - "name": "SourceId", - "comment": " All layers (except background layers) need a source\n", - "args": [], - "type": "String" - } - ], - "types": [ - { - "name": "Background", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Circle", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Fill", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "FillExtrusion", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Heatmap", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Hillshade", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Layer", - "comment": " Represents a layer.\n", - "args": [], - "cases": [] - }, - { - "name": "LayerAttr", - "comment": " ", - "args": [ - "tipe" - ], - "cases": [] - }, - { - "name": "Line", - "comment": " ", - "args": [], - "cases": [] - }, - { - "name": "Raster", - "comment": " ", - "args": [], - "cases": [] |