bokeh.models.plots¶
Models for representing top-level plot objects.
-
class
Plot
(**kwargs)[source]¶ Bases:
bokeh.models.layouts.LayoutDOM
Model representing a plot, containing glyphs, guides, annotations.
-
above
¶ property type:
List
(Instance
(Renderer
) )A list of renderers to occupy the area above of the plot.
-
aspect_scale
¶ property type:
Float
A value to be given for increased aspect ratio control. This value is added multiplicatively to the calculated value required for
match_aspect
.aspect_scale
is defined as the ratio of width over height of the figure.For example, a plot with
aspect_scale
value of 2 will result in a square in data units to be drawn on the screen as a rectangle with a pixel width twice as long as its pixel height.Note
This setting only takes effect if
match_aspect
is set toTrue
.
-
background_fill_alpha
¶ property type:
NumberSpec
The fill alpha for the plot background style.
-
below
¶ property type:
List
(Instance
(Renderer
) )A list of renderers to occupy the area below of the plot.
-
border_fill_alpha
¶ property type:
NumberSpec
The fill alpha for the plot border style.
-
center
¶ property type:
List
(Instance
(Renderer
) )A list of renderers to occupy the center area (frame) of the plot.
-
extra_x_ranges
¶ property type:
Dict
(String
,Instance
(Range
) )Additional named ranges to make available for mapping x-coordinates.
This is useful for adding additional axes.
-
extra_y_ranges
¶ property type:
Dict
(String
,Instance
(Range
) )Additional named ranges to make available for mapping y-coordinates.
This is useful for adding additional axes.
-
frame_height
¶ property type:
Int
The height of a plot frame or the inner height of a plot, excluding any axes, titles, border padding, etc.
-
frame_width
¶ property type:
Int
The width of a plot frame or the inner width of a plot, excluding any axes, titles, border padding, etc.
-
inner_height
¶ property type:
Int
This is the exact height of the plotting canvas, i.e. the height of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).
Note
This is an experimental feature and the API may change in near future.
-
inner_width
¶ property type:
Int
This is the exact width of the plotting canvas, i.e. the width of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).
Note
This is an experimental feature and the API may change in near future.
-
left
¶ property type:
List
(Instance
(Renderer
) )A list of renderers to occupy the area to the left of the plot.
-
lod_interval
¶ property type:
Int
Interval (in ms) during which an interactive tool event will enable level-of-detail downsampling.
-
lod_threshold
¶ property type:
Int
A number of data points, above which level-of-detail downsampling may be performed by glyph renderers. Set to
None
to disable any level-of-detail downsampling.
-
lod_timeout
¶ property type:
Int
Timeout (in ms) for checking whether interactive tool events are still occurring. Once level-of-detail mode is enabled, a check is made every
lod_timeout
ms. If no interactive tool events have happened, level-of-detail mode is disabled.
-
match_aspect
¶ property type:
Bool
Specify the aspect ratio behavior of the plot. Aspect ratio is defined as the ratio of width over height. This property controls whether Bokeh should attempt the match the (width/height) of data space to the (width/height) in pixels of screen space.
Default is
False
which indicates that the data aspect ratio and the screen aspect ratio vary independently.True
indicates that the plot aspect ratio of the axes will match the aspect ratio of the pixel extent the axes. The end result is that a 1x1 area in data space is a square in pixels, and conversely that a 1x1 pixel is a square in data units.Note
This setting only takes effect when there are two dataranges. This setting only sets the initial plot draw and subsequent resets. It is possible for tools (single axis zoom, unconstrained box zoom) to change the aspect ratio.
Warning
This setting is incompatible with linking dataranges across multiple plots. Doing so may result in undefined behaviour.
-
min_border
¶ property type:
Int
A convenience property to set all all the
min_border_X
properties to the same value. If an individual border property is explicitly set, it will overridemin_border
.
-
min_border_bottom
¶ property type:
Int
Minimum size in pixels of the padding region below the bottom of the central plot region.
Note
This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.
-
min_border_left
¶ property type:
Int
Minimum size in pixels of the padding region to the left of the central plot region.
Note
This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.
-
min_border_right
¶ property type:
Int
Minimum size in pixels of the padding region to the right of the central plot region.
Note
This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.
-
min_border_top
¶ property type:
Int
Minimum size in pixels of the padding region above the top of the central plot region.
Note
This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.
-
outer_height
¶ property type:
Int
This is the exact height of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).
Note
This is an experimental feature and the API may change in near future.
-
outer_width
¶ property type:
Int
This is the exact width of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).
Note
This is an experimental feature and the API may change in near future.
-
outline_line_alpha
¶ property type:
NumberSpec
The line alpha for the plot border outline.
-
outline_line_dash
¶ property type:
DashPattern
The line dash for the plot border outline.
-
outline_line_width
¶ property type:
NumberSpec
The line width for the plot border outline.
-
output_backend
¶ property type:
Enum
(OutputBackend
)Specify the output backend for the plot area. Default is HTML5 Canvas.
Note
When set to
webgl
, glyphs without a WebGL rendering implementation will fall back to rendering onto 2D canvas.
-
plot_height
¶ property type:
Int
The outer height of a plot, including any axes, titles, border padding, etc.
Note
This corresponds directly to the height of the HTML canvas.
-
plot_width
¶ property type:
Int
The outer width of a plot, including any axes, titles, border padding, etc.
Note
This corresponds directly to the width of the HTML canvas.
-
renderers
¶ property type:
List
(Instance
(Renderer
) )A list of all renderers for this plot, including guides and annotations in addition to glyphs and markers.
This property can be manipulated by hand, but the
add_glyph
andadd_layout
methods are recommended to help make sure all necessary setup is performed.
-
reset_policy
¶ property type:
Enum
(ResetPolicy
)How a plot should respond to being reset. By deafult, the standard actions are to clear any tool state history, return plot ranges to their original values, undo all selections, and emit a
Reset
event. If customization is desired, this property may be set to"event_only"
, which will suppress all of the actions except the Reset event.
-
right
¶ property type:
List
(Instance
(Renderer
) )A list of renderers to occupy the area to the right of the plot.
-
title
¶ property type:
Instance
(Title
)A title for the plot. Can be a text string or a Title annotation.
-
title_location
¶ property type:
Enum
(Location
)Where the title will be located. Titles on the left or right side will be rotated.
-
toolbar
¶ property type:
Instance
(Toolbar
)The toolbar associated with this plot which holds all the tools. It is automatically created with the plot if necessary.
-
toolbar_location
¶ property type:
Enum
(Location
)Where the toolbar will be located. If set to None, no toolbar will be attached to the plot.
-
toolbar_sticky
¶ property type:
Bool
Stick the toolbar to the edge of the plot. Default: True. If False, the toolbar will be outside of the axes, titles etc.
-
x_range
¶ property type:
Instance
(Range
)The (default) data range of the horizontal dimension of the plot.
-
x_scale
¶ property type:
Instance
(Scale
)What kind of scale to use to convert x-coordinates in data space into x-coordinates in screen space.
-
y_range
¶ property type:
Instance
(Range
)The (default) data range of the vertical dimension of the plot.
-
y_scale
¶ property type:
Instance
(Scale
)What kind of scale to use to convert y-coordinates in data space into y-coordinates in screen space.
-
add_glyph
(source_or_glyph, glyph=None, **kw)[source]¶ Adds a glyph to the plot with associated data sources and ranges.
This function will take care of creating and configuring a Glyph object, and then add it to the plot’s list of renderers.
- Parameters
source (DataSource) – a data source for the glyphs to all use
glyph (Glyph) – the glyph to add to the Plot
- Keyword Arguments
- Returns
GlyphRenderer
-
add_tile
(tile_source, **kw)[source]¶ Adds new
TileRenderer
intoPlot.renderers
- Parameters
tile_source (TileSource) – a tile source instance which contain tileset configuration
- Keyword Arguments
keyword arguments are passed on as-is to the tile renderer (Additional) –
- Returns
TileRenderer
- Return type
-
add_tools
(*tools)[source]¶ Adds tools to the plot.
- Parameters
*tools (Tool) – the tools to add to the Plot
- Returns
None
-
column
(col, gridplot)[source]¶ Return whether this plot is in a given column of a GridPlot.
- Parameters
col (int) – index of the column to test
gridplot (GridPlot) – the GridPlot to check
- Returns
bool
-
row
(row, gridplot)[source]¶ Return whether this plot is in a given row of a GridPlot.
- Parameters
row (int) – index of the row to test
gridplot (GridPlot) – the GridPlot to check
- Returns
bool
-
select
(*args, **kwargs)[source]¶ Query this object and all of its references for objects that match the given selector.
There are a few different ways to call the
select
method. The most general is to supply a JSON-like query dictionary as the single argument or as keyword arguments:- Parameters
selector (JSON-like) – some sample text
- Keyword Arguments
kwargs – query dict key/values as keyword arguments
Additionally, for compatibility with
Model.select
, a selector dict may be passed asselector
keyword argument, in which case the value ofkwargs['selector']
is used for the query.For convenience, queries on just names can be made by supplying the
name
string as the single parameter:- Parameters
name (str) – the name to query on
Also queries on just type can be made simply by supplying the
Model
subclass as the single parameter:- Parameters
type (Model) – the type to query on
- Returns
seq[Model]
Examples
# These three are equivalent p.select(selector={"type": HoverTool}) p.select({"type": HoverTool}) p.select(HoverTool) # These two are also equivalent p.select({"name": "mycircle"}) p.select("mycircle") # Keyword arguments can be supplied in place of selector dict p.select({"name": "foo", "type": HoverTool}) p.select(name="foo", type=HoverTool)
-
property
h_symmetry
¶
-
property
tools
¶
-
property
v_symmetry
¶
-