Package ‘leaflet.extras’ April 21, 2018 Type Package Title Extra Functionality for 'leaflet' Package Version 1.0.0 Description The 'leaflet' JavaScript library provides many plugins some of which are available in the core 'leaflet' package, but there are many more. It is not possible to support them all in the core 'leaflet' package. This package serves as an add-on to the 'leaflet' package by providing extra functionality via 'leaflet' plugins. License GPL-3 | file LICENSE Encoding UTF-8 LazyData true Depends R (>= 3.1.0), leaflet (>= 2.0.0) Imports htmlwidgets, htmltools, stringr, magrittr Suggests jsonlite, readr URL https://github.com/bhaskarvk/leaflet.extras, https://bhaskarvk.github.io/leaflet.extras/ BugReports https://github.com/bhaskarvk/leaflet.extras/issues RoxygenNote 6.0.1 NeedsCompilation no Author Bhaskar Karambelkar [aut, cre], Barret Schloerke [aut], Bangyou Zheng [ctb] (Leaflet-search and Leaflet-GPS plugin integration), Robin Cura [ctb] (Fixes for Draw Options), Markus Voge [ctb] (Enhancements for Draw Options), Markus Dumke [ctb] (Bounce Marker addition), Mapbox [ctb, cph] (leaflet-omnivore, csv2geojson, and togeojson libraries), Henry Thasler [ctb, cph] (Leaflet.Geodesic library), Dennis Wilhelm [ctb, cph] (Leaflet.StyleEditor library), Kirollos Risk [ctb, cph] (fuse.js library), Tim Wisniewski [ctb, cph] (leaflet-choropleth library), 1
42
Embed
Package ‘leaflet.extras’€¦ · 2 R topics documented: Leaflet [ctb, cph] (leaflet-draw library), Alexander Milevski [ctb, cph] (leaflet-draw-drag library), John Firebaugh
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Package ‘leaflet.extras’April 21, 2018
Type Package
Title Extra Functionality for 'leaflet' Package
Version 1.0.0
Description The 'leaflet' JavaScript library provides many plugins some of whichare available in the core 'leaflet' package, but there are many more. It is notpossible to support them all in the core 'leaflet' package. This package servesas an add-on to the 'leaflet' package by providing extra functionality via 'leaflet'plugins.
targetLayerId An optional layerId of a GeoJSON/TopoJSON layer whose features need to beeditable. Used for adding a GeoJSON/TopoJSON layer and then editing thefeatures using the draw plugin.
targetGroup An optional group name of a Feature Group whose features need to be editable.Used for adding shapes(markers, lines, polygons) and then editing them usingthe draw plugin. You can either set layerId or group or none but not both.
position The position where the toolbar should appear.polylineOptions
See drawPolylineOptions(). Set to FALSE to disable polyline drawing.
polygonOptions See drawPolygonOptions(). Set to FALSE to disable polygon drawing.
circleOptions See drawCircleOptions(). Set to FALSE to disable circle drawing.rectangleOptions
See drawRectangleOptions(). Set to FALSE to disable rectangle drawing.
markerOptions See drawMarkerOptions(). Set to FALSE to disable marker drawing.
6 addFullscreenControl
circleMarkerOptions
See drawCircleMarkerOptions(). Set to FALSE to disable circle marker draw-ing.
editOptions By default editing is disable. To enable editing pass editToolbarOptions().
singleFeature When set to TRUE, only one feature can be drawn at a time, the previous onesbeing removed.
clearFeatures whether to clear the map of drawn features.
geojson a GeoJSON/TopoJSON URL or file contents in a character vector.
layerId the layer id
group the name of the group this raster image should belong to (see the same parameterunder addTiles)
addGeoJSONv2 11
markerType The type of marker. either "marker" or "circleMarker"
markerIcons Icons for Marker. Can be a single marker using makeIcon or a list of markersusing iconList
markerIconProperty
The property of the feature to use for marker icon. Can be a JS function whichaccepts a feature and returns an index of markerIcons. In either case the resultmust be one of the indexes of markerIcons.
markerOptions The options for markers
clusterOptions if not NULL, markers will be clustered using Leaflet.markercluster; you can usemarkerClusterOptions() to specify marker cluster options
clusterId the id for the marker cluster layer
labelProperty The property to use for the label. You can also pass in a JS function that takesin a feature and returns a text/HTML content.
labelOptions A Vector of labelOptions to provide label
popupProperty The property to use for popup content You can also pass in a JS function thattakes in a feature and returns a text/HTML content.
popupOptions A Vector of popupOptions to provide popups
stroke whether to draw stroke along the path (e.g. the borders of polygons or circles)
color stroke color
weight stroke width in pixels
opacity stroke opacity (or layer opacity for tile layers)
fill whether to fill the path with color (e.g. filling on polygons or circles)
fillColor fill color
fillOpacity fill opacity
dashArray a string that defines the stroke dash pattern
smoothFactor how much to simplify the polyline on each zoom level (more means better per-formance and less accurate representation)
noClip whether to disable polyline clipping
pathOptions Options for shapeshighlightOptions
Options for highlighting the shape on mouse over. options for each label. De-fault NULL you can use highlightOptions() to specify highlight options
title An optional title for the legend
position legend position
locale The numbers will be formatted using this localenumberFormatOptions
lng a numeric vector of longitudes, or a one-sided formula of the form ~x where x isa variable in data; by default (if not explicitly provided), it will be automaticallyinferred from data by looking for a column named lng, long, or longitude(case-insensitively)
lat a vector of latitudes or a formula (similar to the lng argument; the names latand latitude are used when guessing the latitude column from data)
intensity intensity of the heat. A vector of numeric values or a formula.
layerId the layer id
group the name of the group the newly created layers should belong to (for clearGroupand addLayersControl purposes). Human-friendly group names are permitted–they need not be short, identifier-style names. Any number of layers and evendifferent types of layers (e.g. markers and polygons) can share the same groupname.
minOpacity minimum opacity at which the heat will start
max maximum point intensity. The default is 1.0
radius radius of each "point" of the heatmap. The default is 25.
blur amount of blur to apply. The default is 15. blur=1 means no blur.
gradient palette name from RColorBrewer or an array of of colors to be provided tocolorNumeric, or a color mapping function returned from colorNumeric
cellSize the cell size in the grid. Points which are closer than this may be merged. De-faults to ‘radius / 2‘.s Set to ‘1‘ to do almost no merging.
data the data object from which the argument values are derived; by default, it is thedata object provided to leaflet() initially, but can be overridden
geojson The geojson or topojson url or contents as string.intensityProperty
The property to use for determining the intensity at a point. Can be a "string" ora JS function, or NULL.
kml The KML url or contents as string.
csv The CSV url or contents as string.csvParserOptions
options for parsing the CSV. Use csvParserOptions() to supply csv parser op-tions.
Boolean. If TRUE displays a Marker on the searched location’s coordinates.
showBounds Boolean. If TRUE show the bounding box of the found feature.
showFeature Boolean. If TRUE show the found feature. Depending upon the feature foundthis can be a marker, a line or a polygon.
fitBounds Boolean. If TRUE set maps bounds to queried and found location. For this to beeffective one of showSearchLocation, showBounds, showFeature shoule alsobe TRUE.
displayText Boolean. If TRUE show a text box with found location’s name on the map.
group String. An optional group to hold all the searched locations and their results.
apikey String. API Key for Google GeoCoding Service.
lng a numeric vector of longitudes, or a one-sided formula of the form ~x where x isa variable in data; by default (if not explicitly provided), it will be automaticallyinferred from data by looking for a column named lng, long, or longitude(case-insensitively)
lat a vector of latitudes or a formula (similar to the lng argument; the names latand latitude are used when guessing the latitude column from data)
intensity intensity of the heat. A vector of numeric values or a formula.
layerId the layer id
group the name of the group the newly created layers should belong to (for clearGroupand addLayersControl purposes). Human-friendly group names are permitted–they need not be short, identifier-style names. Any number of layers and evendifferent types of layers (e.g. markers and polygons) can share the same groupname.
size in meters or pixels
units either "m" or "px"
opacity for the canvas elementgradientTexture
Alternative colors for heatmap. allowed values are "skyline", "deep-sea"
alphaRange adjust transparency by changing to value between 0 and 1
data the data object from which the argument values are derived; by default, it is thedata object provided to leaflet() initially, but can be overridden
geojson The geojson or topojson url or contents as string.intensityProperty
The property to use for determining the intensity at a point. Can be a "string" ora JS function, or NULL.
kml The KML url or contents as string.
csv The CSV url or contents as string.csvParserOptions
options for parsing the CSV. Use csvParserOptions() to supply csv parser op-tions.
gpx The GPX url or contents as string.
24 addWebGLHeatmap
Examples
## addWebGLHeatmapleaflet(quakes) %>%
addProviderTiles(providers$CartoDB.DarkMatter) %>%addWebGLHeatmap(lng = ~long, lat = ~lat, size = 60000)
## for more examples see# browseURL(system.file("examples/webglHeatmaps.R", package = "leaflet.extras"))## addWebGLGeoJSONHeatmapgeoJson <- readr::read_file(
stroke Whether to draw stroke along the path. Set it to false to disable borders onpolygons or circles.
color Stroke color.
weight Stroke width in pixels.
opacity Stroke opacity.
fill Whether to fill the path with color. Set it to false to disable filling on polygonsor circles.
fillColor same as color Fill color.
fillOpacity Fill opacity.
dashArray A string that defines the stroke dash pattern. Doesn’t work on canvas-poweredlayers (e.g. Android 2).
lineCap A string that defines shape to be used at the end of the stroke.
lineJoin A string that defines shape to be used at the corners of the stroke.
clickable If false, the vector will not emit mouse events and will act as a part of the under-lying map.
pointerEvents Sets the pointer-events attribute on the path if SVG backend is used.
smoothFactor How much to simplify the polyline on each zoom level. More means betterperformance and smoother look, and less means more accurate representation.
Enables caching of tiles locally in browser. See https://github.com/MazeMap/Leaflet.TileLayer.PouchDBCached for details. In addition to invoking this function, you should also pass useCache=TRUE& crossOrigin=TRUE in the tileOptions call and pass that to your addTiles’s options param-eter.
## for more examples see# browseURL(system.file("examples/TileLayer-Caching.R", package = "leaflet.extras"))
gpsOptions Options for the GPS Control
Description
Options for the GPS ControlAdd a gps to the Map.Removes the GPS ControlActivate the GPS Control. You should have already added the GPS control before calling thismethod.Deactivate the GPS Control. You should have already added the GPS control before calling thismethod.
position Position of the Controlactivate If TRUE activates the GPS on addition.autoCenter If TRUE auto centers the map when GPS location changesmaxZoom If set zooms to this level when auto centeringsetView If TRUE sets the view to the GPS location when foundmap a map widget objectoptions Options for the GPS control.
32 leafletExtrasDependencies
Examples
leaflet() %>%addTiles() %>%addControlGPS()
leaflet.extras leaflet.extras: Extra Functionality for ’leaflet’ Package.
Description
Description: The ’leaflet’ JavaScript library provides many plugins some of which are available inthe core ’leaflet’ package, but there are many more. It is not possible to support them all in thecore ’leaflet’ package. This package serves as an add-on to the ’leaflet’ package by providing extrafunctionality via ’leaflet’ plugins.
leafletExtrasDependencies
Various leaflet dependency functions for use in downstream packages
Description
Various leaflet dependency functions for use in downstream packages
Usage
leafletExtrasDependencies
Format
An object of class list of length 5.
propsToHTML 33
propsToHTML Converts GeoJSON Feature properties to HTML
Description
Converts GeoJSON Feature properties to HTML
Converts GeoJSON Feature properties to HTML Table.
An icon can be represented as a list of the form list(color, iconSize,...). This function isvectorized over its arguments to create a list of icon data. Shorter argument values will be re-cycled.NULL values for these arguments will be ignored.
Add Pulse Markers
Usage
pulseIconList(...)
## S3 method for class 'leaflet_pulse_icon_set'x[i]
animate To animate the icon or not, defaults to TRUE.
heartbeat Interval between each pulse in seconds.
map the map to add pulse Markers to.
lng a numeric vector of longitudes, or a one-sided formula of the form ~x where x isa variable in data; by default (if not explicitly provided), it will be automaticallyinferred from data by looking for a column named lng, long, or longitude(case-insensitively)
lat a vector of latitudes or a formula (similar to the lng argument; the names latand latitude are used when guessing the latitude column from data)
layerId the layer id
group the name of the group the newly created layers should belong to (for clearGroupand addLayersControl purposes). Human-friendly group names are permitted–they need not be short, identifier-style names. Any number of layers and evendifferent types of layers (e.g. markers and polygons) can share the same groupname.
icon the icon(s) for markers;
popup a character vector of the HTML content for the popups (you are recommendedto escape the text using htmlEscape() for security reasons)
popupOptions options for popup
label a character vector of the HTML content for the labels
labelOptions A Vector of labelOptions to provide label options for each label. Default NULL
options a list of extra options for tile layers, popups, paths (circles, rectangles, polygons,...), or other map elements
clusterOptions if not NULL, markers will be clustered using Leaflet.markercluster; you can usemarkerClusterOptions() to specify marker cluster options
clusterId the id for the marker cluster layer
data the data object from which the argument values are derived; by default, it is thedata object provided to leaflet() initially, but can be overridden
url url for search by ajax request, ex: "search.php?q=s". Can be function that returnsstring for dynamic parameter setting.
sourceData function that fill _recordsCache, passed searching text by first param and call-back in second.
jsonpParam jsonp param name for search by jsonp service, ex: "callback".
propertyLoc field for remapping location, using array: ["latname","lonname"] for select dou-ble fields(ex. ["lat","lon"] ) support dotted format: "prop.subprop.title".
propertyName property in marker.options(or feature.properties for vector layer) trough filterelements in layer,.
formatData callback for reformat all data from source to indexed data object.
filterData callback for filtering data from text searched, params: textSearch, allRecords.
moveToLocation whether to move to the found location.
zoom zoom to this level when moving to location
suspendScroll 37
buildTip function that return row tip html node(or html string), receive text tooltip in firstparam.
container container id to insert Search Control.
minLength minimal text length for autocomplete.
initial search elements only by initial text.
casesensitive search elements in case sensitive text.
autoType complete input with first suggested result and select this filled-in text..
delayType delay while typing for show tooltip.
tooltipLimit limit max results to show in tooltip. -1 for no limit..
tipAutoSubmit auto map panTo when click on tooltip.
firstTipSubmit auto select first result con enter click.
autoResize autoresize on input change.
collapsed collapse search control at startup.
autoCollapse collapse search control after submit(on button or on tips if enabled tipAutoSub-mit).
autoCollapseTime
delay for autoclosing alert and collapse after blur.
textErr ’Location not error message.
textCancel title in cancel button.textPlaceholder
placeholder value.
position "topleft".hideMarkerOnCollapse
remove circle and marker on search control collapsed.
openPopup whether to open the popup associated with the feature when the feature is searchedfor
... Other options to pass to searchOptions() function.
suspendScroll Prevents accidental map scrolling when scrolling in a document.
Description
Prevents accidental map scrolling when scrolling in a document.
An icon can be represented as a list of the form list(icon, markerColor,...). This function isvectorized over its arguments to create a list of icon data. Shorter argument values will be re-cycled.NULL values for these arguments will be ignored.
Add Weather Markers
Usage
weatherIconList(...)
## S3 method for class 'leaflet_weather_icon_set'x[i]
icon the weather icon name w/o the "wi-" prefix. For a full list see https://erikflowers.github.io/weather-icons/
markerColor color of the marker
iconColor color of the weather icon
extraClasses Character vector of extra classes.
map the map to add weather Markers to.
lng a numeric vector of longitudes, or a one-sided formula of the form ~x where x isa variable in data; by default (if not explicitly provided), it will be automaticallyinferred from data by looking for a column named lng, long, or longitude(case-insensitively)
lat a vector of latitudes or a formula (similar to the lng argument; the names latand latitude are used when guessing the latitude column from data)
layerId the layer id
group the name of the group the newly created layers should belong to (for clearGroupand addLayersControl purposes). Human-friendly group names are permitted–they need not be short, identifier-style names. Any number of layers and evendifferent types of layers (e.g. markers and polygons) can share the same groupname.
popup a character vector of the HTML content for the popups (you are recommendedto escape the text using htmlEscape() for security reasons)
popupOptions options for popup
label a character vector of the HTML content for the labels
labelOptions A Vector of labelOptions to provide label options for each label. Default NULL
options a list of extra options for tile layers, popups, paths (circles, rectangles, polygons,...), or other map elements
clusterOptions if not NULL, markers will be clustered using Leaflet.markercluster; you can usemarkerClusterOptions() to specify marker cluster options
clusterId the id for the marker cluster layer
data the data object from which the argument values are derived; by default, it is thedata object provided to leaflet() initially, but can be overridden