chDomain: Calendar Heatmap domain

Description Usage Arguments Value

Description

Configure options with respect to the domains that make up a Calendar Heatmap

Usage

1
2
3
4
5
6
chDomain(calheatmapR, domain = c("hour", "day", "week", "month", "year"),
  subDomain = c("min", "x_min", "hour", "x_hour", "day", "x_day", "week",
  "x_week", "month", "x_month"), start = NULL, range = 12, cellSize = 10,
  cellPadding = 2, cellRadius = 0, gutter = 2, margin = c(0, 0, 0, 0),
  colLimit = NULL, rowLimit = NULL, dynamicDimension = TRUE,
  verticalOrientation = FALSE)

Arguments

calheatmapR

Calendar Heatmap to configure options for

domain

Type of domain

subDomain

Type of subDomain (must always be smaller than domain)

start

Date, as a string, in YYYY-MM-DD format

range

Number of domains to display

cellSize

Size of each domain (in pixels)

cellPadding

Space between each subDomain cell (in pixels)

cellRadius

Border radius of subDomain cells, for rounder corners (in pixels)

gutter

Space between each domain

margin

Margins around each domain, either integer (0) or vector c(0,0) or c(0,0,0,0), all of which produce the same. c(0,1) would create margins of c(0,1,0,1) (in pixels)

colLimit

Control the number of columns to split the domains into

rowLimit

Control the number of rows to split the domains into

dynamicDimension

Enable/disable dynamic width and height of domains

verticalOrientation

Display Calendar Heatmap vertically

Value

a calheatmapR with customised domain options


durtal/calheatmapR documentation built on May 15, 2019, 6:01 p.m.