scale_gradient2#

scale_gradient2(aesthetic, *, low=None, mid=None, high=None, midpoint=0, name=None, breaks=None, labels=None, lablim=None, limits=None, na_value=None, guide=None, trans=None, format=None)#

Define diverging color gradient for the specified aesthetics.

Parameters:
aestheticstr or list

The name(s) of the aesthetic(s) that this scale works with.

lowstr

Color for low end of gradient.

midstr

Color for mid-point.

highstr

Color for high end of gradient.

midpointfloat, default=0.0

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

namestr

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

breakslist or dict

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

labelslist of str or dict

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

lablimint, default=None

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

limitslist

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.

na_value

Missing values will be replaced with this value.

guide

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

trans{‘identity’, ‘log10’, ‘log2’, ‘symlog’, ‘sqrt’, ‘reverse’}

Name of built-in transformation.

formatstr

Define the format for labels on the scale. The syntax resembles Python’s:

  • ‘.2f’ -> ‘12.45’

  • ‘Num {}’ -> ‘Num 12.456789’

  • ‘TTL: {.2f}$’ -> ‘TTL: 12.45$’

For more info see Formatting.

Returns:
FeatureSpec or FeatureSpecArray

Scales specification.

Notes

Define diverging color gradient for the specified aesthetics. Default mid point is set to white color.

Examples

1from lets_plot import *
2LetsPlot.setup_html()
3x = list(range(-25, 26))
4ggplot({'x': x}, aes(x='x')) + \
5    geom_tile(aes(color='x', fill='x')) + \
6    scale_gradient2(aesthetic=['color', 'fill'], low='#2b83ba', mid='#ffffbf', high='#d7191c') + \
7    coord_cartesian() + \
8    ggsize(600, 200)