diff options
| -rw-r--r-- | src/Mapbox/Element.elm | 357 | ||||
| -rw-r--r-- | src/Mapbox/Style.elm | 82 | ||||
| -rw-r--r-- | src/js/main.js | 156 |
3 files changed, 542 insertions, 53 deletions
diff --git a/src/Mapbox/Element.elm b/src/Mapbox/Element.elm index 4ca28cc..73b569f 100644 --- a/src/Mapbox/Element.elm +++ b/src/Mapbox/Element.elm @@ -1,19 +1,43 @@ -module Mapbox.Element exposing (..) +module Mapbox.Element exposing (map, css, MapboxAttr, token, id, maxZoom, minZoom, maxBounds, LngLat, renderWorldCopies, EventData, TouchEvent, eventFeaturesFilter, eventFeaturesLayers, onMouseDown, onMouseUp, onMouseOver, onMouseMove, onClick, onDblClick, onMouseOut, onContextMenu, onZoom, onZoomStart, onZoomEnd, onRotate, onRotateStart, onRotateEnd, onTouchEnd, onTouchMove, onTouchCancel, controlledMap, Viewport) + +{-| This library wraps a Custom Element that actually renders a map. + +@docs map, css, MapboxAttr + + +### Attributes + +@docs token, id, maxZoom, minZoom, maxBounds, LngLat, renderWorldCopies + + +### Events + +@docs EventData, TouchEvent, eventFeaturesFilter, eventFeaturesLayers + +@docs onMouseDown, onMouseUp, onMouseOver, onMouseMove, onClick, onDblClick, onMouseOut, onContextMenu, onZoom, onZoomStart, onZoomEnd, onRotate, onRotateStart, onRotateEnd, onTouchEnd, onTouchMove, onTouchCancel + + +### Controlled mode + +@docs controlledMap, Viewport + +-} import Html exposing (Attribute, Html, node) -import Html.Attributes exposing (property, attribute) +import Html.Attributes exposing (attribute, property) +import Html.Events exposing (Options) +import Json.Decode as Decode exposing (Decoder, Value) import Json.Encode as Encode +import Mapbox.Expression exposing (DataExpression, Expression) import Mapbox.Style exposing (Style) +{-| This is the type that all attributes have. +-} type MapboxAttr msg = MapboxAttr (Attribute msg) -type Control msg - = Control (Html msg) - - type Position = TopLeft | BottomLeft @@ -21,56 +45,75 @@ type Position | BottomRight -map : List (MapboxAttr msg) -> List (Control msg) -> Html msg -map attrs children = +{-| A Map html element renders a map based on a Style. +-} +map : List (MapboxAttr msg) -> Style -> Html msg +map attrs style = let props = - (List.map (\(MapboxAttr attr) -> attr) attrs) + (Mapbox.Style.encode style + |> property "mapboxStyle" + ) + :: (List.map (\(MapboxAttr attr) -> attr) attrs) in node "elm-mapbox-map" props [] +{-| This is literally: + + <link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.45.0/mapbox-gl.css' rel='stylesheet' /> + +You 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. + +-} css : Html msg css = node "link" [ attribute "href" "https://api.tiles.mapbox.com/mapbox-gl-js/v0.45.0/mapbox-gl.css", attribute "rel" "stylesheet" ] [] -style : Style -> MapboxAttr msg -style = - Mapbox.Style.encode >> property "mapboxStyle" >> MapboxAttr - - +{-| The minimum zoom level of the map (0-24). +-} minZoom : Float -> MapboxAttr msg minZoom = Encode.float >> property "minZoom" >> MapboxAttr +{-| The maximum zoom level of the map (0-24). Default 22. +-} maxZoom : Float -> MapboxAttr msg maxZoom = Encode.float >> property "maxZoom" >> MapboxAttr +{-| Your [Mapbox API Token](https://www.mapbox.com/help/create-api-access-token/). +-} token : String -> MapboxAttr msg token = Encode.string >> property "token" >> MapboxAttr +{-| The element's Id. This should be unique. You will need this if you want to use the Mapbox.Cmd module. +-} id : String -> MapboxAttr msg id = attribute "id" >> MapboxAttr +{-| A longitude latitude pair (in that order). +-} type alias LngLat = ( Float, Float ) -{-| sw: lnglat, ne: lnglat +{-| If set, the map will be constrained to the given bounds. The bounds are the `(south-west corner, north-east corner)`. -} maxBounds : ( LngLat, LngLat ) -> MapboxAttr msg maxBounds = encodePair (encodePair Encode.float) >> property "maxBounds" >> MapboxAttr +{-| If true, multiple copies of the world will be rendered, when zoomed out. +-} renderWorldCopies : Bool -> MapboxAttr msg renderWorldCopies = Encode.bool >> property "renderWorldCopies" >> MapboxAttr @@ -80,27 +123,283 @@ encodePair encoder ( a, b ) = Encode.list [ encoder a, encoder b ] -encodePosition pos = - case pos of - TopLeft -> - Encode.string "top-left" +decodePair decoder = + Decode.list decoder + |> Decode.andThen + (\l -> + case l of + [ a, b ] -> + Decode.succeed ( a, b ) + + _ -> + Decode.fail "Doesn't apear to be a pair" + ) + + + +-- Events + + +{-| By default the `renderedFeatures` property in events will return +a lot of data. If you don't need it, you can provide a filter to filter that data. This will make things more performant. +-} +eventFeaturesFilter : Expression DataExpression Bool -> MapboxAttr msg +eventFeaturesFilter = + Mapbox.Expression.encode >> property "eventFeaturesFilter" >> MapboxAttr + + +{-| By default the `renderedFeatures` property in events will return +a 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. +-} +eventFeaturesLayers : List String -> MapboxAttr msg +eventFeaturesLayers = + List.map Encode.string >> Encode.list >> property "eventFeaturesLayers" >> MapboxAttr + + +{-| This allows you to use other events not provided by this libary. + +See <https://www.mapbox.com/mapbox-gl-js/api/#map.event> for all supported events. + +-} +onWithOptions : String -> Options -> Decoder msg -> MapboxAttr msg +onWithOptions type_ opts decoder = + Html.Events.onWithOptions type_ opts decoder |> MapboxAttr + + +{-| `point` is the coordinates in pixels in screen space. + +`lngLat` is the coordinates as a longitude, latitude in geographic space. + +`renderedFeatures` is a geojson that intersect the `lngLat`: + +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). + +Each 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. + +Features 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. + +The 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). + +Because 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. + +-} +type alias EventData = + { point : ( Int, Int ) + , lngLat : LngLat + , renderedFeatures : List Value + } + + +{-| `touches` will list stuff for every finger involved in a gesture. + +`center` refers to the point in the geometric center of `touches`. + +-} +type alias TouchEvent = + { touches : List EventData + , center : EventData + } + + +decodeLngLat = + Decode.map2 (,) (Decode.field "lng" Decode.float) (Decode.field "lat" Decode.float) + + +decodePoint = + Decode.map2 (,) (Decode.field "x" Decode.int) (Decode.field "y" Decode.int) + + +decodeEventData = + Decode.map3 EventData + (Decode.field "point" decodePoint) + (Decode.field "lngLat" decodeLngLat) + (Decode.field "features" (Decode.list Decode.value)) + + +decodeTouchEvent = + Decode.map2 TouchEvent + (Decode.map3 (List.map3 EventData) + (Decode.field "points" (Decode.list decodePoint)) + (Decode.field "lngLats" (Decode.list decodeLngLat)) + (Decode.field "perPointFeatures" (Decode.list (Decode.list Decode.value))) + ) + decodeEventData + + +{-| Fired when a pointing device (usually a mouse) is pressed within the map. +-} +onMouseDown : (EventData -> msg) -> MapboxAttr msg +onMouseDown tagger = + Html.Events.on "mousedown" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a pointing device (usually a mouse) is released within the map. +-} +onMouseUp : (EventData -> msg) -> MapboxAttr msg +onMouseUp tagger = + Html.Events.on "mouseup" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a pointing device (usually a mouse) is moved within the map. +-} +onMouseOver : (EventData -> msg) -> MapboxAttr msg +onMouseOver tagger = + Html.Events.on "mouseover" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a pointing device (usually a mouse) is moved within the map. +-} +onMouseMove : (EventData -> msg) -> MapboxAttr msg +onMouseMove tagger = + Html.Events.on "mousemove" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a pointing device (usually a mouse) is pressed and released at the same point on the map. +-} +onClick : (EventData -> msg) -> MapboxAttr msg +onClick tagger = + Html.Events.on "click" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a pointing device (usually a mouse) is clicked twice at the same point on the map. +-} +onDblClick : (EventData -> msg) -> MapboxAttr msg +onDblClick tagger = + Html.Events.on "dblclick" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a point device (usually a mouse) leaves the map's canvas. +-} +onMouseOut : (EventData -> msg) -> MapboxAttr msg +onMouseOut tagger = + Html.Events.on "mouseout" (Decode.map tagger decodeEventData) + |> MapboxAttr - BottomLeft -> - Encode.string "bottom-left" - TopRight -> - Encode.string "top-right" +{-| Fired when the right button of the mouse is clicked or the context menu key is pressed within the map. +-} +onContextMenu : (EventData -> msg) -> MapboxAttr msg +onContextMenu tagger = + Html.Events.on "contextmenu" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired repeatedly during an animated transition from one zoom level to another. +-} +onZoom : (EventData -> msg) -> MapboxAttr msg +onZoom tagger = + Html.Events.on "zoom" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired just before the map begins a transition from one zoom level to another. +-} +onZoomStart : (EventData -> msg) -> MapboxAttr msg +onZoomStart tagger = + Html.Events.on "zoomstart" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired just after the map completes a transition from one zoom level to another. +-} +onZoomEnd : (EventData -> msg) -> MapboxAttr msg +onZoomEnd tagger = + Html.Events.on "zoomend" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired repeatedly during a "drag to rotate" interaction. +-} +onRotate : (EventData -> msg) -> MapboxAttr msg +onRotate tagger = + Html.Events.on "rotate" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a "drag to rotate" interaction starts. +-} +onRotateStart : (EventData -> msg) -> MapboxAttr msg +onRotateStart tagger = + Html.Events.on "rotatestart" (Decode.map tagger decodeEventData) + |> MapboxAttr + + +{-| Fired when a "drag to rotate" interaction ends. +-} +onRotateEnd : (EventData -> msg) -> MapboxAttr msg +onRotateEnd tagger = + Html.Events.on "rotateend" (Decode.map tagger decodeEventData) + |> MapboxAttr - BottomRight -> - Encode.string "bottom-right" +{-| Fired when a touchend event occurs within the map. +-} +onTouchEnd : (TouchEvent -> msg) -> MapboxAttr msg +onTouchEnd tagger = + Html.Events.on "touchend" (Decode.map tagger decodeTouchEvent) + |> MapboxAttr + + +{-| Fired when a touchmove event occurs within the map. +-} +onTouchMove : (TouchEvent -> msg) -> MapboxAttr msg +onTouchMove tagger = + Html.Events.on "touchmove" (Decode.map tagger decodeTouchEvent) + |> MapboxAttr +{-| Fired when a touchcancel event occurs within the map. +-} +onTouchCancel : (TouchEvent -> msg) -> MapboxAttr msg +onTouchCancel tagger = + Html.Events.on "touchcancel" (Decode.map tagger decodeTouchEvent) + |> MapboxAttr + + + +-- encodePosition pos = +-- case pos of +-- TopLeft -> +-- Encode.string "top-left" +-- +-- BottomLeft -> +-- Encode.string "bottom-left" +-- +-- TopRight -> +-- Encode.string "top-right" +-- +-- BottomRight -> +-- Encode.string "bottom-right" --- Controlled mode -{-| Note: this property will only take effect when the map is created. +{-| -} +type alias Viewport = + { center : LngLat + , zoom : Float + , bearing : Float + , pitch : Float + } + + +{-| By default the map is "uncontrolled". By this we mean that it has its own internal state (namely the center, zoom level, pitch and bearing). This is nice if you don't care about these, but it does break some of the niceness of TEA. It also means some advanced interaction techniques are impossible to implement. For this reason we allow controlled mode where no event handlers are attached, but you need to feed the element its state. So it's up to you to implement all the user interactions. In the future, this library may help with that, but in the present this is not available. -} -controlled : MapboxAttr msg -controlled = - property "interactive" (Encode.bool False) |> MapboxAttr +controlledMap : Viewport -> List (MapboxAttr msg) -> Style -> Html msg +controlledMap { center, zoom, bearing, pitch } attrs style = + let + props = + property "mapboxStyle" (Mapbox.Style.encode style) + :: property "interactive" (Encode.bool False) + :: property "center" (encodePair Encode.float center) + :: property "zoom" (Encode.float zoom) + :: property "bearing" (Encode.float bearing) + :: property "pitch" (Encode.float pitch) + :: List.map (\(MapboxAttr attr) -> attr) attrs + in + node "elm-mapbox-map" props [] diff --git a/src/Mapbox/Style.elm b/src/Mapbox/Style.elm index 5d47e7e..c647814 100644 --- a/src/Mapbox/Style.elm +++ b/src/Mapbox/Style.elm @@ -1,8 +1,8 @@ -module Mapbox.Style exposing (Style, encode, Light, defaultLight, Transition, defaultTransition, MiscAttr, sprite, glyphs, name, defaultCenter, defaultZoomLevel, defaultBearing, defaultPitch, metadata) +module Mapbox.Style exposing (Style(..), StyleDef, encode, Light, defaultLight, Transition, defaultTransition, MiscAttr, sprite, glyphs, name, defaultCenter, defaultZoomLevel, defaultBearing, defaultPitch, metadata, streets, outdoors, light, dark, satellite, satelliteStreets) {-| 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. -@docs Style, encode +@docs Style, encode , StyleDef ### Light @@ -19,6 +19,13 @@ module Mapbox.Style exposing (Style, encode, Light, defaultLight, Transition, de @docs MiscAttr, sprite, glyphs, name, defaultCenter, defaultZoomLevel, defaultBearing, defaultPitch, metadata + +### Predefined styles + +You can also use one of these predefined styles. + +@docs streets, outdoors, light, dark, satellite, satelliteStreets + -} import Array exposing (Array) @@ -29,18 +36,71 @@ import Mapbox.Layer exposing (Layer) import Mapbox.Source exposing (Source) +{-| A mapbox style. + +You can either create a style spec in Elm (for which the rest of this library is useful :) or load one from a remote URL. + +To 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. + +-} +type Style + = Style StyleDef + | FromUrl String + + +{-| -} +streets : Style +streets = + FromUrl "mapbox://styles/mapbox/streets-v10" + + +{-| -} +outdoors : Style +outdoors = + FromUrl "mapbox://styles/mapbox/outdoors-v10" + + +{-| -} +light : Style +light = + FromUrl "mapbox://styles/mapbox/light-v9" + + +{-| -} +dark : Style +dark = + FromUrl "mapbox://styles/mapbox/dark-v9" + + +{-| -} +satellite : Style +satellite = + FromUrl "mapbox://styles/mapbox/satellite-v9" + + +{-| -} +satelliteStreets : Style +satelliteStreets = + FromUrl "mapbox://styles/mapbox/satellite-streets-v10" + + {-| Encodes the style into JSON. -} encode : Style -> Value encode style = - [ ( "version", Encode.int 8 ) - , ( "transition", encodeTransition style.transition ) - , ( "light", encodeLight style.light ) - , ( "sources", Encode.object <| List.map (\source -> ( Mapbox.Source.getId source, Mapbox.Source.encode source )) style.sources ) - , ( "layers", Encode.list (List.map Mapbox.Layer.encode style.layers) ) - ] - ++ List.map (\(MiscAttr key value) -> ( key, value )) style.misc - |> Encode.object + case style of + Style styleDef -> + [ ( "version", Encode.int 8 ) + , ( "transition", encodeTransition styleDef.transition ) + , ( "light", encodeLight styleDef.light ) + , ( "sources", Encode.object <| List.map (\source -> ( Mapbox.Source.getId source, Mapbox.Source.encode source )) styleDef.sources ) + , ( "layers", Encode.list (List.map Mapbox.Layer.encode styleDef.layers) ) + ] + ++ List.map (\(MiscAttr key value) -> ( key, value )) styleDef.misc + |> Encode.object + + FromUrl s -> + Encode.string s encodeTransition : Transition -> Value @@ -78,7 +138,7 @@ These are all optional attributes. All the other keys are values defined below. -} -type alias Style = +type alias StyleDef = { transition : Transition , light : Light , layers : List Layer diff --git a/src/js/main.js b/src/js/main.js index c2b3120..4f561fc 100644 --- a/src/js/main.js +++ b/src/js/main.js @@ -9,6 +9,8 @@ function wrapElmApplication(elmApp) { this._refreshExpiredTiles = true; this._renderWorldCopies = true; this.interactive = true; + this._eventRegistrationQueue = {}; + this._eventListenerMap = new Map(); } get mapboxStyle() { @@ -55,12 +57,115 @@ function wrapElmApplication(elmApp) { this._renderWorldCopies = value; } - connectedCallback() { - mapboxgl.accessToken = this.token; - this.style.display = "block"; - this.style.width = "100%"; - this.style.height = "100%"; - this._map = new mapboxgl.Map({ + get center() { + return this._center; + } + set center(value) { + if (this._map) this._map.setCenter(value); + this._center = value; + } + + get zoom() { + return this._zoom; + } + set zoom(value) { + if (this._map) this._map.setZoom(value); + this._zoom = value; + } + + get bearing() { + return this._bearing; + } + set bearing(value) { + if (this._map) this._map.setBearing(value); + this._bearing = value; + } + + get pitch() { + return this._pitch; + } + set pitch(value) { + if (this._map) this._map.setPitch(value); + this._pitch = value; + } + + addEventListener(type, fn, ...args) { + if (this._map) { + var wrapped; + if ( + [ + "mousedown", + "mouseup", + "mouseover", + "mousemove", + "click", + "dblclick", + "mouseout", + "contextmenu", + "zoom", + "zoomstart", + "zoomend", + "rotate", + "rotatestart", + "rotateend" + ].includes(type) + ) { + wrapped = e => { + e.features = this._map.queryRenderedFeatures( + [e.lngLat.lng, e.lngLat.lat], + { + layers: this.eventFeaturesLayers, + filter: this.eventFeaturesFilter + } + ); + return fn(e); + }; + } else if (["touchend", "touchmove", "touchcancel"].includes(type)) { + wrapped = e => { + e.features = this._map.queryRenderedFeatures( + [e.lngLat.lng, e.lngLat.lat], + { + layers: this.eventFeaturesLayers, + filter: this.eventFeaturesFilter + } + ); + e.perPointFeatures = e.lngLats.map(({ lng, lat }) => + this._map.queryRenderedFeatures([lng, lat], { + layers: this.eventFeaturesLayers, + filter: this.eventFeaturesFilter + }) + ); + return fn(e); + }; + } else { + wrapped = fn; + } + this._eventListenerMap.set(fn, wrapped); + return this._map.on(type, wrapped); + } else { + this._eventRegistrationQueue[type] = + this._eventRegistrationQueue[type] || []; + return this._eventRegistrationQueue[type].push(fn); + } + } + + removeEventListener(type, fn, ...args) { + if (this._map) { + const wrapped = this._eventListenerMap.get(fn); + this._eventListenerMap.delete(fn); + return this._map.off(type, wrapped); + } else { + const queue = this._eventRegistrationQueue[type] || []; + const index = queue.findIndex(fn); + if (index >= 0) { + queue.splice(index, 1); + } + return; + } + } + + _createMapInstance() { + let options = { container: this, style: this._style, minZoom: this._minZoom || 0, @@ -70,14 +175,39 @@ function wrapElmApplication(elmApp) { logoPosition: this.logoPosition || "bottom-left", refreshExpiredTiles: this._refreshExpiredTiles, maxBounds: this._maxBounds, - center: this.center, - // zoom: this.zoom, - // bearing: this.bearing, - // pitch: this.pitch, renderWorldCopies: this._renderWorldCopies - // maxTileCacheSize: this._maxTileCacheSize, - // localIdeographFamily: this._localIdeographFamily - }); + }; + if (this._center) { + options.center = this._center; + } + if (this._zoom) { + options.zoom = this._zoom; + } + if (this._bearing) { + options.bearing = this._bearing; + } + if (this._pitch) { + options.pitch = this._pitch; + } + this._map = new mapboxgl.Map(options); + + Object.entries(this._eventRegistrationQueue).forEach( + ([type, listeners]) => { + listeners.forEach(listener => { + this.addEventListener(type, listener); + }); + } + ); + this._eventRegistrationQueue = {}; + return this._map; + } + + connectedCallback() { + mapboxgl.accessToken = this.token; + this.style.display = "block"; + this.style.width = "100%"; + this.style.height = "100%"; + this._map = this._createMapInstance(); } disconnectedCallback() { |