TimeSeries: TimeSeries

View source: R/timeseries.R

TimeSeriesR Documentation

TimeSeries

Description

Plots interactive time series. Either multiple series may be plotted, or a single series with high and low range/error bars.

Usage

TimeSeries(
  x = NULL,
  range.bars = FALSE,
  colors = NULL,
  line.thickness = NULL,
  legend.width = NULL,
  legend.orientation = "Horizontal",
  legend.position.x = NULL,
  legend.fill.color = "transparent",
  window.start = NULL,
  global.font.family = "Arial",
  global.font.color = rgb(44, 44, 44, maxColorValue = 255),
  title = "",
  title.font.family = global.font.family,
  title.font.color = global.font.color,
  title.font.size = 16,
  x.title = "",
  x.title.font.color = global.font.color,
  x.title.font.family = global.font.family,
  x.title.font.size = 12,
  x.tick.font.color = global.font.color,
  x.tick.font.family = global.font.family,
  x.tick.font.size = 10,
  y.title = "",
  y.title.font.color = global.font.color,
  y.title.font.family = global.font.family,
  y.title.font.size = 12,
  y.tick.font.color = global.font.color,
  y.tick.font.family = global.font.family,
  y.tick.font.size = 10,
  y.tick.format = "",
  y.tick.prefix = "",
  y.tick.suffix = "",
  y.bounds.minimum = NULL,
  y.bounds.maximum = NULL,
  hovertext.font.size = 11,
  hovertext.font.color = global.font.color,
  hovertext.font.family = global.font.family,
  y.hovertext.format = y.tick.format,
  y.hovertext.prefix = y.tick.prefix,
  y.hovertext.suffix = y.tick.suffix
)

Arguments

x

Input data may be a matrix or a vector, wth dates as the rownames and data series along the columns.

range.bars

Logical; whether the data consists of a single series with low, value, high in the columns, or multiple series.

colors

Character; a named color from grDevices OR a hex value color.

line.thickness

Integer; The width of the lines connecting data points.

legend.width

Integer; Width (in pixels) of the legend. Deprecated. Use legend.position.x instead.

legend.orientation

Character; One of 'Vertical' or 'Horizontal'

legend.position.x

A numeric controlling the position of the legend. Values range from -0.5 (left) to 1.5 (right).

legend.fill.color

Legend fill color as a named color in character format (e.g. "black") or a hex code.

window.start

The number of days before the end of the data series to start the range selector window.

global.font.family

Character; font family for all occurrences of any font attribute for the chart unless specified individually.

global.font.color

Global font color as a named color in character format (e.g. "black") or an a hex code.

title

Character; chart title.

title.font.family

Character; title font family. Can be "Arial Black", "Arial", "Comic Sans MS", "Courier New", "Georgia", "Impact", "Lucida Console", "Lucida Sans Unicode", "Marlett", "Symbol", "Tahoma", "Times New Roman", "Trebuchet MS", "Verdana", "Webdings"

title.font.color

Title font color as a named color in character format (e.g. "black") or a hex code.

title.font.size

Integer; Title font size; default = 10.

x.title

Character, x-axis title; defaults to chart input values; to turn off set to "FALSE".

x.title.font.color

x-axis title font color as a named color in character format (e.g. "black") or an a hex code.

x.title.font.family

Character; x-axis title font family

x.title.font.size

Integer; x-axis title font size

x.tick.font.color

X-axis tick label font color as a named color in character format (e.g. "black") or an a hex code.

x.tick.font.family

Character; x-axis tick label font family

x.tick.font.size

Integer; x-axis tick label font size

y.title

Character, y-axis title; defaults to chart input values; to turn off set to "FALSE".

y.title.font.color

y-axis title font color as a named color in character format (e.g. "black") or a hex code.

y.title.font.family

Character; y-axis title font family

y.title.font.size

Integer; y-axis title font size

y.tick.font.color

y-axis tick label font color as a named color in character format (e.g. "black") or an a hex code.

y.tick.font.family

Character; y-axis tick label font family

y.tick.font.size

Integer; y-axis tick label font size

y.tick.format

A string representing a d3 formatting code. See https://github.com/d3/d3/blob/master/API.md#number-formats-d3-format

y.tick.prefix

y-axis tick label prefix

y.tick.suffix

y-axis tick label suffix

y.bounds.minimum

Minimum of range for plotting; For a date axis this should be supplied as a date string. For a categorical axis, the index of the category (0-based) should be used.

y.bounds.maximum

Maximum of range for plotting; NULL = no manual range set.

hovertext.font.size

Integer; Legend font size.

hovertext.font.color

Legend font color as a named color in character format (e.g. "black") or a hex code.

hovertext.font.family

Character; legend font family.

y.hovertext.format

A string representing a d3 formatting code See https://github.com/d3/d3/blob/master/API.md#number-formats-d3-format

y.hovertext.prefix

String to prepend to hovertext showing y-values.

y.hovertext.suffix

String to append to hovertext showing y-values.

Examples

z <- structure(c(1L, 2L, 3L, 4L, 5L, 2L, 3L, 4L, 5L, 6L),  .Dim = c(5L, 2L),
      .Dimnames = list(c("T", "U", "V", "W", "X"), c("A", "B")))
Area(z)

Displayr/flipStandardCharts documentation built on May 2, 2024, 6:22 p.m.