catmaply_layout: Adds time layout to catmaply object

View source: R/layout.R

catmaply_layoutR Documentation

Adds time layout to catmaply object

Description

This layout is used if the x axis is of type time.

Usage

catmaply_layout(
  fig,
  df,
  x,
  x_order,
  x_side,
  x_tickangle,
  x_range,
  y,
  y_order,
  y_side,
  y_tickangle,
  font_family,
  font_size,
  font_color,
  legend,
  rangeslider
)

Arguments

fig

plotly object

df

data.frame or tibble holding the data.

x

column name holding the axis values for x.

x_order

column name holding the ordering axis values for x. if no order is specified, then x will be used for ordering x; (default:"x").

x_side

on which side the axis labels on the x axis should appear. options: c("top", "bottom"); (default:"top").

x_tickangle

the angle of the axis label on the x axis. options: range -180 until 180; (default:90).

x_range

the initial range that should be displayed on the x axis. Only works with non-time x-axis at the moment; (default: 30).

y

column name holding the axis values for y.

y_order

column name holding the ordering axis values for y. if no order is specified, then y will be used for ordering y; (default:"y").

y_side

on which side the axis labels on the y axis should appear. options: c("left", "right"); (default:"left").

y_tickangle

the angle of the axis label on the x axis. options: range -180 until 180; (default:0).

font_family

the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system; (default: c("Open Sans", "verdana", "arial", "sans-serif")).

font_size

font size to be used for plot. needs to be a number greater than or equal to 1; (default: 12).

font_color

font color to be used for plot; (default: "#444")

legend

boolean indicating if legend should be displayed or not; (default: TRUE).

rangeslider

whether or not the rangeslider should be displayed or not; (default: TRUE).

Value

plot_ly object


catmaply documentation built on Jan. 6, 2023, 1:22 a.m.