ly_polygons: Add a "polygons" layer to a Bokeh figure

Description Usage Arguments Details Handling color Handling alpha Additional parameters See Also

View source: R/layer_shapes.R

Description

Add a "polygons" layer to a Bokeh figure

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
ly_polygons(
  fig,
  xs,
  ys,
  group = NULL,
  data = figure_data(fig),
  color = NULL,
  alpha = 1,
  hover = NULL,
  url = NULL,
  lname = NULL,
  lgroup = NULL,
  ...
)

Arguments

fig

figure to modify

xs

vector or list of values or field name of polygon x coordinates - see details

ys

vector or list of values or field name of polygon y coordinates - see details

group

vector or field name of grouping variable - see details

data

an optional data frame, providing the source for inputs xs, ys, group, and other glyph properties

color

color for the glyph - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo' - for glyphs with both fill and line properties, see "Handling color" below

alpha

the alpha transparency of the glyph between 0 (transparent) and 1 (opaque) - if glyph has both fill and color properties, see "Handling alpha" below

hover

a data frame of variables to be displayed when hovering over the glyph or a vector of variable names that can be found and extracted from the data argument

url

a string of URLs or a single string that references a variable name (via @var_name) that can be found and extracted from the data argument

lname

layer name

lgroup

layer group

...

additional parameters for fine control over fill and line properties (see "Additional parameters" below)

Details

xs and ys can be a list of vectors, each element for one polygon to be drawn, or can be vectors with the group argument specifying how to break them up into individual polygons.

Handling color

The color parameter is a high-level plot attribute that provides default behavior for coloring glyphs.

When color is NULL and fill_color or line_color are not specified, the color will be chosen from the theme.

Handling alpha

The alpha is a high-level plot attribute that sets the transparency of the glyph being plotted.

Additional parameters

fill_color color to use to fill the glyph with - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo'
fill_alpha transparency value between 0 (transparent) and 1 (opaque)
line_color color to use to stroke lines with - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo'
line_width stroke width in units of pixels
line_alpha transparency value between 0 (transparent) and 1 (opaque)
line_join how path segments should be joined together 'miter' 'round' 'bevel'
line_cap how path segments should be terminated 'butt' 'round' 'square'
line_dash array of integer pixel distances that describe the on-off pattern of dashing to use
line_dash_offset the distance in pixels into the line_dash that the pattern should start from

See Also

Other layer functions: ly_abline(), ly_annular_wedge(), ly_annulus(), ly_arc(), ly_bar(), ly_bezier(), ly_boxplot(), ly_contour(), ly_crect(), ly_curve(), ly_density(), ly_hist(), ly_image_url(), ly_image(), ly_lines(), ly_map(), ly_multi_line(), ly_oval(), ly_patch(), ly_points(), ly_quadratic(), ly_quantile(), ly_ray(), ly_rect(), ly_segments(), ly_text(), ly_wedge()


rbokeh documentation built on Aug. 4, 2021, 1:06 a.m.