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

scaleManual

fun scaleManual(aesthetic: Any, values: Any, name: String? = null, breaks: Any? = null, labels: Any? = null, lablim: Int? = null, limits: List<Any>? = null, naValue: Any? = null, format: String? = null, guide: Any? = null): Scale

Creates your own discrete scale for the specified aesthetics.

Parameters

aesthetic

Aesthetic or a list of aesthetics that this scale works with.

values

List of Strings (encoding colors) or color values. A set of aesthetic values to map data values to. Values will be matched with the limits of the scale (if specified).

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

Continuous scale: a numeric vector of length two providing limits of the scale. Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.

naValue

An aesthetic value which is used when data in not available.

format

Specifies the format pattern for labels on the scale.

guide

Guide to use for this scale. It can either be a string ("colorbar", "legend") or a call to a guide function (guideColorbar(), guideLegend()) specifying additional arguments. "none" will hide the guide.

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.html

Examples:

  • ".2f" -> "12.45"

  • "Score: {.2f}" -> "Score: 12.45"

  • "Score: {}" -> "Score: 12.454789"