Lets-Plot-Kotlin/org.jetbrains.letsPlot.scale/scaleXDateTime

scaleXDateTime

fun scaleXDateTime(name: String? = null, breaks: Any? = null, labels: Any? = null, lablim: Int? = null, limits: <Error class: unknown class><Any?, Any?>? = null, expand: List<Number>? = null, naValue: Any? = null, format: String? = null, position: String? = null): Scale

Position scale x for date/time data.

Examples

Parameters

name

The name of the scale - used as the axis label or the legend title. If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.

breaks

A list of data values specifying the positions of ticks, or a dictionary which maps the tick labels to the breaks values.

labels

A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.

lablim

The maximum label length (in characters) before trimming is applied.

limits

Data range for this scale. A pair of values providing limits of the scale. Use null to refer to default min/max.

expand

A numeric vector of length two giving multiplicative and additive expansion constants. The vector size == 1 => only multiplicative expand (and additive expand by default). Defaults: multiplicative = 0.05, additive = 0.

naValue

Missing values will be replaced with this value.

format

Defines the format for labels on the scale. Also applies to breaks.

position

The position of the axis:

  • "left", "right" or "both" for y-axis;

  • "top", "bottom" or "both" for x-axis.

Format patterns in the format parameter can be just a number format (like "d") or a string template where number format is surrounded by curly braces: "{d} cylinders". Note: the "$" must be escaped as "\$". For more info see: formats.md

Examples:

  • "%d.%m.%y" -> "06.08.19"

  • "%B %Y" -> "August 2019"

  • "%a, %e %b %Y %H:%M:%S" -> "Tue, 6 Aug 2019 04:46:35"