scale_color_cmapmpl#

scale_color_cmapmpl(cmap, *, name=None, breaks=None, labels=None, lablim=None, limits=None, na_value=None, guide=None, trans=None, format=None)#

Create a scale for the ‘color’ aesthetic using matplotlib colormap.

Parameters:
cmapstr or matplotlib colormap object

The name of colormap or the colormap object to use.

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

A numeric vector of length two providing limits of the scale.

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

The scale specification.

Notes

This function requires matplotlib to be installed.

Examples

1from lets_plot import *
2LetsPlot.setup_html()
3x = list(range(50))
4ggplot({'x': x}, aes(x='x')) + \
5    geom_tile(aes(color='x'), size=2) + \
6    scale_color_cmapmpl('plasma', breaks=[5, 25, 45]) + \
7    coord_cartesian() + \
8    ggsize(600, 200)