-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
495 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| #' Wrapper functions for using **tmap** in **shiny** | ||
| #' | ||
| #' Use \code{tmapOutput} to create a UI element, and \code{renderTmap} to render the tmap map. To update the map in \code{view} mode, use \code{tmapProxy}. Adding layers is as usual via the map layer functions like \code{\link{tm_polygons}}. Removing layers can be done , removing with the function \code{tm_remove_layer}. | ||
| #' | ||
| #' Two features from tmap are not (yet) supported in Shiny: small multiples (facets) and colored backgrounds (argument bg.color of \code{\link{tm_layout}}). Workarounds for small multiples: create multiple independent maps or specify as.layers = TRUE in \code{\link{tm_facets}}. | ||
| #' | ||
| #' @param expr A tmap object. A tmap object is created with \code{\link{qtm}} or by stacking \code{\link{tmap-element}}s. | ||
| #' @param mode tmap mode, see [tmap_mode()] If not defined, the current mode is used | ||
| #' @param env The environment in which to evaluate expr | ||
| #' @param quoted Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable | ||
| #' @param outputId Output variable to read from | ||
| #' @param width,height the width and height of the map | ||
| #' @param mapId single-element character vector indicating the output ID of the map to modify (if invoked from a Shiny module, the namespace will be added automatically) | ||
| #' @param session the Shiny session object to which the map belongs; usually the default value will suffice | ||
| #' @param x the tmap object that specifies the added and removed layers. | ||
| #' @param zindex the z index of the pane in which the layer is contained that is going to be removed. It is recommended to specify the `zindex` for this layer when creating the map (inside \code{renderTmap}). | ||
| #' @param execOnResize If `TRUE` (default), when the plot is resized, the map is regenerated. When set to `FALSE` the map is rescaled: the aspect ratio is kept, but the layout will be less desirable. | ||
| #' @importFrom htmlwidgets shinyWidgetOutput | ||
| #' @rdname renderTmap | ||
| #' @example ./examples/tmapOutput.R | ||
| #' @export | ||
| renderTmap <- function(expr, env = parent.frame(), quoted = FALSE, execOnResize = TRUE, mode = NA) { | ||
| if (is.na(mode)) mode = getOption("tmap.mode") | ||
| gs = tmap_graphics_name(mode) | ||
|
|
||
| if (gs == "Leaflet") { | ||
| if (!quoted) | ||
| expr = substitute(expr) | ||
| expr = substitute(getFromNamespace("print.tmap", "tmap")(expr, in.shiny = TRUE)) | ||
| htmlwidgets::shinyRenderWidget(expr, leafletOutput, env, | ||
| quoted = TRUE) | ||
| } else if (gs == "Grid") { | ||
| #if (!quoted) | ||
| # expr = substitute(expr) | ||
| expr = substitute(getFromNamespace("print.tmap", "tmap")(expr)) | ||
| #htmlwidgets::shinyRenderWidget(expr, plotOutput, env, | ||
| # quoted = TRUE) | ||
| shiny::renderPlot(expr, env = env, quoted = TRUE, execOnResize = execOnResize) | ||
| #shiny::renderPlot(plot(1:10), env = env, quoted = quoted) | ||
|
|
||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
|
|
||
| #' @name tmapOutput | ||
| #' @rdname renderTmap | ||
| #' @export | ||
| tmapOutput <- function(outputId, width = "100%", height = 400, mode = NA) { | ||
| if (is.na(mode)) mode = getOption("tmap.mode") | ||
| gs = tmap_graphics_name(mode) | ||
| if (gs == "Leaflet") { | ||
| leaflet::leafletOutput(outputId, width = width, height = height) | ||
| } else if (gs == "Grid") { | ||
| shiny::plotOutput(outputId = outputId, width = width, height = height) | ||
| } | ||
| } | ||
|
|
||
| #' @name tmapProxy | ||
| #' @rdname renderTmap | ||
| #' @export | ||
| tmapProxy <- function(mapId, session = shiny::getDefaultReactiveDomain(), x, mode = NA) { | ||
| if (is.na(mode)) mode = getOption("tmap.mode") | ||
| gs = tmap_graphics_name(mode) | ||
|
|
||
| if (gs == "Leaflet") { | ||
| print.tmap(x, lf = leaflet::leafletProxy(mapId, session), show = FALSE, in.shiny = TRUE, proxy = TRUE) | ||
| } else if (gs == "Grid") { | ||
| message("tmapProxy not working for plot mode (yet)") | ||
| print.tmap(x, show = TRUE) | ||
| } | ||
|
|
||
|
|
||
| } | ||
|
|
||
|
|
||
| #' @name tm_remove_layer | ||
| #' @rdname renderTmap | ||
| #' @export | ||
| tm_remove_layer <- function(zindex) { | ||
| tm_element_list(tm_element(zindex = zindex, | ||
| subclass = c("tm_proxy", "tm_remove_layer"))) | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.