ann_band {rbokeh} | R Documentation |
Add a "band" annotation (filled area band) to a Bokeh figure
ann_band(fig, base = NULL, lower = NULL, upper = NULL, base_units = NULL, lower_units = NULL, upper_units = NULL, dimension = c("height", "width"), color = NULL, alpha = NULL, data = figure_data(fig), line_width = NULL, line_dash = NULL, line_dash_offset = NULL, line_join = NULL, line_cap = NULL, lgroup = NULL, lname = NULL, ...)
fig |
Figure to modify. |
base |
The orthogonal coordinates of the upper and lower values. |
lower |
The coordinates of the lower portion of the filled area band. |
upper |
The coordinations of the upper portion of the filled area band. |
base_units |
Either "screen" or "data". |
lower_units |
Either "screen" or "data". |
upper_units |
Either "screen" or "data". |
dimension |
The direction of the band. |
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. |
data |
An optional data frame supplying data to which other parameters can refer. |
line_width |
The line width values for the band. |
line_dash |
The line dash values for the band. |
line_dash_offset |
The line dash offset values for the band. |
line_join |
The line join values for the band. |
line_cap |
The line cap values for the band.> |
lgroup |
Layer group. |
lname |
Layer name. |
... |
additional parameters for fine control over fill and line properties (see "Additional parameters" below) |
The color
parameter is a high-level plot attribute that provides default behavior for coloring glyphs.
When using a glyph that only has line properties, this will be the color of the line.
When using a glyph that has has line and fill properties, this will be the color of the line and the fill, with the alpha level of the fill reduced by 50%.
If full control over fill and line color is desired, the fill_color
and line_color
attributes can be specified explicitly and will override color
.
When color is NULL
and fill_color
or line_color
are not specified, the color will be chosen from the theme.
The alpha
is a high-level plot attribute that sets the transparency of the glyph being plotted.
When using a glyph that only has line properties, this will be the alpha of the line.
When using a glyph that has has line and fill properties, this will be the alpha of the line and the alpha of the fill will be set to 50% of this value.
Individual fill and line alpha can be specified with fill_alpha
and line_alpha
and will override alpha
.
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 |
Other annotation functions: ann_arrow
,
ann_box
, ann_labels
,
ann_poly
, ann_span
,
ann_title
, ann_whisker
,
arrow
x <- runif(100) d <- data.frame(x = x, y = x ^ 2 + rnorm(100, sd = 0.1)) mod <- loess(y ~ x, data = d) sx <- seq(min(x), max(x), length = 100) pr <- predict(mod, newdata = sx, se = TRUE) bd <- data.frame(x = sx, l = pr$fit - pr$se.fit * 2, u = pr$fit + pr$se.fit * 2) figure() %>% ly_points(x, y, data = d) %>% ann_band(x, l, u, data = bd, dimension = "height", color = "gray")