ob_polygon: The ob_polygon class

In ggdiagram: Object-Oriented Diagram Plots with 'ggplot2'

The ob_polygon class

Description

A polygon is specified with an ob_point that contains at least 3 points, the start and the end. Any number of intermediate points are possible.

Usage

ob_polygon(
  p = S7::class_missing,
  label = character(0),
  vertex_radius = numeric(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

p	ob_point or list of ob_point objects
label	A character, angle, or ob_label object
vertex_radius	A numeric or unit vector of length one, specifying the corner radius
alpha	numeric value for alpha transparency
color	character string for color
fill	character string for fill color
linewidth	Width of lines
linetype	type of lines
style	Gets and sets the styles associated with polygons
id	character string to identify object
...	<dynamic-dots> properties passed to style

Details

If you wish to specify multiple polygons, you must supply a list of ob_point objects. When plotted, the ob_polygon function uses the ggforce::geom_shape function to create the geom.

Value

ob_polygon object

Slots

length

The number of polygons in the ob_polygon object

tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_shape.

ggdiagram documentation built on Sept. 15, 2025, 1:07 a.m.