leaf_sf_col | R Documentation |
Map of simple features in leaflet that is coloured.
leaf_sf_col(
data,
col_var,
label_var = NULL,
popup = TRUE,
popup_vars_vctr = NULL,
popup_numeric_format = function(x) prettyNum(x, big.mark = "", scientific = FALSE),
popup_vars_rename = snakecase::to_sentence_case,
pal = NULL,
pal_na = "#7F7F7F",
pal_rev = FALSE,
alpha_point = NULL,
alpha_line = NULL,
alpha_fill = NULL,
size_point = 2,
size_line = 2,
basemap = "light",
col_breaks_n = 4,
col_cuts = NULL,
col_intervals_left = TRUE,
col_labels = NULL,
col_legend_none = FALSE,
col_method = NULL,
col_na_rm = FALSE,
col_title = NULL,
label_numeric_format = function(x) prettyNum(x, big.mark = ",", scientific = FALSE),
layer_id_var = NULL,
group_id = NULL,
legend_id = NULL,
map_id = "leaf"
)
data |
An sf object of geometry type point/multipoint, linestring/multilinestring or polygon/multipolygon geometry type. Required input. |
col_var |
Unquoted variable to colour the features by. Required input. |
label_var |
Unquoted variable to label the features by. If NULL, defaults to using the colour variable. |
popup |
TRUE or FALSE of whether to have a popup. |
popup_vars_vctr |
Vector of quoted variable names to include in the popup. If NULL, defaults to making a leafpop::popupTable of all columns. |
popup_numeric_format |
A function to format all numeric variables within the popup column. Defaults to non-scientific. Use function(x) x to leave as is. |
popup_vars_rename |
Function to rename column names for the popup. Defaults to snakecase::to_sentence_case. Use function(x) x to leave column names untransformed. |
pal |
Character vector of hex codes. |
pal_na |
The hex code or name of the NA colour to be used. |
pal_rev |
Reverses the palette. Defaults to FALSE. |
alpha_point |
The opacity of the points. |
alpha_line |
The opacity of the outline. |
alpha_fill |
The opacity of the fill. |
size_point |
Size of points (i.e. radius). Defaults to 2. |
size_line |
Size of lines around features (i.e. weight). Defaults to 2. |
basemap |
The underlying basemap. Either "light", "dark", "satellite", "street", or "ocean". Defaults to "light". Only applicable where shiny equals FALSE. |
col_breaks_n |
For a numeric colour variable, the desired number of intervals on the colour scale. |
col_cuts |
A vector of cuts to colour a numeric variable. If "bin" is selected, the first number in the vector should be either -Inf or 0, and the final number Inf. If "quantile" is selected, the first number in the vector should be 0 and the final number should be 1. Defaults to quartiles. |
col_intervals_left |
For a numeric colour variable, TRUE or FALSE of whether bins or quantiles are to be cut left-closed. Defaults to TRUE. |
col_labels |
A function or named vector to modify the colour scale labels. Defaults to snakecase::to_sentence_case if categorical, and scales::label_comma() if numeric. Use function(x) x to keep labels untransformed. |
col_legend_none |
TRUE or FALSE of whether to remove the legend. |
col_method |
The method of colouring features, either "bin", "quantile", "continuous", or "category." If numeric, defaults to "bin". |
col_na_rm |
TRUE or FALSE of whether to include col_var NA values. Defaults to FALSE. |
col_title |
A title string that will be wrapped into the legend. |
label_numeric_format |
A function to format the numeric labels. Defaults to adding a comma seperator. Use function(x) x to leave as is. |
layer_id_var |
Unquoted variable to be used in shiny, so that in the event where a feature is clicked on, the value of this is returned for that feature (e.g. input$map_marker_click$id). |
group_id |
The id name for the sf group. |
legend_id |
The id name for the layerId of the legend. |
map_id |
The map id for the leaflet map. Defaults to "leaf". |
A leaflet object.
## Not run:
leaf_sf_col(example_point,
col_var = trend_category)
leaf_sf_col(example_polygon,
col_var = density)
leaf_sf_col(example_polygon,
col_var = density,
col_method = "bin",
col_breaks_n = 5)
leaf_sf_col(example_polygon,
col_var = density,
col_method = "bin",
col_cuts = c(0, 10, 50, 100, 150, 200, Inf))
leaf_sf_col(example_polygon,
col_var = density,
col_method = "quantile",
col_breaks_n = 4)
leaf_sf_col(example_polygon,
col_var = density,
col_method = "quantile",
col_cuts = c(0, 0.25, 0.5, 0.75, 0.95, 1))
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.