bitmap_layer: Bitmap Layer

bitmap_layerR Documentation

Bitmap Layer

Description

Bitmap Layer

Usage

add_bitmap_layer(
  rdeck,
  ...,
  id = uuid::UUIDgenerate(),
  name = "BitmapLayer",
  group_name = NULL,
  data = NULL,
  visible = TRUE,
  pickable = FALSE,
  opacity = 1,
  wrap_longitude = FALSE,
  position_format = "XY",
  color_format = "RGBA",
  auto_highlight = FALSE,
  highlight_color = "#00008080",
  image = NULL,
  bounds = c(1, 0, 0, 1),
  desaturate = 0,
  transparent_color = "#00000000",
  tint_color = "#ffffff",
  blending_mode = "normal",
  visibility_toggle = TRUE,
  tooltip = NULL
)

update_bitmap_layer(
  rdeck,
  ...,
  id,
  name = cur_value(),
  group_name = cur_value(),
  data = cur_value(),
  visible = cur_value(),
  pickable = cur_value(),
  opacity = cur_value(),
  wrap_longitude = cur_value(),
  position_format = cur_value(),
  color_format = cur_value(),
  auto_highlight = cur_value(),
  highlight_color = cur_value(),
  image = cur_value(),
  bounds = cur_value(),
  desaturate = cur_value(),
  transparent_color = cur_value(),
  tint_color = cur_value(),
  blending_mode = cur_value(),
  visibility_toggle = cur_value(),
  tooltip = cur_value()
)

Arguments

rdeck

<rdeck | rdeck_proxy> An rdeck map instance.

...

Additional parameters that will be forwarded to deck.gl javascript without validation nor processing. All dots must be named and will be camelCased when serialised. A warning is raised when dots are used, warning class rdeck_dots_nonempty.

id

<string> The layer's identifier must be unique for among all layers of the same type for a map. Defaults to uuid::UUIDgenerate(), but should be explicitly defined for updatable layers in a shiny application.

name

<string> Identifies the layer on tooltips and legends. It does not need to be unique, but should be brief. Defaults to the deck.gl class name for the layer.

group_name

<string> Defines the group that this layer belongs to. Currently only effective on the layer selector, if visibility_toggle = TRUE.

data

<data.frame | sf | string> The layer's data. Data frames and sf objects will contain all columns that are referenced by the layer's accessors. Strings will be interpreted as a URL and data will be retrieved dynamically in the browser.

visible

<boolean> Determines whether the layer is visible or not; also determines whether any legend elements for the layer will be displayed.

pickable

<boolean> Determines if the layer responds to pointer / touch events.

opacity

<number> Determines the layer's opacity.

wrap_longitude

<boolean> Normalises geometry longitudes.

position_format

<"XY" | "XYZ"> Determines whether each coordinate has two (XY) or three (XYZ) elements.

color_format

<"RGB" | "RGBA"> Determines whether the alpha channel of the colours will be ignored by accessors, making all colours opaque.

auto_highlight

<boolean> When TRUE, the current object hovered by the cursor is highlighted by highlight_color.

highlight_color

<accessor | scale | color> When auto_highlight and pickable are enabled, highlight_color determines the colour of the currently highlighted object. If a single colour value is supplied, that colour will be used to highlight all objects in the layer. Per-object highlighting is achieved with a colour scale, or a tidy-eval column of colours.

image

<string | array> The image to display. Either a string interpreted as a URL or Data URL, or an image bitmap.

bounds

<rct/st_bbox/wk-geometry> The bounds of the image to fit x,y coordinates into. Requires CRS EPSG:4326.

desaturate

<number> The desaturation of the bitmap. Between 0 and 1, being the original colour, 1 being greyscale.

transparent_color

<color> The colour to use for transparent pixels.

tint_color

<color> The colour to tint the bitmap by. Alpha channel is ignored if supplied.

blending_mode

<"normal" | "additive" | "subtractive"> Sets the blending mode. Blending modes:

  • normal: Normal blending doesn't alter colours of overlapping objects.

  • additive: Additive blending adds colours of overlapping objects. Useful for highlighting dot density on dark maps.

  • subtractive: Subtractive blending darkens overlapping objects. Useful for highlighting dot density on light maps.

visibility_toggle

<boolean> Whether this layer will appear in the layer selector.

tooltip

<tooltip> Defines the columns (and their order) that will be displayed in the layer tooltip, if pickable == TRUE. Supports tidy-select if a data is a data.frame. Geometry columns are always removed.

See Also

https://github.com/visgl/deck.gl/blob/8.7-release/docs/api-reference/layers/bitmap-layer.md

Other core-layers: arc_layer, column_layer, geojson_layer, grid_cell_layer, icon_layer, line_layer, path_layer, point_cloud_layer, polygon_layer, scatterplot_layer, solid_polygon_layer, text_layer

Other layers: arc_layer, column_layer, contour_layer, cpu_grid_layer, geojson_layer, gpu_grid_layer, great_circle_layer, grid_cell_layer, grid_layer, h3_cluster_layer, h3_hexagon_layer, heatmap_layer, hexagon_layer, icon_layer, line_layer, mvt_layer, path_layer, point_cloud_layer, polygon_layer, quadkey_layer, s2_layer, scatterplot_layer, scenegraph_layer, screen_grid_layer, simple_mesh_layer, solid_polygon_layer, terrain_layer, text_layer, tile_3d_layer, tile_layer, trips_layer


anthonynorth/rdeck documentation built on Feb. 2, 2024, 1:12 p.m.