-
Notifications
You must be signed in to change notification settings - Fork 46
/
Copy pathupdate_circles.Rd
59 lines (48 loc) · 2.42 KB
/
update_circles.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/google_map_layers.R
\name{update_circles}
\alias{update_circles}
\title{Update circles}
\usage{
update_circles(map, data, id, radius = NULL, draggable = NULL,
stroke_colour = NULL, stroke_weight = NULL, stroke_opacity = NULL,
fill_colour = NULL, fill_opacity = NULL, layer_id = NULL)
}
\arguments{
\item{map}{a googleway map object created from \code{google_map()}}
\item{data}{data.frame containing the new values for the circles}
\item{id}{string representing the column of \code{data} containing the id values
for the circles. The id values must be present in the data supplied to
\code{add_circles} in order for the polygons to be udpated}
\item{radius}{either a string specifying the column of \code{data} containing
the radius of each circle, OR a numeric value specifying the radius of all the
circles (radius is expressed in metres)}
\item{draggable}{string specifying the column of \code{data} defining if the
circle is 'draggable' (either TRUE or FALSE)}
\item{stroke_colour}{either a string specifying the column of \code{data} containing
the stroke colour of each circle, or a valid hexadecimal numeric HTML style
to be applied to all the circles}
\item{stroke_weight}{either a string specifying the column of \code{data} containing
the stroke weight of each circle, or a number indicating the width of pixels
in the line to be applied to all the circles}
\item{stroke_opacity}{either a string specifying the column of \code{data} containing
the stroke opacity of each circle, or a value between 0 and 1 that will be
applied to all the circles}
\item{fill_colour}{either a string specifying the column of \code{data} containing
the fill colour of each circle, or a valid hexadecimal numeric HTML style to
be applied to all the cirlces}
\item{fill_opacity}{either a string specifying the column of \code{data} containing
the fill opacity of each circle, or a value between 0 and 1 that will be applied
to all the circles}
\item{layer_id}{single value specifying an id for the layer.}
}
\description{
Updates specific colours and opacities of specified circles Designed to be
used in a shiny application.
}
\note{
Any circles (as specified by the \code{id} argument) that do not exist
in the \code{data} passed into \code{add_circles()} will not be added to the map.
This function will only update the circles that currently exist on the map when
the function is called.
}