Rename labelOptions to tooltipOptions

[schloerke]

With the adoption of Leaflet.label into L.tooltip, if we'd like to copy the names fully, we should rename labelOptions (function and argument usage) to tooltipOptions.

This will probably involve deprecation / message functionality within the package.

Or (current implementation) we could leave as is and not change our api, but just point to the documentation of tooltip options from our labelOptions documentation.

leaflet/R/layers.R

Line 548 in bfe4b0d

#' label options; see \url{http://leafletjs.com/reference-1.3.1.html#tooltip-option}

[MatthiasHinz]

I would suggest to also add (mention) the 'sticky'-parameter within the label option documentation. In the previous version, it was the default that the tooltip of a polygon follows the mouse cursor. Now it must be activated via sticky = TRUE.

[schloerke]

@MatthiasHinz Was sticky=TRUE the default behavior before? I can not find it in the codes for Leaflet.label or leaflet.js. If so, should it be the default behavior still? (So I can document properly)

[tim-salabim]

The behaviour of the tooltip following the mouse was the default behaviour in the leaflet R package before. I don not know whether it also was in leafletjs. See also my comment here - bullet 3. In my opinion it make more sense for the tooltip to be displayed at the mouse cursor than at some location representing the "center" of a feature.

[schloerke]

I completely agree with following the mouse vs "center" for a default. The jarring feeling I get when it doesn't show up at my mouse is worth going against the default leaflet.js setting.

@tim-salabim Should the sticky=TRUE be added to labelOptions as a default option? This would effectively keep it as it was in prior leaflet.R version

[tim-salabim]

Yes, i think that is a good idea.

[schloerke]

sticky=TRUE implemented in #520