bezierArrowSmpl: A simple bezier arrow

Description Usage Arguments Value Examples

View source: R/bezierArrowSmpl.R

Description

This is an alternative to the grid packages bezierGrob with the advantage that it allows you to draw an arrow with a specific unit width. Note, it has only a end-arrow at this point.

Usage

1
2
3
4
bezierArrowSmpl(x = c(0.2, 0.7, 0.3, 0.9), y = c(0.2, 0.2, 0.9, 0.9),
  width = 0.05, clr = "#000000", default.units = "npc",
  arrow = list(base = unit(0.1, "npc"), length = unit(0.1, "npc")),
  align_2_axis = TRUE, name = NULL, gp = gpar(), vp = NULL)

Arguments

x

A numeric vector or unit object specifying x-locations of spline control points.

y

A numeric vector or unit object specifying y-locations of spline control points.

width

The width of the arrow, either a numeric single number or a unit. Note: The arrow does not rely on lwd but on actual width.

clr

The color of the arrow.

default.units

A string indicating the default units to use if x or y are only given as numeric vectors.

arrow

This is a list with all the base (width) and the desired length for the arrow. Note: This differs from the original bezierGrob function.

align_2_axis

Indicates if the arrow should be vertically/horizontally aligned. This is useful for instance if the arrow attaches to a box.

name

A character identifier.

gp

An object of class gpar, typically the output from a call to the function gpar. This is basically a list of graphical parameter settings.

vp

A Grid viewport object (or NULL).

Value

grid::grob A grob of the class polygonGrob with attributes that correspond to the bezier points.

Examples

1
2
3
4
5
library(grid)
grid.newpage()
arrowGrob <- bezierArrowSmpl(x = c(.1,.3,.6,.9),
                             y = c(0.2, 0.2, 0.9, 0.9))
grid.draw(arrowGrob)

raredd/Gmisc0 documentation built on May 27, 2019, 2:02 a.m.