From 520a013a196e90d49ac6581210ffaa9f2b7caed2 Mon Sep 17 00:00:00 2001 From: Sebastian Gatscha Date: Tue, 12 May 2020 20:39:48 +0200 Subject: [PATCH] docs --- man/addPlayback.Rd | 4 ++-- man/easyprintOptions.Rd | 19 +++++++++---------- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/man/addPlayback.Rd b/man/addPlayback.Rd index d6fa474b..9eb0803d 100644 --- a/man/addPlayback.Rd +++ b/man/addPlayback.Rd @@ -24,7 +24,7 @@ a specific form. See the Details for further information.} \item{icon}{an icon which can be created with \code{\link[leaflet]{makeIcon}}} -\item{pathOpts}{style the CircleMarker with +\item{pathOpts}{style the CircleMarkers with \code{\link[leaflet]{pathOptions}}} \item{options}{List of additional options. See \code{\link{playbackOptions}}} @@ -36,7 +36,7 @@ the new \code{map} object The \href{https://github.com/hallahan/LeafletPlayback}{LeafletPlayback plugin} provides the ability to replay GPS Points in the form of POINT Simple Features. Rather than simply animating a marker along a -polyline, the speed of the animation is synchroized to a clock. The playback +polyline, the speed of the animation is synchronized to a clock. The playback functionality is similar to a video player; you can start and stop playback or change the playback speed. } diff --git a/man/easyprintOptions.Rd b/man/easyprintOptions.Rd index 235e2d2a..973edce1 100644 --- a/man/easyprintOptions.Rd +++ b/man/easyprintOptions.Rd @@ -26,12 +26,12 @@ easyprintOptions( \item{position}{Positions the print button} -\item{sizeModes}{Options available include CurrentSize, A4Portrait, -A4Landscape or a custom size object.} +\item{sizeModes}{Options available include \code{CurrentSize}, \code{A4Portrait}, +\code{A4Landscape} or a custom size object} -\item{defaultSizeTitles}{button tooltips for the default page sizes} +\item{defaultSizeTitles}{Button tooltips for the default page sizes} -\item{exportOnly}{If set to true the map is exported to a png file} +\item{exportOnly}{If set to \code{TRUE} the map is exported to a .png file} \item{tileLayer}{A tile layer that you can wait for to draw (helpful when resizing)} @@ -39,20 +39,19 @@ A4Landscape or a custom size object.} \item{filename}{Name of the file if \code{exportOnly} option is \code{TRUE}} -\item{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. -You still need to call addTo(map) to set the leaflet map context.} +\item{hidden}{Set to \code{TRUE} if you don't want to display the toolbar. +Instead you can create your own buttons or fire print events programmatically.} \item{hideControlContainer}{Hides the leaflet controls like the zoom buttons -and the attribution on the print out.} +and the attribution on the print out} \item{hideClasses}{Hides classes on the print out. Use a list of strings as follow : list('div1', 'div2')} \item{customWindowTitle}{A title for the print window which will get -added the printed paper.} +added the printed paper} -\item{spinnerBgColor}{A valid css colour for the spinner background color.} +\item{spinnerBgColor}{A valid css colour for the spinner background color} \item{customSpinnerClass}{A class for a custom css spinner to use while waiting for the print.}