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

scaleFillGradient2

fun scaleFillGradient2(low: String, mid: String, high: String, midpoint: Double = 0.0, name: String? = null, breaks: Any? = null, labels: Any? = null, lablim: Int? = null, limits: <Error class: unknown class><Number?, Number?>? = null, naValue: Any? = null, format: String? = null, guide: Any? = null, trans: String? = null): Scale

Defines diverging color gradient (low-mid-high) for fill aesthetic.

Parameters

low

Color for low end of gradient.

high

Color for high end of gradient.

midpoint

default = 0.0. The midpoint (in data value) of the diverging scale.

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 pair of numbers specifying the data range for the scale. Use null to refer to default min/max.

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

Examples:

  • ".2f" -> "12.45"

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

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