bokeh.plotting Interface¶

figure(**kwargs)¶

Create a new Figure for plotting, and add it to the current document.

Returns:	Figure

class Figure(*arg, **kw)¶

A subclass of Plot that simplifies plot creation with default axes, grids, tools, etc.

annular_wedge(plot, *args, **kwargs)¶

Add AnnularWedge glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates inner_radius (str or list[float]) – values or field names of inner radii outer_radius (str or list[float]) – values or field names of outer radii start_angle (str or list[float]) – values or field names of starting angles end_angle (str or list[float]) – values or field names of ending angles direction (“clock” or “anticlock”, optional) – direction to turn between starting and ending angles, defaults to “anticlock” source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

annulus(plot, *args, **kwargs)¶

Add Annulus glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates inner_radius (str or list[float]) – values or field names of inner radii outer_radius (str or list[float]) – values or field names of outer radii source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.annulus(x=[1, 2, 3], y=[1, 2, 3], color="#7FC97F",
             inner_radius=0.2, outer_radius=0.5)

show(plot)

arc(plot, *args, **kwargs)¶

Add Arc glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates radius (str or list[float]) – values or field names of arc radii start_angle (str or list[float]) – values or field names of starting angles end_angle (str or list[float]) – values or field names of ending angles direction (“clock” or “anticlock”, optional) – direction to turn between starting and ending angles, defaults to “anticlock” source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Returns:

GlyphRenderer

asterisk(plot, *args, **kwargs)¶

Add Asterisk glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.asterisk(x=[1,2,3], y=[1,2,3], size=20, color="#F0027F")

show(plot)

bezier(plot, *args, **kwargs)¶

Add Bezier glyphs to a Figure.

Parameters:

x0 (str or list[float]) – values or field names of starting x coordinates y0 (str or list[float]) – values or field names of starting y coordinates x1 (str or list[float]) – values or field names of ending x coordinates y1 (str or list[float]) – values or field names of ending y coordinates cx0 (str or list[float]) – values or field names of first control point x coordinates cy0 (str or list[float]) – values or field names of first control point y coordinates cx1 (str or list[float]) – values or field names of second control point x coordinates cy1 (str or list[float]) – values or field names of second control point y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Returns:

GlyphRenderer

circle(plot, *args, **kwargs)¶

Add Circle glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float], optional) – values or field names of sizes in screen units radius (str or list[float], optional) – values or field names of radii source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Note

Only one of size or radius should be provided. Note that radius defaults to data units.

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.circle(x=[1, 2, 3], y=[1, 2, 3], size=20)

show(plot)

circle_cross(plot, *args, **kwargs)¶

Add CircleCross glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.circle_cross(x=[1,2,3], y=[4,5,6], size=20,
                  color="#FB8072", fill_alpha=0.2, line_width=2)

show(plot)

circle_x(plot, *args, **kwargs)¶

Add CircleX glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.circle_x(x=[1, 2, 3], y=[1, 2, 3], size=20,
             color="#DD1C77", fill_alpha-0.2)

show(plot)

Error

Unable to generate Bokeh plot at /home/travis/build/bokeh/bokeh/sphinx/source/docs/reference/plotting.rst:252:

non-keyword arg after keyword arg (<string>, line 5)

cross(plot, *args, **kwargs)¶

Add Cross glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.cross(x=[1, 2, 3], y=[1, 2, 3], size=20,
           color="#E6550D", line_width=2)

show(plot)

diamond(plot, *args, **kwargs)¶

Add Diamond glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.diamond(x=[1, 2, 3], y=[1, 2, 3], size=20,
            color="#1C9099", line_width=2)

show(plot)

diamond_cross(plot, *args, **kwargs)¶

Add DiamondCross glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.diamond_cross(x=[1, 2, 3], y=[1, 2, 3], size=20,
                   color="#386CB0", fill_color=None, line_width=2)

show(plot)

get_class(view_model_name)¶

Given a __view_model__ name, returns the corresponding class object

image(plot, *args, **kwargs)¶

Add Image glyphs to a Figure.

A palette (string name of a built-in palette, currently) must also be supplied to use for color-mapping the scalar image.

Parameters:

image (str or 2D array_like of float) – value or field names of scalar image data x (str or list[float]) – values or field names of lower left x coordinates y (str or list[float]) – values or field names of lower left y coordinates dw (str or list[float]) – values or field names of image width distances dh (str or list[float]) – values or field names of image height distances palette (str or list[str]) – values or field names of palettes to use for color-mapping (see Standard Palettes for more details) color_mapper (LinearColorMapper) – a LinearColorMapper instance dilate (bool, optional) – whether to dilate pixel distance computations when drawing, defaults to False

Returns:

GlyphRenderer

Note

Setting dilate to True will cause pixel distances (e.g., for dw and dh) to be rounded up, always.

image_rgba(plot, *args, **kwargs)¶

Add ImageRGBA glyphs to a Figure.

The image_rgba method accepts images as a two-dimensional array of RGBA values (encoded as 32-bit integers).

Parameters:

image (str or 2D array_like of uint32) – value or field names of RGBA image data x (str or list[float]) – values or field names of lower left x coordinates y (str or list[float]) – values or field names of lower left y coordinates dw (str or list[float]) – values or field names of image width distances dh (str or list[float]) – values or field names of image height distances dilate (bool, optional) – whether to dilate pixel distance computations when drawing, defaults to False

Returns:

GlyphRenderer

Note

Setting dilate to True will cause pixel distances (e.g., for dw and dh) to be rounded up, always.

image_url(plot, *args, **kwargs)¶

Add ImageURL glyphs to a Figure.

Parameters:	url (str) – value of RGBA image data x (str or list[float]) – values or field names of upper left x coordinates y (str or list[float]) – values or field names of upper left y coordinates angle (float) – angle to rotate image by
Returns:	GlyphRenderer

inverted_triangle(plot, *args, **kwargs)¶

Add InvertedTriangle glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.inverted_triangle(x=[1, 2, 3], y=[1, 2, 3], size=20, color="#DE2D26")

show(plot)

line(plot, *args, **kwargs)¶

Add Line glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of line x coordinates y (str or list[float]) – values or field names of line y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

p = figure(title="line", plot_width=300, plot_height=300)
p.line(x=[1, 2, 3, 4, 5], y=[6, 7, 2, 4, 5])

show(p)

multi_line(plot, *args, **kwargs)¶

Add MultiLine glyphs to a Figure.

Parameters:	xs (str or list[list[float]]) – values or field names of lines x coordinates ys (str or list[list[float]]) – values or field names of lines y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Note

For this glyph, the data is not simply an array of scalars, it is really an “array of arrays”.

Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

p = figure(plot_width=300, plot_height=300)
p.multi_line(xs=[[1, 2, 3], [2, 3, 4]], ys=[[6, 7, 2], [4, 5, 7]],
             color=['red','green'])

show(p)

oval(plot, *args, **kwargs)¶

Add Oval glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates width (str or list[float]) – values or field names of widths height (str or list[float]) – values or field names of heights angle (str or list[float], optional) – values or field names of rotation angles, defaults to 0 source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.oval(x=[1, 2, 3], y=[1, 2, 3], width=0.2, height=0.4,
          angle=-0.7, color="#1D91C0")

show(plot)

patch(plot, *args, **kwargs)¶

Add Patch glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of patch x coordinates y (str or list[float]) – values or field names of patch y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

p = figure(plot_width=300, plot_height=300)
p.patch(x=[1, 2, 3, 2], y=[6, 7, 2, 2], color="#99d8c9")

show(p)

patches(plot, *args, **kwargs)¶

Add Patches glyphs to a Figure.

Parameters:	xs (str or list[list[float]]) – values or field names of patches x coordinates ys (str or list[list[float]]) – values or field names of patches y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Note

For this glyph, the data is not simply an array of scalars, it is really an “array of arrays”.

Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

p = figure(plot_width=300, plot_height=300)
p.patches(xs=[[1,2,3],[4,5,6,5]], ys=[[1,2,1],[4,5,5,4]],
         color=["#43a2ca", "#a8ddb5"])

show(p)

quad(plot, *args, **kwargs)¶

Add Quad glyphs to a Figure.

Parameters:

left (str or list[float]) – values or field names of left edges right (str or list[float]) – values or field names of right edges top (str or list[float]) – values or field names of top edges bottom (str or list[float]) – values or field names of bottom edges source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.quad(top=[2, 3, 4], bottom=[1, 2, 3], left=[1, 2, 3],
    right=[1.2, 2.5, 3.7], color="#B3DE69")

show(plot)

quadratic(plot, *args, **kwargs)¶

Add Quadratic glyphs to a Figure.

Parameters:

x0 (str or list[float]) – values or field names of starting x coordinates y0 (str or list[float]) – values or field names of starting y coordinates x1 (str or list[float]) – values or field names of ending x coordinates y1 (str or list[float]) – values or field names of ending y coordinates cx (str or list[float]) – values or field names of control point x coordinates cy (str or list[float]) – values or field names of control point y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Returns:

GlyphRenderer

ray(plot, *args, **kwargs)¶

Add Ray glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates length (str or list[float]) – values or field names of ray lengths in screen units angle (str or list[float]) – values or field names of ray angles source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.ray(x=[1, 2, 3], y=[1, 2, 3], length=45, angle=-0.7, color="#FB8072",
         line_width=2)

show(plot)

rect(plot, *args, **kwargs)¶

Add Rect glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates width (str or list[float]) – values or field names of widths height (str or list[float]) – values or field names of heights angle (str or list[float], optional) – values or field names of rotation angles, defaults to 0 dilate (bool, optional) – whether to dilate pixel distance computations when drawing, defaults to False source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Note

Setting dilate to True will cause pixel distances (e.g., for width and height) to be rounded up, always.

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.rect(x=[1, 2, 3], y=[1, 2, 3], width=10, height=20, color="#CAB2D6",
    width_units="screen", height_units="screen")

show(plot)

scatter(*args, **kwargs)¶

Creates a scatter plot of the given x and y items.

Parameters:

x (str or seq[float]) – values or field names of center x coordinates y (str or seq[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units marker (str, optional) – a valid marker_type, defaults to “circle” color (color value, optional) – shorthand to set both fill and line color source (ColumnDataSource) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Examples

>>> p.scatter([1,2,3],[4,5,6], fill_color="red")
>>> p.scatter("data1", "data2", source=data_source, ...)

segment(plot, *args, **kwargs)¶

The segment glyph displays line segments with the given starting and ending coordinates.

Parameters:

x0 (str or list[float]) – values or field names of starting x coordinates y0 (str or list[float]) – values or field names of starting y coordinates x1 (str or list[float]) – values or field names of ending x coordinates y1 (str or list[float]) – values or field names of ending y coordinates source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.segment(x0=[1, 2, 3], y0=[1, 2, 3], x1=[1, 2, 3],
            y1=[1.2, 2.5, 3.7], color="#F4A582",
            line_width=3)

show(plot)

square(plot, *args, **kwargs)¶

Add Square glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.square(x=[1, 2, 3], y=[1, 2, 3], size=[10,20,30], color="#74ADD1")

show(plot)

square_cross(plot, *args, **kwargs)¶

Add SquareCross glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.square_cross(x=[1, 2, 3], y=[1, 2, 3], size=[10,20,25],
                 color="#7FC97F",fill_color=None, line_width=2)

show(plot)

square_x(plot, *args, **kwargs)¶

Add SquareX glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.square_x(x=[1, 2, 3], y=[1, 2, 3], size=[10,20,25],
             color="#FDAE6B",fill_color=None, line_width=2)

show(plot)

text(plot, *args, **kwargs)¶

Add Text glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of text x coordinates y (str or list[float]) – values or field names of text y coordinates text (str or list[text]) – values or field names of texts angle (str or list[float], optional) – values or field names of text angles, defaults to 0 source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Text Properties

Note

The location and angle of the text relative to the x, y coordinates is indicated by the alignment and baseline text properties.

Returns:	GlyphRenderer

triangle(plot, *args, **kwargs)¶

Add Triangle glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.triangle(x=[1, 2, 3], y=[1, 2, 3], size=[10,20,25],
             color="#99D594", line_width=2)

show(plot)

wedge(plot, *args, **kwargs)¶

Add Wedge glyphs to a Figure.

Parameters:

x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates radius (str or list[float]) – values or field names of wedge radii start_angle (str or list[float]) – values or field names of starting angles end_angle (str or list[float]) – values or field names of ending angles direction (“clock” or “anticlock”, optional) – direction to turn between starting and ending angles, defaults to “anticlock” source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties and Fill Properties

Returns:

GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.wedge(x=[1, 2, 3], y=[1, 2, 3], radius=15, start_angle=0.6,
             end_angle=4.1, radius_units="screen", color="#2b8cbe")

show(plot)

x(plot, *args, **kwargs)¶

Add X glyphs to a Figure.

Parameters:	x (str or list[float]) – values or field names of center x coordinates y (str or list[float]) – values or field names of center y coordinates size (str or list[float]) – values or field names of sizes in screen units source (ColumnDataSource, optional) – a user-supplied data source. If none is supplied, one is created for the user automatically. **kwargs – Line Properties
Returns:	GlyphRenderer

Examples

from bokeh.plotting import figure, output_file, show

plot = figure(width=300, height=300)
plot.x(x=[1, 2, 3], y=[1, 2, 3], size=[10, 20, 25], color="#fa9fb5")

show(plot)

axis¶

Splattable list of Axis objects.

grid¶

Splattable list of Grid objects.

legend¶

Splattable list of Legend objects.

xaxis¶

Splattable list of Axis objects for the x dimension.

xgrid¶

Splattable list of Grid objects for the x dimension.

yaxis¶

Splattable list of Axis objects for the y dimension.

ygrid¶

Splattable list of Grid objects for the y dimension.