ly_multi_line {rbokeh} | R Documentation

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

### Description

Draws multiple lines with the given lists of coordinates.

### Usage

    ly_multi_line(fig, xs = NULL, ys = NULL, type = 1, width = 1,
      color = NULL, alpha = NULL, hov_color = NULL, hov_alpha = NULL,
      ns_color = NULL, ns_alpha = NULL, sel_color = NULL, sel_alpha = NULL,
      hover = NULL, legend = TRUE, lgroup = NULL, lname = NULL, ...)

### Arguments

`fig` | Figure to modify.
`xs` | List of vectors of x coordinates.
`ys` | List of vectors of y coordinates.
`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 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).
`hov_color` | Color to use to stroke lines when they are hovered.
`hov_alpha` | Transparency value for the line when it is hovered.
`ns_color` | Color to use to stroke lines when they are not selected.
`ns_alpha` | Transparency value for the line when it is not selected.
`sel_color` | Color to use to stroke lines when they are selected.
`sel_alpha` | Transparency value for the line when it is selected.
`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.
`lgroup` | Layer group.
`lname` | Layer name.
`...` | 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. When attributes are mapped, legend entries are automatically created for the mappings (when possible).

### Additional parameters

`line_join` | How path segments should be joined together. One of 'miter' 'round' 'bevel'.
`line_cap` | How path segments should be terminated. One of '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_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_oval`, `ly_patch`, `ly_points`, `ly_polygons`, `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_multi_line(xs = xs, ys = ys, hover = data.frame(a = 1:500))

    figure() %>%
      ly_multi_line(xs = xs, ys = ys,
        color = sample(c("a", "b"), 500, replace = TRUE))

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

[Package rbokeh version 0.6.3 Index]