Leaflet

class Evented t e h a | t -> e, t -> h where

Members

• on :: forall eff. t -> a -> (e -> Eff (leaflet :: LEAFLET | eff) Unit) -> Eff (leaflet :: LEAFLET | eff) h
• off :: forall eff. t -> a -> h -> Eff (leaflet :: LEAFLET | eff) Unit

type Longitude = Number

Geographic longitude

type Latitude = Number

Geographic latitude

data LatLngBounds :: Type

Bounding rectangle in geo coordinate space.

data LatLng :: Type

Latitude / longitude pair. Leaflet.js accepts these in various flavors, but we only expose this one type.

Instances

• Eq LatLng

lng :: LatLng -> Longitude

Extract the longitude from a LatLng

latlng :: Latitude -> Longitude -> LatLng

Construct a LatLng record from separate components

latLngBounds :: LatLng -> LatLng -> LatLngBounds

Construct a LatLngBounds from two corners

lat :: LatLng -> Latitude

Extract the latitude from a LatLng

data Layer :: Type

A map layer

Instances

• IsLayer Layer

class IsLayer a  where

Members

• toLayer :: a -> Layer

Instances

• IsLayer Layer

data Map :: Type

A map object (http://leafletjs.com/reference-1.0.3.html#map-example)

Instances

• Evented MouseEventType MouseEvent MouseEventHandle Map

setView :: forall e. Map -> LatLng -> Zoom -> Eff (leaflet :: LEAFLET | e) Unit

Set the current view for a map.

removeLayer :: forall e. Layer -> Map -> Eff (leaflet :: LEAFLET | e) Unit

Remove a layer from a map

onZoom :: forall e. Map -> e Unit -> e Unit

Subscribe to the zoom event, which fires when the map's zoom level changes.

onMove :: forall e. Map -> (LatLng -> e Unit) -> e Unit

Subscribe to the move event.

map :: forall e. String -> LatLng -> Zoom -> Eff (leaflet :: LEAFLET | e) Map

map domID latLng zoom creates a new map object centered at latLng, at zoom level zoom, and attaches it to the DOM element with ID domID.

invalidateSize :: forall e. Map -> Eff (leaflet :: LEAFLET | e) Unit

Tell a map that the size of its container may have changed, causing it to

getZoom :: forall e. Map -> Eff (leaflet :: LEAFLET | e) Zoom

Get the current zoom level.

getCenter :: forall e. Map -> Eff (leaflet :: LEAFLET | e) LatLng

Get the geographic position at which the map is currently centered.

addLayer :: forall e. Layer -> Map -> Eff (leaflet :: LEAFLET | e) Unit

Add a layer to a map

data Marker :: Type

Instances

• IsLayer Marker
• Evented MouseEventType MouseEvent MouseEventHandle Marker

marker :: forall e. LatLng -> Array Option -> Eff (leaflet :: LEAFLET | e) Marker

marker position options creates a new marker at the specified geographic coordinates.

data MouseEventType

Constructors

• MouseMove
• MouseOver
• MouseOut
• MouseUp
• MouseDown
• Click
• DblClick

data MouseEventHandle :: Type

newtype MouseEvent

Metadata for a mouse event.

Constructors

• MouseEvent { containerPoint :: Point, latlng :: LatLng, layerPoint :: Point }

Instances

• Newtype MouseEvent _

type UrlTemplate = String

A URL template for tile layers.

tileLayer :: forall e. UrlTemplate -> Array Option -> Eff (leaflet :: LEAFLET | e) Layer

tileLayer template options creates a new tile layer using the URL template template to generate tile URLS.

The template can use the following variables, written between curly braces:

• {z}: zoom level
• {x}, {y}: the tile coordinates (after projection), from the range [0..(2 ^ z))
• {s}: subdomain

Example: "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"

type Zoom = Int

A zoom level. Zoom levels start at 0 (which means "show the whole world") and zoom in exponentially, each step corresponding to a factor of 2.

type Point = { x :: Pixels, y :: Pixels }

A point in 2D screen space.

type Pixels = Number

A distance in screen space, measured in logical pixels ("CSS Pixels").

data LEAFLET :: Effect

Anything that uses Leaflet has a LEAFLET effect.