add_continuous_legend function

Add a continuous legend

Add a continuous legend

add_continuous_legend( map, legend_title, values, colors, position = "top-left", unique_id = NULL, add = FALSE, width = NULL, layer_id = NULL, margin_top = NULL, margin_right = NULL, margin_bottom = NULL, margin_left = NULL )

Arguments

  • map: A map object created by the mapboxgl function.
  • legend_title: The title of the legend.
  • values: The values being represented on the map (vector of stops).
  • colors: The colors used to generate the color ramp.
  • position: The position of the legend on the map (one of "top-left", "bottom-left", "top-right", "bottom-right").
  • unique_id: A unique ID for the legend container. Defaults to NULL.
  • add: Logical, whether to add this legend to existing legends (TRUE) or replace existing legends (FALSE). Default is FALSE.
  • width: The width of the legend. Can be specified in pixels (e.g., "250px") or as "auto". Default is NULL, which uses the built-in default.
  • layer_id: The ID of the layer that this legend is associated with. If provided, the legend will be shown/hidden when the layer visibility is toggled.
  • margin_top: Custom top margin in pixels, allowing for fine control over legend positioning. Default is NULL (uses standard positioning).
  • margin_right: Custom right margin in pixels. Default is NULL.
  • margin_bottom: Custom bottom margin in pixels. Default is NULL.
  • margin_left: Custom left margin in pixels. Default is NULL.

Returns

The updated map object with the legend added.

  • Maintainer: Kyle Walker
  • License: MIT + file LICENSE
  • Last published: 2025-03-18