ly_segments {rbokeh} | R Documentation

## Add a "segments" layer to a Bokeh figure

### Description

Draws line segments with the given starting and ending coordinates.

### Usage

    ly_segments(fig, x0, y0, x1, y1, data = figure_data(fig), color = "black",
      alpha = 1, width = 1, type = 1, legend = NULL, lname = NULL,
      lgroup = NULL, visible = TRUE, ...)

### Arguments

`fig` | figure to modify
`x0` | values or field name of starting x coordinates
`y0` | values or field name of starting y coordinates
`x1` | values or field name of ending x coordinates
`y1` | values or field name of ending y coordinates
`data` | an optional data frame, providing the source for inputs x, y, and other glyph properties
`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'
`alpha` | transparency value for the line between 0 (transparent) and 1 (opaque)
`width` | stroke width in units of pixels
`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
`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)
`lname` | layer name
`lgroup` | layer group
`visible` | should the layer be visible?
`...` | additional parameters for fine control over line properties (see "Additional parameters" below)

### 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.

### Additional parameters

`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` | 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
`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_polygons`, `ly_quadratic`, `ly_quantile`, `ly_ray`, `ly_rect`, `ly_text`, `ly_wedge`

[Package rbokeh version 0.5.0 Index]