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

scaleStroke

fun scaleStroke(range: <Error class: unknown class><Number, Number>? = null, name: String? = null, breaks: Any? = null, labels: Any? = null, lablim: Int? = null, limits: <Error class: unknown class><Number?, Number?>? = null, naValue: Number? = null, format: String? = null, guide: Any? = null, trans: String? = null): Scale

Scale for stroke.

Parameters

range

The range of the mapped aesthetics result.

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

A vector specifying the data range for the scale and the default order of their display in guides.

naValue

Missing values will be replaced with this value.

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.

trans

Name of built-in transformation ("identity", "log10", "log2", "symlog", "reverse", "sqrt").

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