bokeh.colors

Provide classes for representing RGB(A) and HSL(A) colors, as well as define common named colors.

bokeh.colors.Color

Provide a base class for representing color values.

class Color[source]

A base class for representing color objects.

static clamp(value: float, maximum: float | None = None) float[source]

Clamp numeric values to be non-negative, an optionally, less than a given maximum.

Parameters
  • value (float) – A number to clamp.

  • maximum (float, optional) – A max bound to to clamp to. If None, there is no upper bound, and values are only clamped to be non-negative. (default: None)

Returns

float

abstract copy() bokeh.colors.color.Self[source]

Copy this color.

Subclasses must implement this method.

darken(amount: float) bokeh.colors.color.Self[source]

Darken (reduce the luminance) of this color.

Parameters

amount (float) – Amount to reduce the luminance by (clamped above zero)

Returns

Color

abstract classmethod from_hsl(value: HSL) Self[source]

Create a new color by converting from an HSL color.

Subclasses must implement this method.

Parameters

value (HSL) – A color to convert from HSL

Returns

Color

abstract classmethod from_rgb(value: RGB) Self[source]

Create a new color by converting from an RGB color.

Subclasses must implement this method.

Parameters

value (RGB) – A color to convert from RGB

Returns

Color

lighten(amount: float) bokeh.colors.color.Self[source]

Lighten (increase the luminance) of this color.

Parameters

amount (float) – Amount to increase the luminance by (clamped above zero)

Returns

Color

abstract to_css() str[source]

Return a CSS representation of this color.

Subclasses must implement this method.

Returns

str

abstract to_hsl() HSL[source]

Create a new HSL color by converting from this color.

Subclasses must implement this method.

Returns

HSL

abstract to_rgb() RGB[source]

Create a new HSL color by converting from this color.

Subclasses must implement this method.

Returns

RGB

bokeh.colors.HSL

Provide a class to represent colors with HSL (Hue, Saturation, Value).

class HSL(h: float, s: float, l: float, a: float = 1.0)[source]

Represent colors by specifying their Hue, Saturation, and lightness.

Alpha values may also optionally be provided. Otherwise, alpha values default to 1.

Warning

HSL is deprecated as of Bokeh 2.3.1 and will be removed in a future release. Use RGB or named colors instead.

__init__(h: float, s: float, l: float, a: float = 1.0) None[source]
Parameters
  • h (int) – The Hue, in [0, 360]

  • s (int) – The Saturation, in [0, 1]

  • l (int) – The lightness, in [0, 1]

  • a (float, optional) – An alpha value for this color in [0, 1] (default: 1.0)

static clamp(value: float, maximum: float | None = None) float

Clamp numeric values to be non-negative, an optionally, less than a given maximum.

Parameters
  • value (float) – A number to clamp.

  • maximum (float, optional) – A max bound to to clamp to. If None, there is no upper bound, and values are only clamped to be non-negative. (default: None)

Returns

float

copy() bokeh.colors.hsl.HSL[source]

Return a copy of this color value.

Returns

HSL

darken(amount: float) bokeh.colors.color.Self

Darken (reduce the luminance) of this color.

Parameters

amount (float) – Amount to reduce the luminance by (clamped above zero)

Returns

Color

classmethod from_hsl(value: bokeh.colors.hsl.HSL) bokeh.colors.hsl.HSL[source]

Copy an HSL color from another HSL color value.

Parameters

value (HSL) – The HSL color to copy.

Returns

HSL

classmethod from_rgb(value: RGB) HSL[source]

Create an HSL color from an RGB color value.

Parameters

value (RGB) – The RGB color to convert.

Returns

HSL

lighten(amount: float) bokeh.colors.color.Self

Lighten (increase the luminance) of this color.

Parameters

amount (float) – Amount to increase the luminance by (clamped above zero)

Returns

Color

to_css() str[source]

Generate the CSS representation of this HSL color.

Returns

str, "hsl(...)" or "hsla(...)"

to_hsl() bokeh.colors.hsl.HSL[source]

Return a HSL copy for this HSL color.

Returns

HSL

to_rgb() RGB[source]

Return a corresponding RGB color for this HSL color.

Returns

RGB

bokeh.colors.RGB

class RGB(r: int, g: int, b: int, a: float = 1.0)[source]

Represent colors by specifying their Red, Green, and Blue channels.

Alpha values may also optionally be provided. Otherwise, alpha values default to 1.

__init__(r: int, g: int, b: int, a: float = 1.0) None[source]
Parameters
  • r (int) – The value for the red channel in [0, 255]

  • g (int) – The value for the green channel in [0, 255]

  • b (int) – The value for the blue channel in [0, 255]

  • a (float, optional) – An alpha value for this color in [0, 1] (default: 1.0)

static clamp(value: float, maximum: float | None = None) float

Clamp numeric values to be non-negative, an optionally, less than a given maximum.

Parameters
  • value (float) – A number to clamp.

  • maximum (float, optional) – A max bound to to clamp to. If None, there is no upper bound, and values are only clamped to be non-negative. (default: None)

Returns

float

copy() bokeh.colors.rgb.RGB[source]

Return a copy of this color value.

Returns

RGB

darken(amount: float) bokeh.colors.color.Self

Darken (reduce the luminance) of this color.

Parameters

amount (float) – Amount to reduce the luminance by (clamped above zero)

Returns

Color

classmethod from_hsl(value: HSL) RGB[source]

Create an RGB color from an HSL color value.

Parameters

value (HSL) – The HSL color to convert.

Returns

RGB

classmethod from_rgb(value: bokeh.colors.rgb.RGB) bokeh.colors.rgb.RGB[source]

Copy an RGB color from another RGB color value.

Parameters

value (RGB) – The RGB color to copy.

Returns

RGB

lighten(amount: float) bokeh.colors.color.Self

Lighten (increase the luminance) of this color.

Parameters

amount (float) – Amount to increase the luminance by (clamped above zero)

Returns

Color

to_css() str[source]

Generate the CSS representation of this RGB color.

Returns

str, "rgb(...)" or "rgba(...)"

to_hex() str[source]

Return a hex color string for this RGB color.

Any alpha value on this color is discarded, only hex color strings for the RGB components are returned.

Returns

str, "#RRGGBB"

to_hsl() HSL[source]

Return a corresponding HSL color for this RGB color.

Returns

HSL

to_rgb() bokeh.colors.rgb.RGB[source]

Return a RGB copy for this RGB color.

Returns

RGB

property brightness: float

Perceived brightness of a color in [0, 1] range.

bokeh.colors.groups

Organize CSS named colors into useful groups according to general hue.

class black[source]

CSS “Black” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

gainsboro
lightgray
silver
darkgray
gray
dimgray
lightslategray
slategray
darkslategray
black
class blue[source]

CSS “Blue” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

lightsteelblue
powderblue
lightblue
skyblue
lightskyblue
deepskyblue
dodgerblue
cornflowerblue
steelblue
royalblue
blue
mediumblue
darkblue
navy
midnightblue
class brown[source]

CSS “Brown” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

cornsilk
blanchedalmond
bisque
navajowhite
wheat
burlywood
tan
rosybrown
sandybrown
goldenrod
darkgoldenrod
peru
chocolate
saddlebrown
sienna
brown
maroon
class cyan[source]

CSS “Cyan” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

mediumaquamarine
aqua
cyan
lightcyan
paleturquoise
aquamarine
turquoise
mediumturquoise
darkturquoise
lightseagreen
cadetblue
darkcyan
teal
class green[source]

CSS “Green” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

darkolivegreen
olive
olivedrab
yellowgreen
limegreen
lime
lawngreen
chartreuse
greenyellow
springgreen
mediumspringgreen
lightgreen
palegreen
darkseagreen
mediumseagreen
seagreen
forestgreen
green
darkgreen
class orange[source]

CSS “Orange” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

orangered
tomato
coral
darkorange
orange
class pink[source]

CSS “Pink” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

pink
lightpink
hotpink
deeppink
palevioletred
mediumvioletred
class purple[source]

CSS “Purple” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

lavender
thistle
plum
violet
orchid
fuchsia
magenta
mediumorchid
mediumpurple
blueviolet
darkviolet
darkorchid
darkmagenta
purple
indigo
darkslateblue
slateblue
mediumslateblue
class red[source]

CSS “Red” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

lightsalmon
salmon
darksalmon
lightcoral
indianred
crimson
firebrick
darkred
red
class white[source]

CSS “White” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

white
snow
honeydew
mintcream
azure
aliceblue
ghostwhite
whitesmoke
seashell
beige
oldlace
floralwhite
ivory
antiquewhite
linen
lavenderblush
mistyrose
class yellow[source]

CSS “Yellow” Color Group as defined by https://www.w3schools.com/colors/colors_groups.asp

yellow
lightyellow
lemonchiffon
lightgoldenrodyellow
papayawhip
moccasin
peachpuff
palegoldenrod
khaki
darkkhaki
gold

bokeh.colors.named

Provide the standard 147 CSS (X11) named colors.

aliceblue
antiquewhite
aqua
aquamarine
azure
beige
bisque
black
blanchedalmond
blue
blueviolet
brown
burlywood
cadetblue
chartreuse
chocolate
coral
cornflowerblue
cornsilk
crimson
cyan
darkblue
darkcyan
darkgoldenrod
darkgray
darkgreen
darkgrey
darkkhaki
darkmagenta
darkolivegreen
darkorange
darkorchid
darkred
darksalmon
darkseagreen
darkslateblue
darkslategray
darkslategrey
darkturquoise
darkviolet
deeppink
deepskyblue
dimgray
dimgrey
dodgerblue
firebrick
floralwhite
forestgreen
fuchsia
gainsboro
ghostwhite
gold
goldenrod
gray
green
greenyellow
grey
honeydew
hotpink
indianred
indigo
ivory
khaki
lavender
lavenderblush
lawngreen
lemonchiffon
lightblue
lightcoral
lightcyan
lightgoldenrodyellow
lightgray
lightgreen
lightgrey
lightpink
lightsalmon
lightseagreen
lightskyblue
lightslategray
lightslategrey
lightsteelblue
lightyellow
lime
limegreen
linen
magenta
maroon
mediumaquamarine
mediumblue
mediumorchid
mediumpurple
mediumseagreen
mediumslateblue
mediumspringgreen
mediumturquoise
mediumvioletred
midnightblue
mintcream
mistyrose
moccasin
navajowhite
navy
oldlace
olive
olivedrab
orange
orangered
orchid
palegoldenrod
palegreen
paleturquoise
palevioletred
papayawhip
peachpuff
peru
pink
plum
powderblue
purple
rebeccapurple
red
rosybrown
royalblue
saddlebrown
salmon
sandybrown
seagreen
seashell
sienna
silver
skyblue
slateblue
slategray
slategrey
snow
springgreen
steelblue
tan
teal
thistle
tomato
turquoise
violet
wheat
white
whitesmoke
yellow
yellowgreen