tickformatter_date {rbokeh}R Documentation

A tick formatter for displaying datetime values nicely across a range of scales.

Description

A tick formatter for displaying datetime values nicely across a range of scales.

Usage

tickformatter_date(years = c("%Y"), months = c("%m/%Y", "%b%y"),
  days = c("%m/%d", "%a%d"), hours = c("%Hh", "%H:%M"),
  hourmin = c("%H:%M"), minutes = c(":%M", "%Mm"),
  minsec = c(":%M:%S"), seconds = c("%Ss"), milliseconds = c("%3Nms",
  "%S.%3Ns"), microseconds = c("%fus"), clear = FALSE)

Arguments

years

Formats for displaying datetime values in the "years" range. See details.

months

Formats for displaying datetime values in the "months" range. See details.

days

Formats for displaying datetime values in the "days" range. See details.

hours

Formats for displaying datetime values in the "hours" range. See details.

hourmin

Formats for displaying datetime values in the "hourmin" (for combined hours and minutes) range. See details.

minutes

Formats for displaying datetime values in the "minutes" range. See details.

minsec

Formats for displaying datetime values in the "minsec" (for combined minutes and seconds) range. See details.

seconds

Formats for displaying datetime values in the "seconds" range. See details.

milliseconds

Formats for displaying datetime values in the "milliseconds" range. See details.

microseconds

Formats for displaying datetime values in the "microseconds" range. See details.

clear

A logical indicating whether all non-specified parameters should be cleared out of any exising specification in the figure. This can be useful when modifying a previously-defined figure.

Details

This tick formatter has the following properties (listed together with their default values) that can be used to control the formatting of axis ticks at different scales scales:

Each scale property can be set to format or list of formats to use for formatting datetime tick values that fall in that "time scale". By default, only the first format string passed for each time scale will be used. By default, all leading zeros are stripped away from the formatted labels.

This list of supported strftime formats is reproduced below.

Value

A specification that is used as the tickformatter argument for x_axis or y_axis.

Note

The client library BokehJS uses the timezone library to format datetimes. The inclusion of the list below is based on the claim that timezone makes to support "the full compliment of GNU date format specifiers." However, this claim has not been tested exhaustively against this list. If you find formats that do not function as expected, please submit a github issue, so that the documentation can be updated appropriately.


[Package rbokeh version 0.6.3 Index]