easyprintOptions: easyprintOptions

In leaflet.extras2: Extra Functionality for 'leaflet' Package

easyprintOptions

Description

Create a list of further options for the easyprint plugin.

Usage

easyprintOptions(
  title = "Print map",
  position = "topleft",
  sizeModes = list("A4Portrait", "A4Landscape", "CurrentSize"),
  defaultSizeTitles = NULL,
  exportOnly = FALSE,
  tileLayer = NULL,
  tileWait = 500,
  filename = "map",
  hidden = FALSE,
  hideControlContainer = TRUE,
  hideClasses = NULL,
  customWindowTitle = NULL,
  spinnerBgColor = "#0DC5C1",
  customSpinnerClass = "epLoader"
)

Arguments

title	Sets the text which appears as the tooltip of the print/export button
position	Positions the print button
sizeModes	Either a character vector with one of the following options: CurrentSize, A4Portrait, A4Landscape. If you want to include a Custom size mode you need to pass a named list, with width, height, name and className and assign a background-image in CSS. See the example in ./inst/examples/easyprint_app.R.
defaultSizeTitles	Button tooltips for the default page sizes
exportOnly	If set to TRUE the map is exported to a .png file
tileLayer	The group name of one tile layer that you can wait for to draw (helpful when resizing)
tileWait	How long to wait for the tiles to draw (helpful when resizing)
filename	Name of the file if exportOnly option is TRUE
hidden	Set to TRUE if you don't want to display the toolbar. Instead you can create your own buttons or fire print events programmatically.
hideControlContainer	Hides the leaflet controls like the zoom buttons and the attribution on the print out
hideClasses	Use a character vector or list of CSS-classes to hide on the output image.
customWindowTitle	A title for the print window which will get added to the printed paper
spinnerBgColor	A valid css colour for the spinner background color
customSpinnerClass	A class for a custom css spinner to use while waiting for the print.

Value

A list of options for the 'easyprint' control

References

https://github.com/rowanwins/leaflet-easyPrint

See Also

Other EasyPrint Functions: addEasyprint(), easyprintMap(), removeEasyprint()

leaflet.extras2 documentation built on Aug. 21, 2023, 5:08 p.m.