R/components.R

In maxheld83/reacthexgrid: htmlwidget for the react hexgrid project

#' Create Hexagon Component
#'
#' @param ... child components
#'
#' @param q,r,s `[integer(1)]` giving axial coordinates, see [readblobgames](https://www.redblobgames.com/grids/hexagons/).
#' The axial coordinates are unitless integers; they need not correspond the SVG coordinate system of [Hexagon()].
#'
#' @param fill `[character(1)]` giving the [fill](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill) attribute.
#'
#' @family components
#'
#' @export
hexagon <- function(..., q, r, s, fill = NULL) {
  # TODO input validation
  reactR::React$Hexagon(q = q, r = r, s = s, fill = fill, ...)
}

#' Create Layout Component
#'
#' @param ... child components
#'
#' @param size `[list(x = integer(), y = integer())]` giving sizes of the individual hexagons, relative to `viewBox` of the [hexgrid()].
#'
#' @param flat `[logical(1)]` giving whether the hexagons should flat (`TRUE`) or pointy-topped (`FALSE`).
#'
#' @param spacing `[numeric(1)]` giving the spacing between the hexagons as a *multiple* of `size` (probably; this is undocumented in the upstream library.)
#' Must be greater than 1 to avoid overplotting
#'
#' @param origin `[list(x = integer(), y = integer())]` giving the origin from which to draw the [hexgrid()] given the axial coordinates of [hexagon()]s.
#'
#' @family components
#'
#' @export
layout <- function(...,
                   size = list(x = 20, y = 20),
                   flat = TRUE,
                   spacing = 1.1,
                   origin = list(x = 0, y = 0)) {
  # TODO input validation
  reactR::React$Layout(
    size = size,
    flat = flat,
    spacing = spacing,
    origin = origin,
    ...
  )
}

#' Create Layout Component
#'
#' @param ... child components
#'
#' @param width,height `[integer(1)]` giving width and height of [outermost svg element](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg) viewport, expressed in percentage of parent element or CSS length units.
#'
#' @param viewBox `[character(1)]` giving the cartesian dimensions of the [SVG viewport](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox) as four whitespace-separated numbers `"min-x min-y width height"`.
#'
#' @family components
#'
#' @export
hexgrid <- function(...,
                    width = "100%",
                    height = "100%",
                    viewBox = "-50 -50 100 100") {
  reactR::React$HexGrid(width = width, height = height, viewBox = viewBox, ...)
}

#' Create Text Component
#'
#' @param x `[character(1)]` giving a string to be shown inside the hexagons.
#'
#' @family components
#'
#' @export
text <- function(x = NULL) {
  reactR::React$Text(x)
}

#' Create [Pattern](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/pattern) Component
#'
#' @param ... child components
#'
#' @param id `[character(1)]`
#'
#' @param link `[character(1)]`
#'
#' @family components
#'
#' @export
pattern <- function(..., id, link) {
  reactR::React$Pattern(
    id = id,
    link = link,
    size = "20 20",
    width = 1,
    height = 1,
    viewBox = "0 0 1 1",
    preserveAspectRatio = "meet",
    ...
  )
}