R/doc-deckgl-layers.R
In anthonynorth/rdeck: Deck.gl Widget
Defines functions
deckgl_docs
#' Arc Layer
#'
#' @name arc_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "arc-layer")
#' @family core-layers
#' @family layers
NULL
#' Bitmap Layer
#'
#' @name bitmap_layer
#' @inherit layer_props
#' @param image <`string` | `array`> The image to display. Either a string interpreted as a
#' URL or Data URL, or an image bitmap.
#' @eval deckgl_docs("layers", "bitmap-layer")
#' @family core-layers
#' @family layers
NULL
#' Icon Layer
#'
#' @name icon_layer
#' @inherit layer_props
#' @param icon_atlas <`string`|`array`> The image sprite containing raster icons. Must
#' be either a string which is interpreted as a URL to an image, or an image bitmap.
#' @param icon_mapping <`string`|`list`> The image sprite index. Must be either a string
#' which is interpreted as a URL to a json document, or a named-list of icon descriptors.
#' See https://github.com/visgl/deck.gl/blob/master/docs/api-reference/layers/icon-layer.md#iconmapping-objectstring-optional
#' for icon descriptor fields.
#' @param billboard <`boolean`> If `TRUE`, the icon always faces the camera, otherwise it
#' faces up (z).
#' @param alpha_cutoff <`number`> Discard pixels whose opacity is below this threshold.
#' A discarded pixel would create a "hole" in the icon that is not considered part of
#' the object.
#' @param get_icon <[`accessor`]> The name of the icon for each feature. Icon name must be
#' present in the `icon_mapping`.
#' @param get_size <[`accessor`] | [`scale`] | `number`> The size of each icon,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_angle <[`accessor`] | `number`> The rotating angle of each icon in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @eval deckgl_docs("layers", "icon-layer")
#' @family core-layers
#' @family layers
NULL
#' Line Layer
#'
#' @name line_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "line-layer")
#' @family core-layers
#' @family layers
NULL
#' Point Cloud Layer
#'
#' @name point_cloud_layer
#' @inherit layer_props
#' @param get_normal <[`accessor`] | `numeric`> The normal of each object, in `c(nx, ny, nz)`.
#' Accepts a length-3 numeric vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) 3-column matrix column.
#' @eval deckgl_docs("layers", "point-cloud-layer")
#' @family core-layers
#' @family layers
NULL
#' Scatterplot Layer
#'
#' @name scatterplot_layer
#' @inherit layer_props
#' @param radius_scale <`number`> The radius multiplier for all points.
#' @param radius_min_pixels <`number`> The minimum radius in pixels.
#' @param radius_max_pixels <`number`> The maximum radius in pixels.
#' @param billboard <`boolean`> If `TRUE`, circles always face the camera;
#' if `FALSE` circles face up (z).
#' @param antialiasing <`boolean`> If `TRUE`, circles are rendered with smoothed
#' edges.
#' @eval deckgl_docs("layers", "scatterplot-layer")
#' @family core-layers
#' @family layers
NULL
#' Grid Cell Layer
#'
#' @name grid_cell_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "grid-cell-layer")
#' @family core-layers
#' @family layers
NULL
#' Column Layer
#'
#' @name column_layer
#' @inherit layer_props
#' @param radius <`number`> The radius of the column in metres.
#' @param line_width_units <`"pixels"` | `"common"` | `"meters"`> The units of outline width.
#' Applied when `extruded == FALSE` and `stroked == TRUE`.
#' @eval deckgl_docs("layers", "column-layer")
#' @family core-layers
#' @family layers
NULL
#' Path Layer
#'
#' @name path_layer
#' @inherit layer_props
#' @param billboard <`boolean`> If `TRUE`, extrude the path in screen space (width always faces)
#' the camera; if `FALSE`, the width always faces up (z).
#' @eval deckgl_docs("layers", "path-layer")
#' @family core-layers
#' @family layers
NULL
#' Polygon Layer
#'
#' @name polygon_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "polygon-layer")
#' @family core-layers
#' @family layers
NULL
#' Solid Polygon Layer
#'
#' @name solid_polygon_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "solid-polygon-layer")
#' @family core-layers
#' @family layers
NULL
#' GeoJson Layer
#'
#' @name geojson_layer
#' @inherit layer_props
#' @inherit icon_layer
#' @inherit text_layer
#' @param data <[`sf`][sf::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 to geojson data that will be retrieved dynamically in the browser.
#'
#' @param line_billboard <`boolean`> If `TRUE`, extrude the path in screen space (width always faces)
#' the camera; if `FALSE`, the width always faces up (z).
#' @param line_cap_rounded <`boolean`> If `TRUE`, draw round caps; else draw square caps.
#' @param line_joint_rounded <`boolean`> If `TRUE`, draw round joints; else draw square joints.
#'
#' @param point_antialiasing <`boolean`> If `TRUE`, circles are rendered with smoothed
#' edges.
#' @param point_billboard <`boolean`> If `TRUE`, circles always face the camera;
#' if `FALSE` circles face up (z).
#'
#' @param icon_size_scale <`number`> The icon size multiplier.
#' @param icon_size_units <`"pixels"` | `"common"` | `"meters"`> The units of the icon size specified by
#' `get_icon_size`.
#' @param icon_size_min_pixels <`number`> The minimum icon size in pixels.
#' @param icon_size_max_pixels <`number`> The maximum icon size in pixels.
#' @param icon_billboard <`boolean`> If `TRUE`, the icon always faces the camera, otherwise it
#' faces up (z).
#' @param icon_alpha_cutoff <`number`> Discard icon pixels whose opacity is below this threshold.
#' A discarded pixel would create a "hole" in the icon that is not considered part of
#' the object.
#' @param get_icon_size <[`accessor`] | [`scale`] | `number`> The size of each icon,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_icon_color <[`accessor`] | [`scale`] | [`color`]> The colour of each icon.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_icon_angle <[`accessor`] | `number`> The rotating angle of each icon in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_icon_pixel_offset <[`accessor`] | `number`> The pixel offset for each icon.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#'
#' @param text_size_scale <`number`> The text label size multiplier.
#' @param text_size_units <`"pixels"` | `"common"` | `"meters"`> The units of the text label
#' size, specified by `get_text_size`.
#' @param text_size_min_pixels <`number`> The minimum text label size in pixels.
#' @param text_size_max_pixels <`number`> The maximum text label size in pixels.
#' @param text_billboard <`boolean`> If `TRUE`, the text label always faces the camera, otherwise it
#' faces up (z).
#' @param text_background <`boolean`> Whether to render background for text labels.
#' @param text_background_padding <`numeric`> The text background padding. Must be an array of 2 or
#' 4 numbers.
#' @param text_font_family <`string`> Specifies a prioritised list of one or more font family names.
#' See [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family).
#' @param text_font_weight <`"normal"` | `"bold"` | `100:900`> The font weight. See
#' [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight)
#' @param text_line_height <`number`> A unitless number that will be multiplied with `get_size`
#' to set the line height.
#' @param text_font_settings <`font_settings`> Advanced options for fine tuning the appearance
#' and performance of the generated `font_atlas`.
#' @param text_word_break <`"break-word"` | `"break-all"`> Requires a valid `text_max_width`.
#' @param text_max_width <`number`> Used together with `text_word_break` for wrapping text. Specifies
#' the width limit to break the text into multiple lines.
#' @param text_outline_width <`number`> The text outline width, relative to font size. Requires
#' `text_font_settings$sdf = TRUE`.
#' @param text_outline_color <[`color`]> The text outline colour. Requires `text_font_settings$sdf = TRUE`.
#' @param get_text_size <[`accessor`] | [`scale`] | `number`> The font size of each text label,
#' in units specified by `text_size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_color <[`accessor`] | [`scale`] | [`color`]> The colour of each text label.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_angle <[`accessor`] | `number`> The rotating angle of each text label in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_alignment_baseline <[`accessor`] | `"top"` | `"center"` | `"bottom"`> The text
#' label alignment baseline. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_text_pixel_offset <[`accessor`] | `number`> The pixel offset for each text label.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#' @param get_text_background_color <[`accessor`] | [`scale`] | [`color`]> The text background colour,
#' if `text_background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_border_color <[`accessor`] | [`scale`] | [`color`]> The text background border colour,
#' if `text_background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_border_width <[`accessor`] | [`scale`] | `number`> The text background border width,
#' if `text_background = TRUE`. Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#'
#' @eval deckgl_docs("layers", "geojson-layer")
#' @family core-layers
#' @family layers
NULL
#' Text Layer
#'
#' @name text_layer
#' @inherit layer_props
#' @param billboard <`boolean`> If `TRUE`, the text label always faces the camera, otherwise it
#' faces up (z).
#' @param background <`boolean`> Whether to render background for text labels.
#' @param background_padding <`numeric`> The text background padding. Must be an array of 2 or
#' 4 numbers.
#' @param font_family <`string`> Specifies a prioritised list of one or more font family names.
#' See [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family).
#' @param font_weight <`"normal"` | `"bold"` | `100:900`> The font weight. See
#' [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight)
#' @param line_height <`number`> A unitless number that will be multiplied with `get_size`
#' to set the line height.
#' @param font_settings <`font_settings`> Advanced options for fine tuning the appearance
#' and performance of the generated `font_atlas`.
#' @param word_break <`"break-word"` | `"break-all"`> Requires a valid `max_width`.
#' @param max_width <`number`> Used together with `word_break` for wrapping text. Specifies
#' the width limit to break the text into multiple lines.
#' @param outline_width <`number`> The text outline width, relative to font size. Requires
#' `font_settings$sdf = TRUE`.
#' @param outline_color <[`color`]> The text outline colour. Requires `font_settings$sdf = TRUE`.
#' @param get_text <[`accessor`]> The text value of each text label. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column of
#' labels.
#' @param get_size <[`accessor`] | [`scale`] | `number`> The font size of each text label,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_angle <[`accessor`] | `number`> The rotating angle of each text label in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_anchor <[`accessor`] | `"start"` | `"middle"` | `"end"`> The text label
#' anchor. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_alignment_baseline <[`accessor`] | `"top"` | `"center"` | `"bottom"`> The text
#' label alignment baseline. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_background_color <[`accessor`] | [`scale`] | [`color`]> The text background colour,
#' if `background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_border_color <[`accessor`] | [`scale`] | [`color`]> The text background border colour,
#' if `background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_border_width <[`accessor`] | [`scale`] | `number`> The text background border width,
#' if `background = TRUE`. Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @eval deckgl_docs("layers", "text-layer")
#' @family core-layers
#' @family layers
NULL
#' Screen Grid Layer
#'
#' @name screen_grid_layer
#' @inherit layer_props
#' @param cell_size_pixels <`number`> Unit width / height of the bins.
#' @param cell_margin_pixels <`number`> Cell margin size in pixels.
#' @eval deckgl_docs("aggregation-layers", "screen-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' CPU Grid Layer
#'
#' @name cpu_grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "cpu-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Hexagon Layer
#'
#' @name hexagon_layer
#' @inherit layer_props
#' @param radius <`number`> The radius of the hexagon bin in metres.
#' @eval deckgl_docs("aggregation-layers", "hexagon-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Contour Layer
#'
#' @name contour_layer
#' @inherit layer_props
#' @param contours array
#' @param z_offset <`number`> A very small z offset that is added for each vertex of a
#' contour (isoline or isoband). Needed to control the layout of the contours.
#' See deck.gl [contours](https://deck.gl/docs/api-reference/aggregation-layers/contour-layer#contours)
#' @eval deckgl_docs("aggregation-layers", "contour-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Grid Layer
#'
#' @name grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' GPU Grid Layer
#'
#' @name gpu_grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "gpu-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Heatmap Layer
#'
#' @name heatmap_layer
#' @inherit layer_props
#' @param intensity <`number`> Value that is multiplied with the total weight at a pixel to
#' obtain the final weight. A value > `1` biases the output colour towards the higher end
#' of the `color_range`, and a value < `1` biases the output towards the lower end of the
#' `color_range`.
#' @param radius_pixels <`number`> The radius of the circle in pixels.
#' @param threshold <`number`> Larger threshold values creates smoother boundaries of colour
#' _blobs_, while making pixels with low weight values more transparent.
#' Ignored when `color_domain` is specified.
#' @param weights_texture_size <`number`> The size of the weight texture. Smaller texture
#' sizes can improve rendering performance, but lead to visible pixelation.
#' @param debounce_timeout <`number`> Debounce interval (milliseconds) for triggering
#' aggregation.
#' @eval deckgl_docs("aggregation-layers", "heatmap-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Great Circle Layer
#'
#' @name great_circle_layer
#' @inherit layer_props
#' @eval deckgl_docs("geo-layers", "great-circle-layer")
#' @family geo-layers
#' @family layers
NULL
#' S2 Layer
#'
#' @name s2_layer
#' @inherit layer_props
#' @param get_s2_token <[`accessor`]> The S2 hex token for each S2 cell. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @eval deckgl_docs("geo-layers", "s2-layer")
#' @family geo-layers
#' @family layers
NULL
#' H3 Cluster Layer
#'
#' @name h3_cluster_layer
#' @inherit layer_props
#' @param get_hexagons <[`accessor`]>
#' @eval deckgl_docs("geo-layers", "h3-cluster-layer")
#' @family geo-layers
#' @family layers
NULL
#' H3 Hexagon Layer
#'
#' @name h3_hexagon_layer
#' @inherit layer_props
#' @param high_precision <`boolean`> If `TRUE`, draw each hexagon as a polygon using each
#' hexagon's true geometry. If `FALSE`, draw each hexagon with the same shape as
#' `center_hexagon`. High precision trades rendering performance for geometry precision.
#' High precision is required (forcibly enabled) when:
#'
#' - Rendering hex resolutions in range `c(0, 5)`
#' - Pentagons are present in the data
#' - Multiple resolution hexes are present in the data
#' @param center_hexagon <`string`> If `high_precision == FALSE`, defines the H3 hexagon
#' that will be used as the shape of all hexagons in the layer. Defaults to the hexagon in
#' the centre of the viewport.
#' @param get_hexagon <[`accessor`]> The H3 hex token for each H3 hexagon. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @eval deckgl_docs("geo-layers", "h3-hexagon-layer")
#' @family geo-layers
#' @family layers
NULL
#' Quadkey Layer
#'
#' @name quadkey_layer
#' @inherit layer_props
#' @param get_quadkey <`accessor`> The column containing the quadkey identifier.
#' @eval deckgl_docs("geo-layers", "quadkey-layer")
#' @family geo-layers
#' @family layers
NULL
#' Tile Layer
#'
#' @name tile_layer
#' @inherit layer_props
#' @param data <`character`> A character vector of raster tile url templates.
#' Substrings `"{x}"`, `"{y}"`, `"{z}"` will be replaced with a tile's actual index on
#' request.
#'
#' If multiple url templates are supplied, each endpoint must return the same data for the
#' same tile index.
#' @eval deckgl_docs("geo-layers", "tile-layer")
#' @family geo-layers
#' @family layers
NULL
#' Trips Layer
#'
#' @name trips_layer
#' @inherit path_layer
#' @param fade_trail <`boolean`> Whether or not the path fades out.
#' @param trail_length <`number`> The number of seconds for a path to completely fade out.
#' @param get_timestamps <[`accessor`]> The timestamps for each _trip_. For each trip,
#' each timestamp corresponds to a position in the linestring returned by `get_path`,
#' representing the time at which that position was visited.
#'
#' Accepts a [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html)
#' list column of numbers.
#' @param loop_length <`number`> The number of seconds to complete an animation loop.
#' @param animation_speed <`number`> The animation speed multiplier.
#' @eval deckgl_docs("geo-layers", "trips-layer")
#' @family geo-layers
#' @family layers
NULL
#' Tile 3D Layer
#'
#' @name tile_3d_layer
#' @inherit layer_props
#' @param get_point_color <[`color`]> The colour of each object.
#' @param loader object
#' @eval deckgl_docs("geo-layers", "tile3d-layer")
#' @family geo-layers
#' @family layers
NULL
#' Terrain Layer
#'
#' @name terrain_layer
#' @inherit layer_props
#' @param elevation_data url
#' @param mesh_max_error number
#' @param bounds <[`rct`][wk::rct]/[`st_bbox`][sf::st_bbox]/[`wk-geometry`]>
#' The bounds of the image to fit x,y coordinates into.
#' Requires CRS [EPSG:4326](http://epsg.io/4326).
#' Must be supplied when using non-tiled elevation data.
#' @param color color
#' @param elevation_decoder object
#' @param worker_url string
#' @eval deckgl_docs("geo-layers", "terrain-layer")
#' @family geo-layers
#' @family layers
NULL
#' MVT Layer
#'
#' @name mvt_layer
#' @inherit layer_props
#' @inherit geojson_layer
#' @param data <`character` | [`tile_json`]> Defines the remote data for the layer. May take any of:
#' - A [tile_json()] object
#' - A `string` which is a valid URL to a [tilejson](https://docs.mapbox.com/help/glossary/tilejson)
#' - A `character` vector of tile url templates, each containing placeholders for tile coordinates: `{z}/{x}/{y}`
#' @param unique_id_property <`string`> Used for highlighting features across tiles. Features
#' on separate tiles are deemed to be _the same feature_ by the supplied property name. If
#' no value is supplied, the feature id will be used.
#' @param highlighted_feature_id <`number` | `string`> When provided, a feature with ID
#' corresponding to the supplied value with be highlighted with `highlight_color`.
#' @param binary <`boolean`> Improves rendering performance by removing the tile serialisation
#' and deserialisation between worker and main thread.
#' @eval deckgl_docs("geo-layers", "mvt-layer")
#' @family geo-layers
#' @family layers
NULL
#' Simple Mesh Layer
#'
#' @name simple_mesh_layer
#' @inherit layer_props
#' @param mesh object
#' @eval deckgl_docs("mesh-layers", "simple-mesh-layer")
#' @family mesh-layers
#' @family layers
NULL
#' Scenegraph Layer
#'
#' @name scenegraph_layer
#' @inherit layer_props
#' @param scenegraph object
#' @param get_scene function
#' @param get_animator function
#' @eval deckgl_docs("mesh-layers", "scenegraph-layer")
#' @family mesh-layers
#' @family layers
NULL
#' @title layer_props
#' @name layer_props
#' @rdname _layer_props
#' @param rdeck <[`rdeck`] | [`rdeck_proxy`]> An rdeck map instance.
#' @param ... 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`.
#' @param 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.
#' @param 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.
#' @param group_name <`string`> Defines the group that this layer belongs to. Currently only
#' effective on the layer selector, if `visibility_toggle = TRUE`.
#' @param 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.
#' @param tooltip <[`tooltip`]> Defines the columns (and their order) that will be displayed in
#' the layer tooltip, if `pickable == TRUE`.
#' Supports [tidy-select](https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html) if a
#' `data` is a `data.frame`. Geometry columns are always removed.
#' @param data <`data.frame` | [`sf`][sf::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.
#' @param visible <`boolean`> Determines whether the layer is visible or not; also determines
#' whether any legend elements for the layer will be displayed.
#' @param visibility_toggle <`boolean`> Whether this layer will appear in the layer selector.
#' @param pickable <`boolean`> Determines if the layer responds to pointer / touch events.
#' @param opacity <`number`> Determines the layer's opacity.
#' @param position_format <`"XY"` | `"XYZ"`> Determines whether each coordinate has two (XY)
#' or three (XYZ) elements.
#' @param color_format <`"RGB"` | `"RGBA"`> Determines whether the alpha channel of the colours
#' will be ignored by accessors, making all colours opaque.
#' @param auto_highlight <`boolean`> When `TRUE`, the current object _hovered_ by the cursor is
#' highlighted by `highlight_color`.
#' @param 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](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param wrap_longitude <`boolean`> Normalises geometry longitudes.
#' @param get_source_position <[`accessor`]> The feature source positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_target_position <[`accessor`]> The feature target positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_source_color <[`accessor`] | [`scale`] | [`color`]> The colour of the
#' _source end_ of the arc.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_target_color <[`accessor`] | [`scale`] | [`color`]> The colour of the
#' _target end_ of the arc.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_width <[`accessor`] | [`scale`] | `number`> The width of each object, in units
#' specified by `width_scale`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_height <[`accessor`] | [`scale`] | `number`> The multiplier of layer of
#' layer height.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' A value of 0 will make the layer flat.
#' @param get_tilt <[`accessor`] | `number`> Tilts the arcs by the specified number of
#' degrees (between `c(-90, 90)`).
#' Accepts a single numeric value or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param great_circle <`boolean`> If `TRUE`, create the arc along the shortest path on the
#' earth surface.
#' @param radius_units <`"pixels"` | `"common"` | `"meters"`> The units of point radius.
#' @param width_units <`"pixels"` | `"common"` | `"meters"`> The units of the `line_width`.
#' @param width_scale <`number`> The scaling multiplier for the width of each line.
#' @param width_min_pixels <`number`> The minimum line width in pixels.
#' @param width_max_pixels <`number`> The maximum line width in pixels.
#' @param bounds <[`rct`][wk::rct]/[`st_bbox`][sf::st_bbox]/[`wk-geometry`]>
#' The bounds of the image to fit x,y coordinates into.
#' Requires CRS [EPSG:4326](http://epsg.io/4326).
#' @param size_scale <`number`> The size multiplier.
#' @param size_units <`"pixels"` | `"common"` | `"meters"`> The units of the size specified by
#' `get_size`.
#' @param size_min_pixels <`number`> The minimum size in pixels.
#' @param size_max_pixels <`number`> The maximum size in pixels.
#' @param get_position <[`accessor`]> The feature positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_color <[`accessor`] | [`scale`] | [`color`]> The colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_pixel_offset <[`accessor`] | `number`> The pixel offset for each object.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#' @param point_size <`number`> The radius of all points in units specified
#' by `size_units`.
#' @param material <`boolean`>
#' @param line_width_units <`"pixels"` | `"common"` | `"meters"`> The units of line width.
#' @param line_width_scale <`number`> The line width multiplier.
#' @param line_width_min_pixels <`number`> The minimum line width in pixels.
#' @param line_width_max_pixels <`number`> The maximum line width in pixels.
#' @param stroked <`boolean`> If `TRUE`, draw an outline around each object.
#' @param filled <`boolean`> If `TRUE`, draw the filled area of each point.
#' @param get_radius <[`accessor`] | [`scale`] | `number`> The radius of each point, in units
#' specified by `radius_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_fill_color <[`accessor`] | [`scale`] | [`color`]> The fill colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_line_color <[`accessor`] | [`scale`] | [`color`]> The line colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_line_width <[`accessor`] | [`scale`] | `number`> The outline of the object
#' in units specified by `line_width_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param disk_resolution <`number`> The number of sides to render the disk as. The disk
#' is a regular polygon that fits inside the given `radius`. A higher resolution will yield
#' a smoother look close-up, but also need more resources to render.
#' @param vertices `matrix` Replace the default geometry (regular polygon that fits inside the
#' unit circle) with a custom one. The length of the array must be at least `disk_resolution`.
#' Each vertex is a row `c(x, y)` that is the offset from the instance position, relative
#' to the radius.
#' @param radius <`number`> The radius of the object in metres.
#' @param angle <`number`> The disk rotation, counter-clockwise in radians.
#' @param offset <`number`> The disk offset from the position, relative to the radius.
#' @param coverage <`number`> Radius multiplier, between 0 - 1. The radius of each disk is
#' calculated by `coverage * radius`.
#' @param elevation_scale <`number`> The elevation multiplier.
#' @param extruded <`boolean`> If `TRUE`, extrude objects along the z-axis; if `FALSE`, all
#' objects will be flat.
#' @param wireframe <`boolean`> If `TRUE` and `extruded == TRUE`, draw a line wireframe of the
#' object. The outline will have horizontal lines closing the top and bottom polygons and
#' vertical lines for each vertex of the polygon.
#' @param get_elevation <[`accessor`] | [`scale`] | `number`> The elevation to extrude each
#' object in the z-axis. Height units are in metres.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param cell_size <`number`> The size of each cell in metres.
#' @param rounded <`boolean`> The type of joint. If `TRUE`, draw round joints, else draw mitre
#' joints.
#' @param miter_limit <`number`> The maximum extent of a joint in ratio to the stroke width.
#' Only applicable if `rounded == FALSE`.
#' @param get_path <[`accessor`]> The feature paths. A
#' `<linestring/multilinestring>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param cap_rounded <`boolean`> If `TRUE`, draw round caps; else draw square caps.
#' @param joint_rounded <`boolean`> If `TRUE`, draw round joints; else draw square joints.
#' @param line_joint_rounded <`boolean`>
#' @param line_miter_limit number
#' @param get_polygon <[`accessor`]> The feature polygons. A
#' `<polygon/multipolygon>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param point_type <`"circle"`|`"icon"`|`"text"`|combination>
#' Determines how to render point and multipoint features. May be one of:
#' - `"circle"`
#' - `"icon"`
#' - `"text"`
#'
#' Or a combination, separated by `"+"`, e.g. `"circle+text"`.
#' @param get_point_radius <[`accessor`] | [`scale`] | `number`> The radius of each point, in units
#' specified by `radius_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param point_radius_units <`"pixels"` | `"common"` | `"meters"`> The units of point radius.
#' @param point_radius_scale <`number`> The radius multiplier for all points.
#' @param point_radius_min_pixels <`number`> The minimum radius in pixels.
#' @param point_radius_max_pixels <`number`> The maximum radius in pixels.
#' @param desaturate <`number`> The desaturation of the bitmap. Between `0` and `1`, `being`
#' the original colour, `1` being greyscale.
#' @param transparent_color <[`color`]> The colour to use for transparent pixels.
#' @param tint_color <[`color`]> The colour to tint the bitmap by. Alpha channel is ignored
#' if supplied.
#' @param color_domain <`number`> The colour scale domain, default is set to the range
#' of aggregated weights in each bin.
#' @param color_range <[`color`]> The colour palette.
#' `color_domain` is divided into `length(color_range)` equal segments, each mapped to
#' one color in `color_range`.
#' @param get_weight <[`accessor`] | [`scale`] | `number`> The weight of each object.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param gpu_aggregation <`boolean`> If `TRUE`, aggregation is performed on GPU if supported.
#' Requires `WebGL2`.
#' @param aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Defines the aggregation function.
#' @param get_color_value <[`JS`][htmlwidgets::JS]> After data objects are aggregated into bins,
#' this accessor is called on each bin to get the value that its colour is based on. If supplied,
#' this will override the effect of `get_color_weight` and `color_aggregation` props.
#' See deck.gl docs for details.
#' @param get_color_weight <[`accessor`] | [`scale`] | `number`> The weight of each object used
#' to calculate the colour value for a bin.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param color_aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Operation used to
#' aggregate data values/weights to calculate a bin's colour.
#' @param lower_percentile <`number`> Between `0` and `100`. Filter bins and re-calculate colour
#' by `lower_percentile`. Cells with `value < lower_percentile` will be hidden.
#' @param upper_percentile <`number`> Between `0` and `100`. Filter bins and re-calculate colour
#' by `upper_percentile`. Cells with `value < upper_percentile` will be hidden.
#' @param color_scale_type <`"quantize"` | `"linear"` | `"quantile"` | `"ordinal"`> The scaling
#' function used to determine the colour of a the grid cell.
#' @param elevation_domain <`number`> The elevation scale input domain. Defaults to the range
#' of the aggregated weights in each bin.
#' @param elevation_range <`number`> The elevation scale output range.
#' @param get_elevation_value <[`JS`][htmlwidgets::JS]> After data objects are aggregated into
#' bins, this accessor is called on each bin to get the value that its elevation is based on.
#' If supplied, this will override the effect of `get_elevation_weight` and
#' `elevation_aggregation` props.
#' See deck.gl docs for details.
#' @param get_elevation_weight <[`accessor`] | [`scale`] | `numeric> The weight of each object used
#' to calculate the elevation value for a bin.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param elevation_aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Operation used to
#' aggregate data values/weights to calculate a bin's elevation value.
#' @param elevation_lower_percentile <`number`> Between `0` and `100`. Filter bins and
#' re-calculate elevation by `elevation_lower_percentile`.
#' Cells with `value < elevation_lower_percentile` will be hidden.
#' @param elevation_upper_percentile <`number`> Between `0` and `100`. Filter bins and
#' re-calculate elevation by `elevation_upper_percentile`.
#' Cells with `value < elevation_upper_percentile` will be hidden.
#' @param elevation_scale_type <`"quantize"` | `"linear"` | `"quantile"` | `"ordinal"`> The scaling
#' function used to determine the elevation of a the grid cell.
#' @param get_tile_data <[`JS`][htmlwidgets::JS]> retrieves the data of each tile.
#' See deck.gl [getTileData](https://deck.gl/docs/api-reference/geo-layers/tile-layer#gettiledata).
#' @param extent <`c(min_x, min_y, max_x, max_y)`> Tiles in this bounding box
#' will be rendered at `min_zoom`, when zoomed out below `min_zoom`.
#' @param tile_size <`number`> A power of 2 that is the pixel dimensions of the tile.
#' @param max_zoom <`number`> Tiles above this zoom level are not shown. Defaults to `NULL`.
#' @param min_zoom <`number`> Tiles below this zoom level are not shown. Defaults to `0`.
#' @param max_cache_size <`number`> Maximum number of tiles that can be cached. Defaults to
#' 5x the number of tiles in current viewport.
#' @param max_cache_byte_size <`number`> Maximum memory used for caching tiles.
#' @param refinement_strategy <`"best-available"` | `"no-overlap"` | `"never"`> How the tile
#' layer refines visibility of tiles. Defaults to `"best-available"`.
#' @param z_range <`c(min, max)`> Array representing the range of heights in the tile.
#' @param max_requests <`number`> Maximum number of concurrent HTTP
#' requests across all specified tile provider domains. If a negative number is
#' supplied no throttling occurs (HTTP/2 only).
#' @param zoom_offset <`int`> The offset changes the zoom level at which the tiles are fetched.
#' @param texture not yet supported.
#' @param get_orientation <[`accessor`]> not yet supported.
#' @param get_scale <[`accessor`]> not yet supported.
#' @param get_translation <[`accessor`]> not yet supported.
#' @param get_transform_matrix <[`accessor`]> not yet supported.
NULL
deckgl_docs <- function(module, name) {
version <- "8.7-release"
url <- file.path(
"https://github.com/visgl/deck.gl/blob",
version,
"docs/api-reference",
module,
paste0(name, ".md"),
fsep = "/"
)
paste0("@seealso <", url, ">")
}
anthonynorth/rdeck documentation built on Feb. 2, 2024, 1:12 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions deckgl_docs
#' Arc Layer
#'
#' @name arc_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "arc-layer")
#' @family core-layers
#' @family layers
NULL
#' Bitmap Layer
#'
#' @name bitmap_layer
#' @inherit layer_props
#' @param image <`string` | `array`> The image to display. Either a string interpreted as a
#' URL or Data URL, or an image bitmap.
#' @eval deckgl_docs("layers", "bitmap-layer")
#' @family core-layers
#' @family layers
NULL
#' Icon Layer
#'
#' @name icon_layer
#' @inherit layer_props
#' @param icon_atlas <`string`|`array`> The image sprite containing raster icons. Must
#' be either a string which is interpreted as a URL to an image, or an image bitmap.
#' @param icon_mapping <`string`|`list`> The image sprite index. Must be either a string
#' which is interpreted as a URL to a json document, or a named-list of icon descriptors.
#' See https://github.com/visgl/deck.gl/blob/master/docs/api-reference/layers/icon-layer.md#iconmapping-objectstring-optional
#' for icon descriptor fields.
#' @param billboard <`boolean`> If `TRUE`, the icon always faces the camera, otherwise it
#' faces up (z).
#' @param alpha_cutoff <`number`> Discard pixels whose opacity is below this threshold.
#' A discarded pixel would create a "hole" in the icon that is not considered part of
#' the object.
#' @param get_icon <[`accessor`]> The name of the icon for each feature. Icon name must be
#' present in the `icon_mapping`.
#' @param get_size <[`accessor`] | [`scale`] | `number`> The size of each icon,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_angle <[`accessor`] | `number`> The rotating angle of each icon in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @eval deckgl_docs("layers", "icon-layer")
#' @family core-layers
#' @family layers
NULL
#' Line Layer
#'
#' @name line_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "line-layer")
#' @family core-layers
#' @family layers
NULL
#' Point Cloud Layer
#'
#' @name point_cloud_layer
#' @inherit layer_props
#' @param get_normal <[`accessor`] | `numeric`> The normal of each object, in `c(nx, ny, nz)`.
#' Accepts a length-3 numeric vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) 3-column matrix column.
#' @eval deckgl_docs("layers", "point-cloud-layer")
#' @family core-layers
#' @family layers
NULL
#' Scatterplot Layer
#'
#' @name scatterplot_layer
#' @inherit layer_props
#' @param radius_scale <`number`> The radius multiplier for all points.
#' @param radius_min_pixels <`number`> The minimum radius in pixels.
#' @param radius_max_pixels <`number`> The maximum radius in pixels.
#' @param billboard <`boolean`> If `TRUE`, circles always face the camera;
#' if `FALSE` circles face up (z).
#' @param antialiasing <`boolean`> If `TRUE`, circles are rendered with smoothed
#' edges.
#' @eval deckgl_docs("layers", "scatterplot-layer")
#' @family core-layers
#' @family layers
NULL
#' Grid Cell Layer
#'
#' @name grid_cell_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "grid-cell-layer")
#' @family core-layers
#' @family layers
NULL
#' Column Layer
#'
#' @name column_layer
#' @inherit layer_props
#' @param radius <`number`> The radius of the column in metres.
#' @param line_width_units <`"pixels"` | `"common"` | `"meters"`> The units of outline width.
#' Applied when `extruded == FALSE` and `stroked == TRUE`.
#' @eval deckgl_docs("layers", "column-layer")
#' @family core-layers
#' @family layers
NULL
#' Path Layer
#'
#' @name path_layer
#' @inherit layer_props
#' @param billboard <`boolean`> If `TRUE`, extrude the path in screen space (width always faces)
#' the camera; if `FALSE`, the width always faces up (z).
#' @eval deckgl_docs("layers", "path-layer")
#' @family core-layers
#' @family layers
NULL
#' Polygon Layer
#'
#' @name polygon_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "polygon-layer")
#' @family core-layers
#' @family layers
NULL
#' Solid Polygon Layer
#'
#' @name solid_polygon_layer
#' @inherit layer_props
#' @eval deckgl_docs("layers", "solid-polygon-layer")
#' @family core-layers
#' @family layers
NULL
#' GeoJson Layer
#'
#' @name geojson_layer
#' @inherit layer_props
#' @inherit icon_layer
#' @inherit text_layer
#' @param data <[`sf`][sf::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 to geojson data that will be retrieved dynamically in the browser.
#'
#' @param line_billboard <`boolean`> If `TRUE`, extrude the path in screen space (width always faces)
#' the camera; if `FALSE`, the width always faces up (z).
#' @param line_cap_rounded <`boolean`> If `TRUE`, draw round caps; else draw square caps.
#' @param line_joint_rounded <`boolean`> If `TRUE`, draw round joints; else draw square joints.
#'
#' @param point_antialiasing <`boolean`> If `TRUE`, circles are rendered with smoothed
#' edges.
#' @param point_billboard <`boolean`> If `TRUE`, circles always face the camera;
#' if `FALSE` circles face up (z).
#'
#' @param icon_size_scale <`number`> The icon size multiplier.
#' @param icon_size_units <`"pixels"` | `"common"` | `"meters"`> The units of the icon size specified by
#' `get_icon_size`.
#' @param icon_size_min_pixels <`number`> The minimum icon size in pixels.
#' @param icon_size_max_pixels <`number`> The maximum icon size in pixels.
#' @param icon_billboard <`boolean`> If `TRUE`, the icon always faces the camera, otherwise it
#' faces up (z).
#' @param icon_alpha_cutoff <`number`> Discard icon pixels whose opacity is below this threshold.
#' A discarded pixel would create a "hole" in the icon that is not considered part of
#' the object.
#' @param get_icon_size <[`accessor`] | [`scale`] | `number`> The size of each icon,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_icon_color <[`accessor`] | [`scale`] | [`color`]> The colour of each icon.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_icon_angle <[`accessor`] | `number`> The rotating angle of each icon in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_icon_pixel_offset <[`accessor`] | `number`> The pixel offset for each icon.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#'
#' @param text_size_scale <`number`> The text label size multiplier.
#' @param text_size_units <`"pixels"` | `"common"` | `"meters"`> The units of the text label
#' size, specified by `get_text_size`.
#' @param text_size_min_pixels <`number`> The minimum text label size in pixels.
#' @param text_size_max_pixels <`number`> The maximum text label size in pixels.
#' @param text_billboard <`boolean`> If `TRUE`, the text label always faces the camera, otherwise it
#' faces up (z).
#' @param text_background <`boolean`> Whether to render background for text labels.
#' @param text_background_padding <`numeric`> The text background padding. Must be an array of 2 or
#' 4 numbers.
#' @param text_font_family <`string`> Specifies a prioritised list of one or more font family names.
#' See [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family).
#' @param text_font_weight <`"normal"` | `"bold"` | `100:900`> The font weight. See
#' [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight)
#' @param text_line_height <`number`> A unitless number that will be multiplied with `get_size`
#' to set the line height.
#' @param text_font_settings <`font_settings`> Advanced options for fine tuning the appearance
#' and performance of the generated `font_atlas`.
#' @param text_word_break <`"break-word"` | `"break-all"`> Requires a valid `text_max_width`.
#' @param text_max_width <`number`> Used together with `text_word_break` for wrapping text. Specifies
#' the width limit to break the text into multiple lines.
#' @param text_outline_width <`number`> The text outline width, relative to font size. Requires
#' `text_font_settings$sdf = TRUE`.
#' @param text_outline_color <[`color`]> The text outline colour. Requires `text_font_settings$sdf = TRUE`.
#' @param get_text_size <[`accessor`] | [`scale`] | `number`> The font size of each text label,
#' in units specified by `text_size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_color <[`accessor`] | [`scale`] | [`color`]> The colour of each text label.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_angle <[`accessor`] | `number`> The rotating angle of each text label in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_alignment_baseline <[`accessor`] | `"top"` | `"center"` | `"bottom"`> The text
#' label alignment baseline. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_text_pixel_offset <[`accessor`] | `number`> The pixel offset for each text label.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#' @param get_text_background_color <[`accessor`] | [`scale`] | [`color`]> The text background colour,
#' if `text_background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_border_color <[`accessor`] | [`scale`] | [`color`]> The text background border colour,
#' if `text_background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_text_border_width <[`accessor`] | [`scale`] | `number`> The text background border width,
#' if `text_background = TRUE`. Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#'
#' @eval deckgl_docs("layers", "geojson-layer")
#' @family core-layers
#' @family layers
NULL
#' Text Layer
#'
#' @name text_layer
#' @inherit layer_props
#' @param billboard <`boolean`> If `TRUE`, the text label always faces the camera, otherwise it
#' faces up (z).
#' @param background <`boolean`> Whether to render background for text labels.
#' @param background_padding <`numeric`> The text background padding. Must be an array of 2 or
#' 4 numbers.
#' @param font_family <`string`> Specifies a prioritised list of one or more font family names.
#' See [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family).
#' @param font_weight <`"normal"` | `"bold"` | `100:900`> The font weight. See
#' [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight)
#' @param line_height <`number`> A unitless number that will be multiplied with `get_size`
#' to set the line height.
#' @param font_settings <`font_settings`> Advanced options for fine tuning the appearance
#' and performance of the generated `font_atlas`.
#' @param word_break <`"break-word"` | `"break-all"`> Requires a valid `max_width`.
#' @param max_width <`number`> Used together with `word_break` for wrapping text. Specifies
#' the width limit to break the text into multiple lines.
#' @param outline_width <`number`> The text outline width, relative to font size. Requires
#' `font_settings$sdf = TRUE`.
#' @param outline_color <[`color`]> The text outline colour. Requires `font_settings$sdf = TRUE`.
#' @param get_text <[`accessor`]> The text value of each text label. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column of
#' labels.
#' @param get_size <[`accessor`] | [`scale`] | `number`> The font size of each text label,
#' in units specified by `size_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_angle <[`accessor`] | `number`> The rotating angle of each text label in degrees.
#' Accepts a single numeric value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_text_anchor <[`accessor`] | `"start"` | `"middle"` | `"end"`> The text label
#' anchor. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_alignment_baseline <[`accessor`] | `"top"` | `"center"` | `"bottom"`> The text
#' label alignment baseline. May be a single value, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @param get_background_color <[`accessor`] | [`scale`] | [`color`]> The text background colour,
#' if `background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_border_color <[`accessor`] | [`scale`] | [`color`]> The text background border colour,
#' if `background = TRUE`. Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_border_width <[`accessor`] | [`scale`] | `number`> The text background border width,
#' if `background = TRUE`. Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @eval deckgl_docs("layers", "text-layer")
#' @family core-layers
#' @family layers
NULL
#' Screen Grid Layer
#'
#' @name screen_grid_layer
#' @inherit layer_props
#' @param cell_size_pixels <`number`> Unit width / height of the bins.
#' @param cell_margin_pixels <`number`> Cell margin size in pixels.
#' @eval deckgl_docs("aggregation-layers", "screen-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' CPU Grid Layer
#'
#' @name cpu_grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "cpu-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Hexagon Layer
#'
#' @name hexagon_layer
#' @inherit layer_props
#' @param radius <`number`> The radius of the hexagon bin in metres.
#' @eval deckgl_docs("aggregation-layers", "hexagon-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Contour Layer
#'
#' @name contour_layer
#' @inherit layer_props
#' @param contours array
#' @param z_offset <`number`> A very small z offset that is added for each vertex of a
#' contour (isoline or isoband). Needed to control the layout of the contours.
#' See deck.gl [contours](https://deck.gl/docs/api-reference/aggregation-layers/contour-layer#contours)
#' @eval deckgl_docs("aggregation-layers", "contour-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Grid Layer
#'
#' @name grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' GPU Grid Layer
#'
#' @name gpu_grid_layer
#' @inherit layer_props
#' @eval deckgl_docs("aggregation-layers", "gpu-grid-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Heatmap Layer
#'
#' @name heatmap_layer
#' @inherit layer_props
#' @param intensity <`number`> Value that is multiplied with the total weight at a pixel to
#' obtain the final weight. A value > `1` biases the output colour towards the higher end
#' of the `color_range`, and a value < `1` biases the output towards the lower end of the
#' `color_range`.
#' @param radius_pixels <`number`> The radius of the circle in pixels.
#' @param threshold <`number`> Larger threshold values creates smoother boundaries of colour
#' _blobs_, while making pixels with low weight values more transparent.
#' Ignored when `color_domain` is specified.
#' @param weights_texture_size <`number`> The size of the weight texture. Smaller texture
#' sizes can improve rendering performance, but lead to visible pixelation.
#' @param debounce_timeout <`number`> Debounce interval (milliseconds) for triggering
#' aggregation.
#' @eval deckgl_docs("aggregation-layers", "heatmap-layer")
#' @family aggregation-layers
#' @family layers
NULL
#' Great Circle Layer
#'
#' @name great_circle_layer
#' @inherit layer_props
#' @eval deckgl_docs("geo-layers", "great-circle-layer")
#' @family geo-layers
#' @family layers
NULL
#' S2 Layer
#'
#' @name s2_layer
#' @inherit layer_props
#' @param get_s2_token <[`accessor`]> The S2 hex token for each S2 cell. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @eval deckgl_docs("geo-layers", "s2-layer")
#' @family geo-layers
#' @family layers
NULL
#' H3 Cluster Layer
#'
#' @name h3_cluster_layer
#' @inherit layer_props
#' @param get_hexagons <[`accessor`]>
#' @eval deckgl_docs("geo-layers", "h3-cluster-layer")
#' @family geo-layers
#' @family layers
NULL
#' H3 Hexagon Layer
#'
#' @name h3_hexagon_layer
#' @inherit layer_props
#' @param high_precision <`boolean`> If `TRUE`, draw each hexagon as a polygon using each
#' hexagon's true geometry. If `FALSE`, draw each hexagon with the same shape as
#' `center_hexagon`. High precision trades rendering performance for geometry precision.
#' High precision is required (forcibly enabled) when:
#'
#' - Rendering hex resolutions in range `c(0, 5)`
#' - Pentagons are present in the data
#' - Multiple resolution hexes are present in the data
#' @param center_hexagon <`string`> If `high_precision == FALSE`, defines the H3 hexagon
#' that will be used as the shape of all hexagons in the layer. Defaults to the hexagon in
#' the centre of the viewport.
#' @param get_hexagon <[`accessor`]> The H3 hex token for each H3 hexagon. Accepts a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) character column.
#' @eval deckgl_docs("geo-layers", "h3-hexagon-layer")
#' @family geo-layers
#' @family layers
NULL
#' Quadkey Layer
#'
#' @name quadkey_layer
#' @inherit layer_props
#' @param get_quadkey <`accessor`> The column containing the quadkey identifier.
#' @eval deckgl_docs("geo-layers", "quadkey-layer")
#' @family geo-layers
#' @family layers
NULL
#' Tile Layer
#'
#' @name tile_layer
#' @inherit layer_props
#' @param data <`character`> A character vector of raster tile url templates.
#' Substrings `"{x}"`, `"{y}"`, `"{z}"` will be replaced with a tile's actual index on
#' request.
#'
#' If multiple url templates are supplied, each endpoint must return the same data for the
#' same tile index.
#' @eval deckgl_docs("geo-layers", "tile-layer")
#' @family geo-layers
#' @family layers
NULL
#' Trips Layer
#'
#' @name trips_layer
#' @inherit path_layer
#' @param fade_trail <`boolean`> Whether or not the path fades out.
#' @param trail_length <`number`> The number of seconds for a path to completely fade out.
#' @param get_timestamps <[`accessor`]> The timestamps for each _trip_. For each trip,
#' each timestamp corresponds to a position in the linestring returned by `get_path`,
#' representing the time at which that position was visited.
#'
#' Accepts a [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html)
#' list column of numbers.
#' @param loop_length <`number`> The number of seconds to complete an animation loop.
#' @param animation_speed <`number`> The animation speed multiplier.
#' @eval deckgl_docs("geo-layers", "trips-layer")
#' @family geo-layers
#' @family layers
NULL
#' Tile 3D Layer
#'
#' @name tile_3d_layer
#' @inherit layer_props
#' @param get_point_color <[`color`]> The colour of each object.
#' @param loader object
#' @eval deckgl_docs("geo-layers", "tile3d-layer")
#' @family geo-layers
#' @family layers
NULL
#' Terrain Layer
#'
#' @name terrain_layer
#' @inherit layer_props
#' @param elevation_data url
#' @param mesh_max_error number
#' @param bounds <[`rct`][wk::rct]/[`st_bbox`][sf::st_bbox]/[`wk-geometry`]>
#' The bounds of the image to fit x,y coordinates into.
#' Requires CRS [EPSG:4326](http://epsg.io/4326).
#' Must be supplied when using non-tiled elevation data.
#' @param color color
#' @param elevation_decoder object
#' @param worker_url string
#' @eval deckgl_docs("geo-layers", "terrain-layer")
#' @family geo-layers
#' @family layers
NULL
#' MVT Layer
#'
#' @name mvt_layer
#' @inherit layer_props
#' @inherit geojson_layer
#' @param data <`character` | [`tile_json`]> Defines the remote data for the layer. May take any of:
#' - A [tile_json()] object
#' - A `string` which is a valid URL to a [tilejson](https://docs.mapbox.com/help/glossary/tilejson)
#' - A `character` vector of tile url templates, each containing placeholders for tile coordinates: `{z}/{x}/{y}`
#' @param unique_id_property <`string`> Used for highlighting features across tiles. Features
#' on separate tiles are deemed to be _the same feature_ by the supplied property name. If
#' no value is supplied, the feature id will be used.
#' @param highlighted_feature_id <`number` | `string`> When provided, a feature with ID
#' corresponding to the supplied value with be highlighted with `highlight_color`.
#' @param binary <`boolean`> Improves rendering performance by removing the tile serialisation
#' and deserialisation between worker and main thread.
#' @eval deckgl_docs("geo-layers", "mvt-layer")
#' @family geo-layers
#' @family layers
NULL
#' Simple Mesh Layer
#'
#' @name simple_mesh_layer
#' @inherit layer_props
#' @param mesh object
#' @eval deckgl_docs("mesh-layers", "simple-mesh-layer")
#' @family mesh-layers
#' @family layers
NULL
#' Scenegraph Layer
#'
#' @name scenegraph_layer
#' @inherit layer_props
#' @param scenegraph object
#' @param get_scene function
#' @param get_animator function
#' @eval deckgl_docs("mesh-layers", "scenegraph-layer")
#' @family mesh-layers
#' @family layers
NULL
#' @title layer_props
#' @name layer_props
#' @rdname _layer_props
#' @param rdeck <[`rdeck`] | [`rdeck_proxy`]> An rdeck map instance.
#' @param ... 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`.
#' @param 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.
#' @param 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.
#' @param group_name <`string`> Defines the group that this layer belongs to. Currently only
#' effective on the layer selector, if `visibility_toggle = TRUE`.
#' @param 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.
#' @param tooltip <[`tooltip`]> Defines the columns (and their order) that will be displayed in
#' the layer tooltip, if `pickable == TRUE`.
#' Supports [tidy-select](https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html) if a
#' `data` is a `data.frame`. Geometry columns are always removed.
#' @param data <`data.frame` | [`sf`][sf::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.
#' @param visible <`boolean`> Determines whether the layer is visible or not; also determines
#' whether any legend elements for the layer will be displayed.
#' @param visibility_toggle <`boolean`> Whether this layer will appear in the layer selector.
#' @param pickable <`boolean`> Determines if the layer responds to pointer / touch events.
#' @param opacity <`number`> Determines the layer's opacity.
#' @param position_format <`"XY"` | `"XYZ"`> Determines whether each coordinate has two (XY)
#' or three (XYZ) elements.
#' @param color_format <`"RGB"` | `"RGBA"`> Determines whether the alpha channel of the colours
#' will be ignored by accessors, making all colours opaque.
#' @param auto_highlight <`boolean`> When `TRUE`, the current object _hovered_ by the cursor is
#' highlighted by `highlight_color`.
#' @param 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](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param wrap_longitude <`boolean`> Normalises geometry longitudes.
#' @param get_source_position <[`accessor`]> The feature source positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_target_position <[`accessor`]> The feature target positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_source_color <[`accessor`] | [`scale`] | [`color`]> The colour of the
#' _source end_ of the arc.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_target_color <[`accessor`] | [`scale`] | [`color`]> The colour of the
#' _target end_ of the arc.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_width <[`accessor`] | [`scale`] | `number`> The width of each object, in units
#' specified by `width_scale`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_height <[`accessor`] | [`scale`] | `number`> The multiplier of layer of
#' layer height.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' A value of 0 will make the layer flat.
#' @param get_tilt <[`accessor`] | `number`> Tilts the arcs by the specified number of
#' degrees (between `c(-90, 90)`).
#' Accepts a single numeric value or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param great_circle <`boolean`> If `TRUE`, create the arc along the shortest path on the
#' earth surface.
#' @param radius_units <`"pixels"` | `"common"` | `"meters"`> The units of point radius.
#' @param width_units <`"pixels"` | `"common"` | `"meters"`> The units of the `line_width`.
#' @param width_scale <`number`> The scaling multiplier for the width of each line.
#' @param width_min_pixels <`number`> The minimum line width in pixels.
#' @param width_max_pixels <`number`> The maximum line width in pixels.
#' @param bounds <[`rct`][wk::rct]/[`st_bbox`][sf::st_bbox]/[`wk-geometry`]>
#' The bounds of the image to fit x,y coordinates into.
#' Requires CRS [EPSG:4326](http://epsg.io/4326).
#' @param size_scale <`number`> The size multiplier.
#' @param size_units <`"pixels"` | `"common"` | `"meters"`> The units of the size specified by
#' `get_size`.
#' @param size_min_pixels <`number`> The minimum size in pixels.
#' @param size_max_pixels <`number`> The maximum size in pixels.
#' @param get_position <[`accessor`]> The feature positions. A
#' `<point/multipoint>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param get_color <[`accessor`] | [`scale`] | [`color`]> The colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_pixel_offset <[`accessor`] | `number`> The pixel offset for each object.
#' Accepts a single length-2 `numeric` vector, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) list column.
#' @param point_size <`number`> The radius of all points in units specified
#' by `size_units`.
#' @param material <`boolean`>
#' @param line_width_units <`"pixels"` | `"common"` | `"meters"`> The units of line width.
#' @param line_width_scale <`number`> The line width multiplier.
#' @param line_width_min_pixels <`number`> The minimum line width in pixels.
#' @param line_width_max_pixels <`number`> The maximum line width in pixels.
#' @param stroked <`boolean`> If `TRUE`, draw an outline around each object.
#' @param filled <`boolean`> If `TRUE`, draw the filled area of each point.
#' @param get_radius <[`accessor`] | [`scale`] | `number`> The radius of each point, in units
#' specified by `radius_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param get_fill_color <[`accessor`] | [`scale`] | [`color`]> The fill colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_line_color <[`accessor`] | [`scale`] | [`color`]> The line colour of each object.
#' Accepts a single colour value, a colour scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of colours.
#' @param get_line_width <[`accessor`] | [`scale`] | `number`> The outline of the object
#' in units specified by `line_width_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param disk_resolution <`number`> The number of sides to render the disk as. The disk
#' is a regular polygon that fits inside the given `radius`. A higher resolution will yield
#' a smoother look close-up, but also need more resources to render.
#' @param vertices `matrix` Replace the default geometry (regular polygon that fits inside the
#' unit circle) with a custom one. The length of the array must be at least `disk_resolution`.
#' Each vertex is a row `c(x, y)` that is the offset from the instance position, relative
#' to the radius.
#' @param radius <`number`> The radius of the object in metres.
#' @param angle <`number`> The disk rotation, counter-clockwise in radians.
#' @param offset <`number`> The disk offset from the position, relative to the radius.
#' @param coverage <`number`> Radius multiplier, between 0 - 1. The radius of each disk is
#' calculated by `coverage * radius`.
#' @param elevation_scale <`number`> The elevation multiplier.
#' @param extruded <`boolean`> If `TRUE`, extrude objects along the z-axis; if `FALSE`, all
#' objects will be flat.
#' @param wireframe <`boolean`> If `TRUE` and `extruded == TRUE`, draw a line wireframe of the
#' object. The outline will have horizontal lines closing the top and bottom polygons and
#' vertical lines for each vertex of the polygon.
#' @param get_elevation <[`accessor`] | [`scale`] | `number`> The elevation to extrude each
#' object in the z-axis. Height units are in metres.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param cell_size <`number`> The size of each cell in metres.
#' @param rounded <`boolean`> The type of joint. If `TRUE`, draw round joints, else draw mitre
#' joints.
#' @param miter_limit <`number`> The maximum extent of a joint in ratio to the stroke width.
#' Only applicable if `rounded == FALSE`.
#' @param get_path <[`accessor`]> The feature paths. A
#' `<linestring/multilinestring>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param cap_rounded <`boolean`> If `TRUE`, draw round caps; else draw square caps.
#' @param joint_rounded <`boolean`> If `TRUE`, draw round joints; else draw square joints.
#' @param line_joint_rounded <`boolean`>
#' @param line_miter_limit number
#' @param get_polygon <[`accessor`]> The feature polygons. A
#' `<polygon/multipolygon>` [wk-geometry] column with CRS [EPSG:4326](http://epsg.io/4326).
#' Supports [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html).
#' @param point_type <`"circle"`|`"icon"`|`"text"`|combination>
#' Determines how to render point and multipoint features. May be one of:
#' - `"circle"`
#' - `"icon"`
#' - `"text"`
#'
#' Or a combination, separated by `"+"`, e.g. `"circle+text"`.
#' @param get_point_radius <[`accessor`] | [`scale`] | `number`> The radius of each point, in units
#' specified by `radius_units`.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param point_radius_units <`"pixels"` | `"common"` | `"meters"`> The units of point radius.
#' @param point_radius_scale <`number`> The radius multiplier for all points.
#' @param point_radius_min_pixels <`number`> The minimum radius in pixels.
#' @param point_radius_max_pixels <`number`> The maximum radius in pixels.
#' @param desaturate <`number`> The desaturation of the bitmap. Between `0` and `1`, `being`
#' the original colour, `1` being greyscale.
#' @param transparent_color <[`color`]> The colour to use for transparent pixels.
#' @param tint_color <[`color`]> The colour to tint the bitmap by. Alpha channel is ignored
#' if supplied.
#' @param color_domain <`number`> The colour scale domain, default is set to the range
#' of aggregated weights in each bin.
#' @param color_range <[`color`]> The colour palette.
#' `color_domain` is divided into `length(color_range)` equal segments, each mapped to
#' one color in `color_range`.
#' @param get_weight <[`accessor`] | [`scale`] | `number`> The weight of each object.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param gpu_aggregation <`boolean`> If `TRUE`, aggregation is performed on GPU if supported.
#' Requires `WebGL2`.
#' @param aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Defines the aggregation function.
#' @param get_color_value <[`JS`][htmlwidgets::JS]> After data objects are aggregated into bins,
#' this accessor is called on each bin to get the value that its colour is based on. If supplied,
#' this will override the effect of `get_color_weight` and `color_aggregation` props.
#' See deck.gl docs for details.
#' @param get_color_weight <[`accessor`] | [`scale`] | `number`> The weight of each object used
#' to calculate the colour value for a bin.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param color_aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Operation used to
#' aggregate data values/weights to calculate a bin's colour.
#' @param lower_percentile <`number`> Between `0` and `100`. Filter bins and re-calculate colour
#' by `lower_percentile`. Cells with `value < lower_percentile` will be hidden.
#' @param upper_percentile <`number`> Between `0` and `100`. Filter bins and re-calculate colour
#' by `upper_percentile`. Cells with `value < upper_percentile` will be hidden.
#' @param color_scale_type <`"quantize"` | `"linear"` | `"quantile"` | `"ordinal"`> The scaling
#' function used to determine the colour of a the grid cell.
#' @param elevation_domain <`number`> The elevation scale input domain. Defaults to the range
#' of the aggregated weights in each bin.
#' @param elevation_range <`number`> The elevation scale output range.
#' @param get_elevation_value <[`JS`][htmlwidgets::JS]> After data objects are aggregated into
#' bins, this accessor is called on each bin to get the value that its elevation is based on.
#' If supplied, this will override the effect of `get_elevation_weight` and
#' `elevation_aggregation` props.
#' See deck.gl docs for details.
#' @param get_elevation_weight <[`accessor`] | [`scale`] | `numeric> The weight of each object used
#' to calculate the elevation value for a bin.
#' Accepts a single numeric value, a numeric scale, or a
#' [tidy-eval](https://dplyr.tidyverse.org/articles/programming.html) column of numbers.
#' @param elevation_aggregation <`"SUM"` | `"MEAN"` | `"MIN"` | `"MAX"`> Operation used to
#' aggregate data values/weights to calculate a bin's elevation value.
#' @param elevation_lower_percentile <`number`> Between `0` and `100`. Filter bins and
#' re-calculate elevation by `elevation_lower_percentile`.
#' Cells with `value < elevation_lower_percentile` will be hidden.
#' @param elevation_upper_percentile <`number`> Between `0` and `100`. Filter bins and
#' re-calculate elevation by `elevation_upper_percentile`.
#' Cells with `value < elevation_upper_percentile` will be hidden.
#' @param elevation_scale_type <`"quantize"` | `"linear"` | `"quantile"` | `"ordinal"`> The scaling
#' function used to determine the elevation of a the grid cell.
#' @param get_tile_data <[`JS`][htmlwidgets::JS]> retrieves the data of each tile.
#' See deck.gl [getTileData](https://deck.gl/docs/api-reference/geo-layers/tile-layer#gettiledata).
#' @param extent <`c(min_x, min_y, max_x, max_y)`> Tiles in this bounding box
#' will be rendered at `min_zoom`, when zoomed out below `min_zoom`.
#' @param tile_size <`number`> A power of 2 that is the pixel dimensions of the tile.
#' @param max_zoom <`number`> Tiles above this zoom level are not shown. Defaults to `NULL`.
#' @param min_zoom <`number`> Tiles below this zoom level are not shown. Defaults to `0`.
#' @param max_cache_size <`number`> Maximum number of tiles that can be cached. Defaults to
#' 5x the number of tiles in current viewport.
#' @param max_cache_byte_size <`number`> Maximum memory used for caching tiles.
#' @param refinement_strategy <`"best-available"` | `"no-overlap"` | `"never"`> How the tile
#' layer refines visibility of tiles. Defaults to `"best-available"`.
#' @param z_range <`c(min, max)`> Array representing the range of heights in the tile.
#' @param max_requests <`number`> Maximum number of concurrent HTTP
#' requests across all specified tile provider domains. If a negative number is
#' supplied no throttling occurs (HTTP/2 only).
#' @param zoom_offset <`int`> The offset changes the zoom level at which the tiles are fetched.
#' @param texture not yet supported.
#' @param get_orientation <[`accessor`]> not yet supported.
#' @param get_scale <[`accessor`]> not yet supported.
#' @param get_translation <[`accessor`]> not yet supported.
#' @param get_transform_matrix <[`accessor`]> not yet supported.
NULL
deckgl_docs <- function(module, name) {
version <- "8.7-release"
url <- file.path(
"https://github.com/visgl/deck.gl/blob",
version,
"docs/api-reference",
module,
paste0(name, ".md"),
fsep = "/"
)
paste0("@seealso <", url, ">")
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.