Skip to contents

Add Antpath Lines

Source: R/antpath.R
addAntpath.Rd

Can be used almost exactly like addPolylines but instead of pathOptions you can use antpathOptions to adapt the Antpath behaviour. See leaflet-ant-path for further details.

Usage

addAntpath(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  stroke = TRUE,
  color = "#03F",
  weight = 5,
  opacity = 0.5,
  fill = FALSE,
  fillColor = color,
  fillOpacity = 0.2,
  dashArray = NULL,
  smoothFactor = 1,
  noClip = FALSE,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  options = antpathOptions(),
  highlightOptions = NULL,
  data = getMapData(map)
)

Arguments

map

a map widget object created from leaflet()

lng

a numeric vector of longitudes, or a one-sided formula of the form ~x where x is a variable in data; by default (if not explicitly provided), it will be automatically inferred 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 lat and 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 clearGroup() and addLayersControl() purposes). Human-friendly group names are permitted–they need not be short, identifier-style names. Any number of layers and even different types of layers (e.g., markers and polygons) can share the same group name.

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 performance and less accurate representation)

noClip

whether to disable polyline clipping

popup

a character vector of the HTML content for the popups (you are recommended to escape the text using htmltools::htmlEscape() for security reasons)

popupOptions

A Vector of popupOptions() to provide popups

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 named list of options. See antpathOptions

highlightOptions

Options for highlighting the shape on mouse over.

data

the data object from which the argument values are derived; by default, it is the data object provided to leaflet() initially, but can be overridden

Value

A modified leaflet map, with an 'ant-path' animated polyline

Note

Unlike addPolylines, antpath layers are not registered as "shape". In Shiny the mouse events therefore use the antpath category instead of shape:

  1. A click updates input$MAPID_antpath_click

  2. A mouseover updates input$MAPID_antpath_mouseover

  3. A mouseout updates input$MAPID_antpath_mouseout

References

https://github.com/rubenspgcavalcante/leaflet-ant-path

See also

Other Antpath Functions: antpathOptions(), clearAntpath(), removeAntpath()

Examples

library(leaflet)
leaflet() %>%
  addAntpath(data = atlStorms2005)