Module

Leaflet

Package
purescript-leaflet-tdammers
Repository
tdammers/purescript-leaflet-tdammers

#LEAFLET Source

data LEAFLET :: Effect

Anything that uses Leaflet has a LEAFLET effect.

#Layer Source

data Layer :: Type

A map layer

#Latitude Source

type Latitude = Number

Geographic latitude

#Longitude Source

type Longitude = Number

Geographic longitude

#LatLng Source

type LatLng = { lat :: Latitude, lng :: Longitude }

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

#latlng Source

latlng :: Latitude -> Longitude -> LatLng

Construct a LatLng record from separate components

#lat Source

lat :: LatLng -> Latitude

Extract the latitude from a LatLng

#lng Source

lng :: LatLng -> Longitude

Extract the longitude from a LatLng

#Zoom Source

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.

#Pixels Source

type Pixels = Number

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

#Point Source

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

A point in 2D screen space.

#MouseEvent Source

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

Metadata for a mouse event.

#UrlTemplate Source

type UrlTemplate = String

A URL template for tile layers.

#map Source

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.

#tileLayer Source

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

tileLayer template 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"

#addLayer Source

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

Add a layer to a map

#setView Source

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

Set the current view for a map.

#invalidateSize Source

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

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

#getCenter Source

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

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

#getZoom Source

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

Get the current zoom level.

#onZoom Source

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

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

#onMove Source

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

Subscribe to the move event.

#onMouseMove Source

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

Subscribe to the mousemove event

#onMouseOver Source

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

Subscribe to the mouseover event

#onMouseOut Source

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

Subscribe to the mouseout event

#onMouseUp Source

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

Subscribe to the mouseup event (mouse button pressed)

#onMouseDown Source

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

Subscribe to the mousedown event (mouse button released)

#onClick Source

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

Subscribe to the click event

#onDblClick Source

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

Subscribe to the dblclick event (double click)

Modules
Leaflet