ly_polygons {rbokeh}R Documentation

Add a "polygons" layer to a Bokeh figure

Description

Add a "polygons" layer to a Bokeh figure

Usage

ly_polygons(fig, xs = NULL, ys = NULL, data = figure_data(fig),
  type = 1, width = 1, color = NULL, alpha = NULL, hover = NULL,
  legend = TRUE, hov_color = NULL, hov_alpha = NULL, ns_color = NULL,
  ns_alpha = NULL, sel_color = NULL, sel_alpha = NULL, lgroup = NULL,
  lname = 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.

data

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

type

An integer between 1 and 6 matching the lty property in par or an array of integer pixel distances that describe the on-off pattern of dashing to use.

width

Stroke width in units of pixels.

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 the 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, a vector of variable names that can be found and extracted from the data argument, a string specifying the tooltip text (see hov for details) or an explicit hover specification returned from calling hov. See hov for more details for some examples.

legend

Either a logical specifying not to plot a legend for this layer (FALSE) or a string indicating the name of the legend entry for this layer. Note that when mapping plot attributes to variables in data, a legend is automatically created and does not need to be specified. See "Mapped plot attributes and legends" below.

hov_color

Color for the glyph when it is hovered The same rules in the "Handling color" section apply.

hov_alpha

The alpha transparency of the glyph when it is not hovered The same rules in the "Handling alpha" section apply.

ns_color

Color for the glyph when it is not selected The same rules in the "Handling color" section apply.

ns_alpha

The alpha transparency of the glyph when it is not not selected The same rules in the "Handling alpha" section apply.

sel_color

Color for the glyph when it is selected. The same rules in the "Handling color" section apply.

sel_alpha

The alpha transparency of the glyph when it is not selected. The same rules in the "Handling alpha" section apply.

lgroup

Layer group.

lname

Layer name.

...

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.

Mapped plot attributes and legends

When specifying an input data frame for a layer through the data argument, columns of data can be used to specify various plot attributes such as color, etc. For example, with ly_points(..., data = iris, color = Species), the Species variable is used to determine how to color the points. Here, Species is "mapped" to the color attribute. Both continuous and categorical variables can be mapped. In the case of continuous variables, the range is cut into slices and attributes are applied to each interval. The mapping from the values of the variable to the actual plot attributes is determined based on the theme. When attributes are mapped, legend entries are automatically created for the mappings (when possible).

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_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_multi_line, ly_oval, ly_patch, ly_points, ly_quadratic, ly_quantile, ly_ray, ly_rect, ly_segments, ly_text, ly_wedge

Examples

xs <- list()
ys <- list()
for (i in 1:500) {
  count <- sample(1:10, 1)
  angles <- runif(count + 1, 0, 2 * pi)
  x_dists <- (1 / 2) ^ (0:count) * cos(angles)
  y_dists <- (1 / 2) ^ (0:count) * sin(angles)
  xs[[length(xs) + 1]] <- c(cumsum(x_dists))
  ys[[length(ys) + 1]] <- c(cumsum(y_dists))
}

figure() %>%
  ly_polygons(xs = xs, ys = ys, hover = data.frame(a = 1:500))

figure(xaxes = FALSE, yaxes = FALSE, xgrid = FALSE, ygrid = FALSE, tools = NULL) %>%
  ly_polygons(xs = xs, ys = ys,
    color = sample(c("a", "b", "c", "d"), 500, replace = TRUE), legend = FALSE,
    line_alpha = 0.5)

figure() %>%
  ly_polygons(xs = xs, ys = ys,
    color = asis(sample(c("red", "blue"), 500, replace = TRUE)))

[Package rbokeh version 0.6.3 Index]