R: Addition of an 'ellipse' element

svg_ellipse {omsvg}

R Documentation

Addition of an `ellipse` element

Description

The svg_ellipse() function adds an ellipse to an svg object. The position of the ellipse is given by x and y, and they refer to the center point of the point of the ellipse. The width and the height, both in units of px, provide the horizontal and vertical extents of the ellipse.

Usage

svg_ellipse(
  svg,
  x,
  y,
  width,
  height,
  stroke = NULL,
  stroke_width = NULL,
  fill = NULL,
  opacity = NULL,
  attrs = list(),
  anims = list(),
  filters = list(),
  id = NULL
)

Arguments

`svg`	The `svg` object that is created using the `SVG()` function.
`x`, `y`	The `x` and `y` positions of the center of the ellipse to be drawn. The `x` and `y` values are relative to upper left of the SVG drawing area.
`width`, `height`	The `width` and `height` of the ellipse that is to be drawn. The `width` is the overall width of the ellipse in the 'x' direction, centered on point `x`. The `height` is the distance in the 'y' direction, centered on point `y`.
`stroke`	The color of the stroke applied to the element (i.e., the outline).
`stroke_width`	The width of the stroke in units of pixels.
`fill`	The fill color of the element.
`opacity`	The opacity of the element. Must be a value in the range of `0` to `1`.
`attrs`	A presentation attribute list. The helper function `svg_attrs_pres()` can help us easily generate this named list object. For the most part, the list's names are the presentation attribute names and the corresponding values are the matching attribute values.
`anims`	An animation directive list for the element. This should be structured using the `anims()` function.
`filters`	A filter directive list for the element. This is easily created by using a list of `⁠filter_*()⁠` functions (e.g., `list(filter_gaussian_blur(2), filter_drop_shadow(2, 2))`).
`id`	An optional ID value to give to the built tag. This is useful for modifying this element in a later function call or for interacting with CSS.

Value

An svg object.

Examples

if (interactive()) {

# Create an SVG with a single
# ellipse element
svg <-
  SVG(width = 60, height = 60) %>%
    svg_ellipse(
      x = 30, y = 30,
      width = 50, height = 30,
      fill = "purple"
    )
}