ann_poly {rbokeh} | R Documentation |
Add a "polygon" annotation to a Bokeh figure
ann_poly(fig, xs = NULL, ys = NULL, color = NULL, alpha = NULL, ys_units = NULL, xs_units = NULL, line_width = NULL, line_cap = NULL, line_join = NULL, line_dash = NULL, line_dash_offset = NULL, lgroup = NULL, lname = NULL, ...)
fig |
Figure to modify. |
xs |
The x-coordinates of the region to draw. |
ys |
The y-coordinates of the region to draw. |
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. |
ys_units |
The unit type for the ys attribute. Interpreted as "data space" units by default. One of "data" or "screen". |
xs_units |
The unit type for the xs attribute. Interpreted as "data space" units by default. One of "data" or "screen". |
line_width |
The line width values for the polygon. |
line_cap |
The line cap values for the polygon. |
line_join |
The line join values for the polygon. |
line_dash |
The line dash values for the polygon. |
line_dash_offset |
The line dash offset values for the polygon. |
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_band
, ann_box
,
ann_labels
, ann_span
,
ann_title
, ann_whisker
,
arrow