A ob_path
is specified with an ob_point
object that contains at least 2 points, the start and the end. Any number of intermediate points are possible.
Usage
ob_path(
p = class_missing,
label = class_missing,
alpha = class_missing,
arrow_head = class_missing,
arrow_fins = class_missing,
arrowhead_length = class_missing,
length_head = class_missing,
length_fins = class_missing,
color = class_missing,
fill = class_missing,
lineend = class_missing,
linejoin = class_missing,
linewidth = class_missing,
linewidth_fins = class_missing,
linewidth_head = class_missing,
linetype = class_missing,
resect = class_missing,
resect_fins = class_missing,
resect_head = class_missing,
stroke_color = class_missing,
stroke_width = class_missing,
style = class_missing,
...
)
Arguments
- p
ob_point
or list ofob_point
s- label
A character, angle, or label object
- alpha
numeric value for alpha transparency
- arrow_head
A 2-column matrix of polygon points
- arrow_fins
A 2-column matrix of polygon points
- arrowhead_length
Determines the size of the arrow ornaments. This parameter becomes the
length
parameter in ggarrow functions. Numeric values set the ornament size relative to the linewidth. A unit value sets the ornament size in an absolute manner.- length_head
Determines the size of the arrow head. Numeric values set the ornament size relative to the linewidth. A unit value sets the ornament size in an absolute manner. From ggarrow.
- length_fins
Determines the size of the arrow fins. Numeric values set the ornament size relative to the linewidth. A unit value sets the ornament size in an absolute manner. From ggarrow.
- color
character string for color
- fill
character string for fill color
- lineend
Line end style (round, butt, square).
- linejoin
Line join style (round, mitre, bevel).
- linewidth
Width of lines
- linewidth_fins
Line width for arrow fins
- linewidth_head
Line width for arrow fins
- linetype
type of lines
- resect
A numeric(1) denoting millimeters or
to shorten the arrow head and fins. - resect_fins
A numeric(1) denoting millimeters or
to shorten the arrow fins - resect_head
A numeric(1) denoting millimeters or
to shorten the arrow head. - stroke_color
Color of point border line
- stroke_width
Stroke width in arrows
- style
Gets and sets the styles associated with paths
- ...
<
dynamic-dots
> properties passed to style
Details
If you wish to specify multiple paths, you must supply a list of ob_point
objects. When plotted, the ob_path
function uses the ggarrow::geom_arrow function to create the geom.
Slots
length
The number of paths in the ob_path object
tibble
Gets a tibble (data.frame) containing parameters and styles used by
ggarrow::geom_arrow
.