Global options for the mapview package — mapviewOptions (2024)

Source: R/options.R

mapviewOptions.Rd

Arguments

platform

character. The rendering platform to be used.Current options are "leaflet", "mapdeck", and "leafgl".

basemaps

character. The basemaps to be used for rendering data. Seehttps://leaflet-extras.github.io/leaflet-providers/preview/ for possiblevalues

basemaps.color.shuffle

logical. Should basemaps order be changed toenhance contrast based on layer coloring. Set to FALSE if you supply custombasemaps or want to ensure that "CartoDB.Positron" is always the default.

raster.palette

a color palette function for raster visualisation.Should be a function that takes an integer as input and returns a vector of colors.See colorRampPalette for details.

vector.palette

a color palette function for vector visualisation.Should be a function that takes an integer as input and returns a vector of colors.See colorRampPalette for details.

verbose

logical. Many functions in mapview provide details about theirbehaviour. Set this to TRUE if you want to see these printed to the console.

na.color

character. The default color to be used for NA values.

See Also

fgb_sage — fgb_sage 0.2.2 documentationGröbner Basis-Attacking a Tiny Sponge – AS Discrete MathematicsBoolean functions - Cryptography

legend

logical. Whether or not to show a legend for the layer(s).

legend.opacity

opacity of the legend.

legend.pos

Where should the legend be placed?One of "topleft", "topright", "bottomleft", "bottomright".

layers.control.pos

character. Where should the layer control beplaced? One of "topleft", "topright", "bottomleft", "bottomright".

leafletWidth, leafletHeight

height and width of the htmlwidget in px.

viewer.suppress

whether to render the map in the browser (TRUE)or the RStudio viewer (FALSE).

homebutton

logical, whether to add a zoom-to-layer button to the map.

homebutton.pos

character. Where should the homebutton(s) beplaced? One of "topleft", "topright", "bottomleft", "bottomright".

native.crs

logical whether to reproject to web map coordinatereference system (web mercator - epsg:3857) or render using native CRS ofthe supplied data (can also be NA). Default is FALSE which will render inweb mercator. If set to TRUE now background maps will be drawn (but renderingmay be much quicker as no reprojecting is necessary).

raster.size

numeric. see the maxBytes argument in addRasterImage

mapview.maxpixels

numeric. The maximum amount of pixels allowed for Raster*objects to be rendered with mapview. Defaults to 500000.Set this higher if you have a potent machine or are patient enough to wait a little.

plainview.maxpixels

numeric. The maximum amount of pixels allowed for Raster*objects to be rendered with plainview. Defaults to 10000000.Set this higher if you have a potent machine or are patient enough to wait a little.

use.layer.names

whether to use layer names when plotting raster layers.

trim

should the raster be trimmed in case there are NAs on the edges.

method

for raster data only (raster/stars). Method used to computevalues for the resampled layer that is passed on to leaflet. mapview doesprojection on-the-fly to ensure correct display and therefore needs to knowhow to do this projection. The default is 'bilinear' (bilinear interpolation),which is appropriate for continuous variables. The other option, 'ngb'(nearest neighbor), is useful for categorical variables. Ignored if the rasterlayer is of class factor in which case "ngb" is used.

query.type

for raster methods only. Whether to show raster value queryon 'mousemove' or 'click'. Ignored if label = FALSE.

query.digits

for raster methods only. The amount of digits to be shownby raster value query. Ignored if label = FALSE.

query.position

for raster methods only. The position of the rastervalue query info box. See position argument of addLegendfor possible values. Ignored if label = FALSE.

query.prefix

for raster methods only. a character string to be shownas prefix for the layerId. Ignored if label = FALSE.

maxpoints

numeric. Maximum number of points allowed for leaflet overlayrendering. If this number is exceeded rendering will be doneusing special functionality which will provide much more speed and better handling.This means that standard functionality is reduced.For example adding layers via "+" is not possible anymore.

maxpolygons

numeric. Maximum number of polygons allowed for leaflet overlayrendering. If this number is exceeded rendering will be doneusing special functionality which will provide much more speed and better handling.This means that standard functionality is reduced.For example adding layers via "+" is not possible anymore.

maxlines

numeric. Maximum number of lines allowed for leaflet overlayrendering. If this number is exceeded rendering will be doneusing special functionality which will provide much more speed and better handling.This means that standard functionality is reduced.For example adding layers via "+" is not possible anymore.

pane

name of the map pane in which to render features. SeeaddMapPane for details. Currently only supported for vector layers.Ignored if canvas = TRUE. The default "auto" will create different panesfor points, lines and polygons such that points overlay lines overlay polygons.Set to NULL to get default leaflet behaviour where allfeaturesare rendered in the same pane and layer order is determined automatically/sequentially.

cex

numeric or attribute name(s) or column number(s) in attribute tableof the column(s) to be used for defining the size of circles.

alpha

opacity of lines.

default

logical. If TRUE all options are set to their default values

console

logical. Should the options be printed to the console

watch

whether to watch a certain environment and automaticallyrender changes to the list of spatial data in that environment. SeemapviewWatcher for details.

fgb

if set to TRUE mapview will not use 'clasical' leaflet/htmlwidgetsrendering (which embeds data directly in the html) but leverage the speed ofa file format called flatgeobuf (hence, fgb). This has the added benefit thatdata is being streamed onto the map, which makes for a pleasant user experience.It should also help to visualise larger data sets due to a reduced memeory footprint.A note of warning, data will be attached to the htmlvia a <src=...> call which means that the html is not selfcontained anymore(so it cannot be used without an accompanying folder).

georaster

whether to use addGeoRaster instead ofaddRasterImage. If set to TRUE raster image visualisation will be more performant for large raster data, but given the nearest neighbor resampling results may be slightly distorted.

param

character. parameter(s) to be queried.

Value

list of the current options (invisibly).If no arguments are provided the options are printed.

Functions

• mapviewGetOption(): query mapviewOptions parameters.

See also

Author

Tim Appelhans

Examples

mapviewOptions()#> #> global options: #> #> platform : leaflet #> basemaps : CartoDB.Positron CartoDB.DarkMatter OpenStreetMap Esri.WorldImagery OpenTopoMap #> basemaps.color.shuffle : TRUE #> raster.palette : function (n) #> vector.palette : function (n) #> verbose : FALSE #> na.color : #BEBEBE80 #> legend : TRUE #> legend.opacity : 1 #> legend.pos : topright #> layers.control.pos : topleft #> leafletWidth : #> leafletHeight : #> viewer.suppress : FALSE #> homebutton : TRUE #> homebutton.pos : bottomright #> native.crs : FALSE #> watch : FALSE #> #> raster data related options: #> #> raster.size : 8388608 #> mapview.maxpixels : 5e+05 #> plainview.maxpixels : 1e+07 #> use.layer.names : FALSE #> trim : TRUE #> method : bilinear #> query.type : mousemove #> query.digits : 7 #> query.position : topright #> query.prefix : Layer #> georaster : FALSE #> #> vector data related options: #> #> maxpolygons : 30000 #> maxpoints : 20000 #> maxlines : 30000 #> pane : auto #> cex : 6 #> alpha : 0.9 #> fgb : FALSE mapviewOptions(na.color = "pink")mapviewOptions()#> #> global options: #> #> platform : leaflet #> basemaps : CartoDB.Positron CartoDB.DarkMatter OpenStreetMap Esri.WorldImagery OpenTopoMap #> basemaps.color.shuffle : TRUE #> raster.palette : function (n) #> vector.palette : function (n) #> verbose : FALSE #> na.color : pink #> legend : TRUE #> legend.opacity : 1 #> legend.pos : topright #> layers.control.pos : topleft #> leafletWidth : #> leafletHeight : #> viewer.suppress : FALSE #> homebutton : TRUE #> homebutton.pos : bottomright #> native.crs : FALSE #> watch : FALSE #> #> raster data related options: #> #> raster.size : 8388608 #> mapview.maxpixels : 5e+05 #> plainview.maxpixels : 1e+07 #> use.layer.names : FALSE #> trim : TRUE #> method : bilinear #> query.type : mousemove #> query.digits : 7 #> query.position : topright #> query.prefix : Layer #> georaster : FALSE #> #> vector data related options: #> #> maxpolygons : 30000 #> maxpoints : 20000 #> maxlines : 30000 #> pane : auto #> cex : 6 #> alpha : 0.9 #> fgb : FALSE mapviewGetOption("platform")#> [1] "leaflet"mapviewOptions(default = TRUE)mapviewOptions()#> #> global options: #> #> platform : leaflet #> basemaps : CartoDB.Positron CartoDB.DarkMatter OpenStreetMap Esri.WorldImagery OpenTopoMap #> basemaps.color.shuffle : TRUE #> raster.palette : function (n) #> vector.palette : function (n) #> verbose : FALSE #> na.color : #BEBEBE80 #> legend : TRUE #> legend.opacity : 1 #> legend.pos : topright #> layers.control.pos : topleft #> leafletWidth : #> leafletHeight : #> viewer.suppress : FALSE #> homebutton : TRUE #> homebutton.pos : bottomright #> native.crs : FALSE #> watch : FALSE #> #> raster data related options: #> #> raster.size : 8388608 #> mapview.maxpixels : 5e+05 #> plainview.maxpixels : 1e+07 #> use.layer.names : FALSE #> trim : TRUE #> method : bilinear #> query.type : mousemove #> query.digits : 7 #> query.position : topright #> query.prefix : Layer #> georaster : FALSE #> #> vector data related options: #> #> maxpolygons : 30000 #> maxpoints : 20000 #> maxlines : 30000 #> pane : auto #> cex : 0.6 #> alpha : 0.9 #> fgb : FALSE