Leaflet

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.

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

type MouseEvent = { containerPoint :: Point, latlng :: LatLng, layerPoint :: Point }

Metadata for a mouse event.

data Map :: Type

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

data Layer :: Type

A map layer

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

Set the current view for 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.

onMouseUp :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the mouseup event (mouse button pressed)

onMouseOver :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the mouseover event

onMouseOut :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the mouseout event

onMouseMove :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the mousemove event

onMouseEvent :: forall e. String -> Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to a mouse even by name.

onMouseDown :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the mousedown event (mouse button released)

onDblClick :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the dblclick event (double click)

onClick :: forall e. Map -> (MouseEvent -> e Unit) -> e Unit

Subscribe to the click 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

type UrlTemplate = String

A URL template for tile layers.

data TileLayerOption

Options to be passed to a tile layer at construction time. See http://leafletjs.com/reference-1.0.3.html#tilelayer for an explanation of each option.

Constructors

• TileLayerMinZoom Int
• TileLayerMaxZoom Int
• TileLayerMinNativeZoom (Maybe Int)
• TileLayerMaxNativeZoom (Maybe Int)
• TileLayerSubdomains (Array String)
• TileLayerErrorTileUrl String
• TileLayerZoomOffset Int
• TileLayerTMS Boolean
• TileLayerZoomReverse Boolean
• TileLayerDetectRetina Boolean
• TileLayerCrossOrigin Boolean
• TileLayerTileSize Int
• TileLayerOpacity Number
• TileLayerUpdateWhenIdle Boolean
• TileLayerUpdateWhenZooming Boolean
• TileLayerUpdateInterval Number
• TileLayerZIndex Int
• TileLayerBounds LatLngBounds
• TileLayerNoWrap Boolean
• TileLayerPane String
• TileLayerClassName String
• TileLayerKeepBuffer Int
• TileLayerAttribution String

Instances

• IsOption TileLayerOption

tileLayer :: forall e. UrlTemplate -> Array TileLayerOption -> 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.