Skip to contents

ob_segment class

Source: R/segments.R
ob_segment.Rd

ob_segment class

Usage

ob_segment(
  p1 = class_missing,
  p2 = class_missing,
  label = character(0),
  alpha = numeric(0),
  arrow_head = ggarrow::arrow_head_minimal(90),
  arrow_fins = list(),
  arrowhead_length = 4,
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = class_missing,
  x = class_missing,
  xend = class_missing,
  y = class_missing,
  yend = class_missing,
  ...
)

Arguments

p1

starting point

p2

end point

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

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

a style list

x

overrides the x-coordinate of p1

xend

overrides the y-coordinate of p1

y

overrides the x-coordinate of p2

yend

overrides the y-coordinate of p2

...

<dynamic-dots> properties passed to style

Slots

geom

A function that converts the object to a geom. Any additional parameters are passed to ggarrow::geom_arrow_segment.

hatch

A function that puts hatch (tally) marks on segments. Often used to indicate which segments have the same length. The k parameter controls how many hatch marks to display. The height parameter controls how long the hatch mark segment is. The sep paramater controls the separation between hatch marks when k > 2. Additional parameters sent to ob_segment.

midpoint

A function that selects 1 or more midpoints of the ob_segment. The position argument can be between 0 and 1. Additional arguments are passed to ob_point.

nudge

A function to move the segment by x and y units.