Releases¶
2.4.0¶
Bokeh Version 2.4.0 (September 2021) is a new minor-release level that
brings many updates. Some of the new feature work includes:
First support for LaTeX- and MathML-based Mathtext (axis labels, tick labels, and Divs) over the course of several PRs: #11466, #11525, #11584, #11585. Look for upcoming releases to extend support to titles, legends, and labels.
Other work in this cycle includes:
- Misc fixes and improvements
Labels can now be multi-line #7317
Individual legend items and table columns can be hidden #9261, #11423
Tab panels can be set to disabled #10898
Toolbar buttons respect tab ordering #11266
Radio button groups support vertical orientation #11374
New consolidated RangesUpdate event #11095
Output from json_items includes Bokeh version #11146
And several other bug fixes and docs additions. For full details, see the CHANGELOG.
Migration Guide¶
Minimum Package Versions¶
This release raises the minimum version for some packages
Bokeh now requires Python 3.7 or higher.
Runtime dependencies¶
Bokeh no longer requires the package python-dateutil.
Bokeh can optionally use the package xyzservices for managing tile
source metadata.
Wikimedia Tile Provider¶
Wikimedia has restricted their tile service to only function with Wikimedia domains, and no longer be publicly usable. Accordingly, the WIKIMEDIA tile provider has been removed. Use any of the other tile providers instead.
Deprecations¶
ScreenDistanceSpec and DataDistanceSpec are deprecated, and now return
a SizeSpec. Custom extensions using these should use SizeSpec instead.
PropertyUnitsSpec is deprecated. Use UnitsSpec instead (this is unlikely
to impact any typical usage).
bokeh.core.query functions no longer accept callables and/or context in
queries. This feature added unnecessary complication and was not used inside
the Bokeh codebase (or ever demonstrated in docs or examples).
Document.delete_modules was deprecated and will be removed in the future.
Use Document.models.destroy instead.
Units Properties¶
Units properties must now be configured with an units_enum that is an
enumeration instead of a units_type that is an Enum property:
units_enum=SpatialUnits # use this
units_type=Enum(SpatialUnits) # NOT this
This is only of potential interest to custom extensions.
Raw string paths in Image property¶
Use pathlib.Path instead.
gridplot(plot_width, plot_height) were deprecated¶
Use width or height respectively instead.
curstate().file is now a dataclass¶
Previously it was a dict-based ad-hoc data structure. Replace key indexing with attribute access.
static init_ModelName(): void {} was deprecated¶
Use new TypeScript 4.4 static blocks static {} instead. Support for static
init_ methods will be removed in bokeh 3.0. This change only affects model
providing extensions.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.3.3¶
Bokeh Version 2.3.3 (Jul 2021) is a patch-release that fixes some
layout and extension related bugs:
Column ignores css class scrollable (#11083)
Bad formatting of y axis labels with theme (#11110)
Layout regression in panel (#11123)
Div model layout differences (#11161)
Active tab should be in view on render (#11284)
Plot’s height can not go below 600px (#11344)
Dropdown menu is hidden in multi choice (#11365)
Extensions should fetch exact version from CDN (#11380)
As well as other very minor docs, build, and bugfix updates.
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.3.2¶
Bokeh Version 2.3.2 (May 2021) is a patch-release that fixes bugs that
affects downstream projects:
SelectionGeometry event is slow compared to js equivalent(#11169)
Forward slash is changed to %2F in link (#11182)
Cannot clear active of RadiGroup (#11203)
As well as other very minor docs, build, and bugfix updates.
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.3.1¶
Bokeh Version 2.3.1 (April 2021) is a patch-release that fixes bugs that
affects downstream projects:
Bugs causing excessive data transfer (#10822, #11026, #11029)
Minor layout regression (#11057)
Log axis exponent render issue (#11006)
As well as other very minor docs, build, and bugfix updates.
For full details see the CHANGELOG.
Migration Guide¶
HSL class deprecated¶
The class bokeh.colors.HSL is deprecated and will be removed in a future
release. Use the RGB class, RGB(a) strings, or named colors instead.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.3.0¶
Bokeh Version 2.3.0 (February 2021) is a new minor-release level that
brings many updates. Some of the new feature work includes:
Multi-line axis and tick labels are now possible (#8169)
Log axes display using superscripts (#8954)
DataModelbase class to define custom “properties-only” Bokeh subclasses added (#3674)Colorbar supports “eqhist” and categorical color mappings (#5618, #10493)
“Edges Only” inspection policy added for graphs (#10637)
Hatch patterns can be used with all fill-able glyphs and annotations (#10824)
New “star” markers added (#10836)
Arrowheads and line-dash patterns can be vectorized (#6835, #10203)
Tornado websocket compression options added (#10798)
Important bug-fixes include:
A major bug with datetime precision causing several regressions was fixed (#10738)
SVG export no longer flips images (#10725)
LabelSetandWhiskernow work for categorical ranges (#10454, #10575)MultiLinehover fixed (#10458)MultiChoiceandMulitSelectdisabling now works (#10452, #10507)Date sliders can use a
TickFormatter(#10458)
The documentation has also received renewed attention:
New First steps sections
Documentation updated to reflect new style guidelines
Basic OpenGraph metadata has been added to docs pages
New landing page on docs.bokeh.org
As well as many other small issues were closed. For full details, see the CHANGELOG.
Please note that the next release level (2.4) will drop support for Python 3.6, and also be the final release level to support IE and other legacy browsers.
Migration Guide¶
Properties are non-nullable by default¶
Previously, all properties accepted None (null in BokehJS) as a value.
As of this release, None is only accepted by properties explicitly marked
as nullable, e.g.``Nullable(Int)`` accepts integers and None. All current
models and their properties were adjusted as needed, so there will be no
difference from users’ perspective. However, custom extensions may require
updates if they relied on the old behavior.
Primitive and derived properties have default values¶
Some properties did not have sensible intrinsic default values (Int
defaulted to None, for example). Now all properties have default values,
such as 0 for Int, or "" for String. You can remove a default
value by marking a property as non-nullable, e.g. NonNullable(Int). In this
case, a user is required to set a property value. An attempt to retrieve the
value of a non-nullable property before it is set will raise an
UnsetValueException.
Use Readonly() to indicate readonly properties¶
The old syntax, e.g. Int(readonly=True), is still accepted, but will be
removed in the future. Use Readonly(Int) instead.
ArrowHead is not an annotation anymore¶
ArrowHead no longer inherits from the Annotation base class. This will
pave the way for vectorizable arrowheads.
Four of Bokeh’s base models are renamed¶
Certain base models were renamed to unify naming convention with BokehJS:
Old name |
New name |
|---|---|
|
|
|
|
|
|
|
|
Old names are retained for compatibility but are deprecated and will be removed in Bokeh 3.0.
names properties were deprecated¶
DataRange.names, SelectTool.names, and HoverTool.names are
deprecated and will be removed in Bokeh 3.0. Use the renderers properties
instead, possibly in combination with plot.select(name="renderer name").
BokehJS visuals have different semantics¶
Previously Line, Fill, Text, and Hatch visuals were used across
primitive, scalar, and vector properties. Those are now split into more specific
versions, e.g. Line, LineScalar, and LineVector. This should only
affect custom extensions that use visuals.
Marker models are deprecated¶
Marker models like Asterisk, CircleX, X, etc. are deprecated. Use
the Scatter glyph with a marker type instead, e.g. replace Asterisk()
with Scatter(marker="asterisk"). Marker methods on Figure will default
to use Scatter glyph. Marker models were removed from BokehJS.
Tooltip deprecations¶
EditTool.custom_tooltip, HelpTool.help_tooltip and
CustomAction.action_tooltip were deprecated Use Tool.description, which
can also be used with all other types tools, instead.
New "auto" defaults for color bar properties¶
ColorBar properties orientation, ticker, and formatter now
default to "auto". Previously, these properties had concrete defaults
("vertical", BasicTicker() and BasicTickFormatter() respectively).
In most cases, this will not affect user code. However, if you relied on setting
e.g. color_bar.ticker.base = 60, then the code will need to be replaced with
color_bar.ticker = BasicTicker(base=60).
CartesianFrame is not a layout anymore¶
This only affects extension creators. CartesianFrame is now responsible only
for maintaining the coordinate system of a plot. Use the layout.center_panel
of a plot to access any layout-related capability. Note you can still use
CartesianFrame.bbox, so most code doesn’t have to change.
Figure sizing fixed in BokehJS¶
Previously, setting plot.frame_width while using sizing_mode:'fixed'
did not resize the canvas as expected; the figure would only resize after changing
plot.width or plot.plot_width. This behavior has been fixed and now setting
plot.width to trigger the resize is no longer needed.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.2.2¶
Bokeh Version 2.2.2 (Oct 2020) is a patch-release that fixes a bug that
affects downstream projects:
Selectively update data when CDSView changes (#10521)
For full details see the CHANGELOG.
2.2.0¶
Bokeh Version 2.2.0 (Aug 2020) is a minor-release that focused with
substantial improvements to performance, SVG export, and DataTable.
Improvements to
DataTablestyling and functionality (#6864, #8595, #10251, #10353, #10363, #10374, #10416)Improvements and fixes to SVG rendering (#6775, #8046, #8446, #8744, #9001, #9169, #9213, #9551, #10273, #10305)
Memory and Performance improvements (#10162, #10176, #10225, #10226, #10234, #10235, #10272, #10384)
Fixes for properties not triggering updates (#9436, #10147, #10215, #10247)
Fix over-quoting problem with
componentsAPI (#10271)Support save to clipboard on supported browsers (#10066)
Ensure auth hooks apply to Websocket updgrade in addition to HTTPS connection (#10316)
Add a new
DocumentReadyevent usable in Bokeh server apps (#10265)
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Oval glyph deprecated¶
The Ovall glyph is largely duplicative of the ellipse glyph, and will be
removed in version 3.0. Use Ellipse instead.
Tooltip.inner_only deprecated¶
This property was non-functional an unnecessary and has been removed. No replacement is provided.
scenterx and scentery deprecated¶
Previosuly, glyphs could implement separate scenterx and scentery to
report a “center” location that could anchor hovers. These have been combined in
to a single Glyph.scenterxy() method that should be implemented instead.
(This change is only relevant if you are implementing a new glyph in Bokeh or in
a custom extension.)
Implement Renderer._render instead of Renderer.render¶
Renderers must implement abstract method _render instead render, which is
now “final”. This breaking change affects only extension developers.
2.1.1¶
Bokeh Version 2.1.1 (June 2020) is a patch-release that fixes some bugs:
Can’t resolve styles when importing BokehJS (#10172)
Bokeh server fails to start correctly with random port (#10175)
Some scalar properties seralizing incorrectly (#10181, #10197)
Typed arrays not returned to Bokeh server as lists (#10204)
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.1.0¶
Bokeh Version 2.1.0 (June 2020) is a minor-release.
push_notebookfixed for Google Colaboratory (#9302)Tools fixes and features (#4567, #9909, #9959, #9963, #10107, #10085)
Fix “Themed glyphs not applying” (#6821)
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Minimum Tornado Version¶
The minimum torndado version is now 5.1.
render_mode deprecated¶
Tool overlays are now implemented efficiently on the HTML5 canvas without any
separate CSS rendering codepath. This makes the render_mode property
obsolete. Accordingly, render_mode is deprecated (and ignored) everywhere
it currently appears, and will be removed entirely for Bokeh 3.0 in the future.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.0.2¶
Bokeh Version 2.0.2 (April 2020) is a micro-release that fixes some bugs and
improves some small features. Highlights include:
Allow multiple versions of BokehJS on a page #9812
Cross-timezone issue with session token expiry #9938.
Fix server resources with Django integration #9724
Make add_layout update a figure #8862
Precompiled extensions broken on Windows #9900
BoxAnnotation ignores fill_color=None #9877
A handful of documentation clarifications, corrections, and expansions
And several other bug fixes and docs additions. For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.0.1¶
Bokeh Version 2.0.1 (April 2020) is a micro-release that fixes some bugs and
improves some small features. Highlights include:
Addressing a Cross-Origin Resource Sharing (CORS) issue seen in Chrome and Chromium-based browsers #9773.
Adding multi-file support for FileInput widgets #9727
Bokeh server can now serve custom extension code #9799
A handful of documentation clarifications, corrections, and expansions
And several other bug fixes and docs additions. For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2.0.0¶
Bokeh Version 2.0.0 (March 2020) is a major milestone of the Bokeh project.
This release cycle closed more than 180 issues. Highlights include:
New, modern
MultiChoicewidget added #9532BokehJS CDN resources are loaded with SRI hashes enabled #8937
New
DatePickerimplementation with more features #9509, #9494, #6728, #8917Package relative imports work in directory-style Bokeh apps #9545
App sessions now use an expirable token that is not visible in query arguments #3458
Full HTTP header and cookies can be accessed by Bokeh app code #9505
Reference documentation show inherited properties on all Bokeh models #4966
IPyWidgets can be used in Bokeh applications, and Bokeh content can be put in IPyWidgets #9590
Added tile providers for ESRI and OSM #9560
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Minimum Package Versions¶
This release raises the minimum version for some packages
Bokeh now requires Python 3.6 or higher.
Bokeh now requires Numpy 1.11.3 or higher.
The Bokeh server now requires Tornado 5.0 or higher.
Server Lifecycle Hooks¶
Server lifecycle hooks should now goin in a file named app_hooks.py, which
is also where new request hooks are to be defined. The previous module name
server_lifecycle.py will continue to function, but is deprecated.
HoverTool Formatters Specification¶
Previously, the formatters property accepted a CDS column name. For example
a formatter for a tooltip for "@foo could be specified with just "foo":
hover_tool.formatters = { "foo": "datetime"} # BAD
Now, the full matching tooltip specification, including the "@", should
be used:
hover_tool.formatters = { "@foo": "datetime"} # GOOD
This allows tooltip formatters to be used uniformly with both columns, as well
as “special variables”, e.g. "$x".
Bokeh Sphinx Extension¶
The obsolete Sphinx configuration parameters bokeh_plot_use_relative_paths
and bokeh_plot_pyfile_include_dirs have been removed. The unused
PLOT_PAGE template has also been removed.
PhantomJS usage retired¶
The deprecated and unsupported PhantomJS dependency is no longer used for exporting Bokeh content. Bokeh will use Chromedriver by default, but can also be configured to use Geckodriver.
“Use Strict” for CustomJS¶
The use_strict property has been removed from all models that it had been
on previously. All JavaScript code, e.g. for CustomJS will always be rendered
with "use_strict" added.
require() in CustomJS¶
The require() function s not available from CustomJS anymore. It exposed
the underlying module system, which should not be used by general users. Use
APIs exposed on Bokeh object or (as a last resort), use Bokeh.require().
Bokeh Protocol Versioning¶
Bokeh wire protocol messages no longer express any revision, and URLs for
server sessions no longer specify "bokeh-protocol-version". It is assumed
any client and server communicating are the same release version (which has
always been true in any usage scenario).
Selection Dicts¶
The obsolete old-style selection dictionaries, i.e. selected['1d'] have
been removed. Use selected.indices, etc. only.
Immutable Palettes¶
Previously, Bokeh used a complicated copy-on-access scheme to return palettes as lists. The necessary “module hack” could confuse IDEs, complicated the docs build process, and sometimes lead to unexpected behavior. All palettes are now tuples, which is a simpler solution to the problem of mutable module attributes.
The main difference is that palettes can no longer be modified in place, including reversing the palette. To reverse a palette, do:
list(reverse(pal))
Tile Providers¶
The named tile properties in tile_providers.py, e.g CARTODBPOSITRON now
return then vendor id for that tile provider. This is can be passed to the
get_provider method directly to return a new TileProvider instance.
ColumnDataSource Properties¶
The ColumnDataSource.selected property is now read-only.
The ColumnDataSource.data property can only be set from plain Python dicts.
Attempting to set from another CDS, i.e s1.data = s2.data, will raise an
error.
Date and Datetime Properties¶
The Date property has been narrowed, in order to afford an unambiguous date
type in the form of an ISO date string. The Date type accepts ISO date
strings, and datetime.date objects.
As a result, the DatePicker widget no longer accepts datetime values or
timestamps. All values must be valid Date values.
The Datetime now accepts timestamps (milliseconds since epoch) directly.
Missing Renderers Warning¶
The W-1000 (MISSING_RENDERERS) validation warning will no longer trigger
for plots that have added annotations, even if no other glyphs are present.
UnitsSpec hierarchy¶
The UnitsSpec class is now a base class and is not useful ln its own. If you
were using UnitsSpec in an extension model, you should change to use the new
PropertyUnitsSpec class, which affords the capability for adding separate
*_units properties.
Broken Bokeh Commands¶
The command line utilities bokeh html, bokeh png, and bokeh svg were
early experimental tools that were never widely promoted. It was recently
discovered that they have been broken since version 1.0, indicating that they
are completely unused. To reduce codebase cruft, they have been removed.
BOKEH_VERSION¶
The previous environment variable BOKEH_VERSION that could be use to specify which version of BokehJS should be loaded from CDN, has been renamed to BOKEH_CDN_VERSION.
API Removals¶
The following modules and functions were previously deprecated or were internal and no longer needed:
bokeh.clientMethod
ClientSession.loop_until_closedremovedbokeh.ioFunction
create_webdriverremoved, usewebdriver_controlinstead.bokeh.models.callbacksMethods
CustomJS.from_py_funcandCustomJS.from_coffeescriptremovedbokeh.models.filtersMethods
CustomJSFilter.from_py_funcandCustomJSFilter.from_coffeescriptremovedbokeh.models.formattersMethods
FuncTickFormatter.from_py_funcandFuncTickFormatter.from_coffeescriptremovedbokeh.models.plotsProperties
Plot.h_symmetryandPlot.v_symmetryremovedbokeh.models.toolsMethods
CustomJSHover.from_py_funcandCustomJSHover.from_coffeescriptremovedbokeh.models.transformsMethods
CustomJSTransform.from_py_funcandCustomJSTransform.from_coffeescriptremovedbokeh.models.widgets.buttonsProperties
Dropdown.default_value,Dropdown.valueandAbstractButton.clicksremoved.bokeh.models.widgets.sliderscallback,callback_throttle, andcallback_policyremoved from all sliders. Usevaluefor continuous updates andvalue_throttledfor updates only on mouseupbokeh.plotting.helpersEntire module removed
bokeh.protocolEntire
versionsmodule removed,messages.registerfunction removedbokeh.util.compilerClass
CoffeeScriptand related code removedbokeh.util.futureEntire module removed
bokeh.util.stringFunctions
encode_utf8,decode_utf8, andescaperemoved
Additionally, the callback property is removed from all Bokeh models except
CustomAction, HoverTool TapTool, and OpenURL. Instead, the more
general js_on_change or js_on_event methods should be used.
API Deprecations¶
The following new deprecations are effective:
bokeh.layouts.WidgetBoxis deprecated usebokeh.layouts.Columninstead.Importing
from_networkxfrombokeh.models.graphsis deprecated. Import frombokeh.plottinginstead.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.4.0¶
Bokeh Version 1.4.0 (October 2019) is a significant release that marks the
end of support for Python 2.7 and Python 3.5 and earlier.
Starting with the next release, Bokeh 2.0, Python 3.6 or later will be required.
This release includes several important fixes and features:
Complete new site design for documentation, including search #8209
Jupyterlab ipywidgets integrations #9137
Security related improvements to the Bokeh server #9139, #9140
New integration added fot Django Channels #9009
Precompiled Bokeh extensions #9196
And several other bug fixes and docs additions. For full details see the CHANGELOG. #8676
Migration Guide¶
Deprecations¶
The overburdened legend keyword argument to glyph methods is deprecated. It
is replaced with three purpose-specific keyword arguments:
legend_label="some_label"This will always produce a legend item with exactly the given label.
legend_field="some_colname"This will produce a “grouped” legend, where the grouping is done by JavaScript in the browser. Python code will only see a single legend item representing the grouping.
legend_group="some_colname"This will produce a “grouped” legend, where the grouping is done by Python code, bedore the content is rendered in the browser. Python code will see individual legend items for each group.
These keywords remove the ambiguities due to the “automagic” operation of
legend with respect to legend grouping. The existing legend keyword
argument will continue to function until at least version 3.0 of Bokeh.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.3.4¶
Bokeh Version 1.3.4 (Aug 2019) is a micro-release to test changes to
build and release automation.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.3.2¶
Bokeh Version 1.3.2 (Aug 2019) is a micro-release to test changes to
build and release automation.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.3.0¶
Bokeh Version 1.3.0 (Jul 2019) is a point release that adds some
interesting new features:
FileInputwidget added #6096New DataCube widget affords groups and aggregations of tabular data #8100
TextInputwidget now has a new per-keystroke capability. #8676Can now set
source.datadirectly from DataFrames #9052
And several other bug fixes and docs additions. For more details see the CHANGELOG or the blog announcement.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.2.0¶
Bokeh Version 1.2.0 (May 2019) is a point release that adds some
interesting new features:
Styling options for fill patterns / hatching #6135
Built-in support for stacked areas and lines #8848
New title property for Legend #6769
Slider callback_policy now works for Bokeh Apps #4540
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
New in 1.2¶
Discourse Site¶
The Google Groups mailing list has been retired. In it’s place, there is now a Discourse site for community discussions. All of the old content from the mailing list has been imported into the Discourse, and is searchable.
Callback Policy¶
Sliders add a value_throttled property that is updated (and triggers JS
and Python callbacks) only according to the callback_policy:
slider.callback_policy = "mouseup"
# both of these will respect the callback policy now
slider.js_on_change('value_throttled', ...)
slider.on_change('value_throttled', ...)
The callbacks above will only execute when the user releases the mouse after adjusting a slider.
Note that the value property can also still be used to trigger callbacks —they will execute unconditionally on every movement.
The old-style callback property still works for JS callbacks, but will be removed in Bokeh 2.0 in the near future. The general js_on_change and on_change mothods should be used going forward.
Stacked Areas and Lines¶
New varea and harea methods add support for single directed areas
(filled regions between two series that share a common index). Also added:
varea_stackharea_stack
for stacking directed areas, and
vline_stackhline_stack
for stacking lines.
For example:
colnames = ['y0', 'y1', 'y2', 'y3', 'y4', 'y5', 'y6']
p.varea_stack(colnames, x='index', color=colors, source=df,
legend=[value(x) for x in colnames])
p.vline_stack(colnames, x='index', color="black", source=df)
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.1.0¶
Bokeh Version 1.1.0 (April 2019) is a significant release that primarily
addresses the layout system. More than 50 layout-related issues were closed,
addressing bugs, missing features, and performance. Other topics of this
release included:
Sphinx extensions more generally useable #5955
Live BokehJS examples added to docs #8692
Improved DataTable performance #8227
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
New in 1.1¶
The js_link function was added to make it simpler to link two Bokeh model
properties together:
slider.js_link('value', r.glyph, 'radius')
See Linked properties for more information.
The Slider.value_as_date method was added to conveniently retrieve Slider
values as date objects when appropriate.
Deprecations¶
The following features or APIs were deprecated in version 1.1 and will be removed in a future 2.0 release:
Support for CoffeeScript in
CustomJSor custom extensions. Use JavaScript or Typescript instead.Support for
ClientSession.loop_until_closed. This function is intended to support testing only, and will be removed from the public API. Bokeh applications should be run directly on a Bokeh server.Support for “transpiling” Python code to JavaScript. All
from_py_funcmethods will be removed. Use JavaScript or Typescript instead.
Changes to bokeh.sphinxext¶
In order to support a longer term goal of moving Bokeh docs to ReadTheDocs,
some changes to the bokeh-plot Sphinx directive were necessary. These are:
Plot script files are now always placed immediately adjacent to the document they are for, and loaded using relative URLs.
The config values
bokeh_plot_pyfile_include_dirsandbokeh_plot_use_relative_pathsare no longer needed. Setting them will have no effect (but will not break existing builds). These config values will be removed in a future 2.0 release.
We believe that there are very few users of bokeh.sphinxext outside the
project itself, and that these changes will not cause any breakage for any of
those users. However, please reach out for support if any unforeseen issues arise.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.0.4¶
Bokeh Version 1.0.4 (January 2019) primarily addresses a security issue
regarding yaml.load (#8541).
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.0.3¶
Bokeh Version 1.0.3 (December 2018) is a micro bugfix and feature release.
Some of the highlights include:
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.0.2¶
Bokeh Version 1.0.2 (November 2018) is a micro bugfix and feature release.
Some of the highlights include:
Expose configurable
DataTablerow height (#8411)Fix issue with legends and empty scatter glyphs (#8395)
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.0.1¶
Bokeh Version 1.0.1 (October 2018) is a micro bugfix release.
Some of the highlights include:
Better cleanup for
DocumentLifeCycleHandler(#8367)Fix issue with oval, ellipse legends (#8375)
Recognized CSS rgb(a) strings for colors (#4096)
For full details see the CHANGELOG.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.0.0¶
Bokeh Version 1.0.0 (October 2018) is a major milestone of the Bokeh project.
Some of the highlights include:
Support for
MultiPolygonswith holes (#2321)Fixes and improvements to DataTable (#6454, #7116, #7417, #8021, #8040, #8050, #8201)
CustomActionfor user-defined Toolbar buttons (#8099)Plain JSON export/embed functions (#5231)
Toolbar
autohideproperty to hide toolbars when not in us(#8284)Callback to allow
AjaxDataSourceto adapt JSON responses (#8321)Scatterglyph for parameterizable marker type (#5884)Reuse webdrivers for faster PNG/SVG export by default (#8329)
Improved testing capabilities (#2596, #8078, #8139, #8146, #8217, #8225)
Faster import times (#8309)
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Handling of Selections¶
Previous versions of Bokeh mistakenly had code paths that could replace data
source Selection objects with entirely new instances. This was a mistake,
and resulted in several regressions and other problems. Unfortunately, the
problem persisted for a few releases, and now that the situation has been fixed,
it will require some code changes for some users to adapt to correct usage.
In general, you should NOT ever listen for a change of selections objects themselves, i.e. do not do this (anymore):
source.on_change('selected', callback) # BAD, DON'T DO THIS
Instead, you should listen for changes to the individual properties that are on
Selection objects. For instance, to execute a callback when the indices
on a selection change, (e.g. when a selection is made on a scatter plot), do
this:
source.selected.on_change('indices', callback) # GOOD
Any code that looks like the first version above should be updated to use the second version. This applies to both Python or JavaScript callbacks for selections.
While this breaking incompatibility is regrettable, there are now much more extensive integration tests in place to maintain that the second version will always function as expected from now on.
New Dependencies¶
“Pillow>=4.0” has been added to the list of Bokeh runtime dependencies.
Examples¶
The following examples have been removed or updated:
app/pivot: This large example was unfocused and unmaintained and has been removed
embed/simple: Old example removed
howto/us_marriages_divorces: Redundant notebook removed, script moved to plotting/file/us_marriages_divorces_hover.py
models/file/colorspec.py Old example removed
models/file/external_resources.py Moved to latex_extension.py
models/file/glyph1.py Moved to basic_plot.py
models/file/grid.py Old example removed
models/file/line.py Old example removed
models/file/transform_jitter_coffee.py Discouraged coffeescript example removed
plotting/file/bar_chart.py Removed old/duplicative example
plotting/file/brewer.py: Moved to stacked_area.py
plotting/file/bollinger.py Old example removed
plotting/file/joyplot.py Moved to ridgeplot.py
Pretty printing functions¶
The pprint and pretty methods depended on IPython pretty-printing
in order to function. Recent changes to IPython pretty-printing machinery
made it impossible to use unless the “pretty” repr was also enabled. This
caused ipython console to be spammed with very large amounts of output,
making it unusable. As a result, both pprint and pretty methods have
been removed. A “pretty” HTML repr still functions in Jupyter notebooks. This
change is not expected to affect any normal usage.
Bokeh Object IDs¶
Previously Bokeh generated unique UUIDs for every Bokeh object. Starting with
this release, Bokeh generates simple increasing integer IDs by default. You can
set the environment variable BOKEH_SIMPLE_IDS=no to restore the previous
behavior. The generation of simple IDs is faster than UUIDs, otherwise this
change is not expected to affect any normal usage. However, if you are creating
Bokeh objects for a single Document in separate processes, i.e. by using the
multiprocessing module, then you will want to turn off simple IDs. (This
is expected to be a rare and unusual usage.)
bokeh.util.plot_utils¶
The bokeh.util.plot_utils module has been removed. This module contained
only private functions used internally. This change is not expected to affect
any normal usage.
bokeh.server.application_context¶
The bokeh.server.application_context module has been renamed to
bokeh.server.contexts. This change is not expected to affect any normal
usage.
arguments parameter for server_session¶
The server_session function accepted an arguments parameter that did not
(and could not) have any actual effect. It has been removed, immediately. Since
the parameter did not function, it is not expected that this change will affect
any normal usage.
Codebase Tests¶
The Pytest “quality” mark has been changed to “codebase”. Now to run the
codebase tests, execute pytest -m codebase. If you have installed a
pre-commit hook to run quality tests before allowing a commit, the hook code
should be updated as above. This change is only expected to affect those who
are developing the Bokeh codebase.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.13.0¶
Bokeh Version 0.13.0 (June 2018) is an incremental update that adds a few
new features and fixes several bugs. Some of the highlights include:
Improved hover tool fields for common stacked bar plot cases
New
CumSumtransform to generate values from cumulative sums of CDS columns on the client side.
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
NOTE: the 0.13.x series is a final series of small releases leading to a 1.0 release. For more information see the project roadmap.
Max Websocket Message Size¶
A new command line option --websocket-max-message-size for the Bokeh
server can be used to configure the Tornado websocket_max_message_size
option. The default value is now 20mb, an increase from the previous
10mb implicit default.
New Hover fields¶
Two new hover tooltip fields are now available:
$namewill preint the value of thenameproperty of a glyph that is being hovered over.@$namewill look up values from a column like a normal@field, but will use$nameas the name of the column.
Both of these are especially useful in conjunction with stacked bar plots.
BokehJS Build¶
The gulp tool was previously used as the build system for BokehJS. This
has been replaced with a smaller and simpler build script. This greatly
reduced the number of dependencies required to build BokehJS and a completely
clean NPM package security audit was obtained as a side effect.
To build now, run the command node make build instead of gulp build.
Task names remained unchanged. If you want preserve the old workflow, e.g. to
aid git bisect, it is suggested to create an alias for node make,
e.g. in bash this would be alias gulp='node make'.
Line Join Default¶
The default line_join style has been changed from miter to bevel,
to avoid exaggerating corners where connected lines meet at a sharp angle.
The HTML Canvas miterLimit property is meant to prevent such issues,
but it does not appear to be respected by current browsers.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.16¶
Bokeh Version 0.12.16 (May 2018) is an incremental update that adds a few
new features and fixes several bugs. Some of the highlights include:
Hover tools now work with image glyphs (#3886)
BokehJS exposes a public
resetmethod for Plots (#5071)Categorical tick labels at all levels may be rotates (:bokeh-issue`7643`)
New
CustomJSHoverfor highly customized tooltip fields (#7647)Axes may now have fixed positions inside plots (#113)
MultiLineandPatchesnow function with categorical ranges (#7462)
And several other bug fixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
NOTE: the 0.12.x series is the last planned release series before a version 1.0 release. For more information see the project roadmap.
Deprecations Removed¶
The following functions, arguments, or features have were previously deprecated with warnings and instructions for new usage, and have now been permanently removed:
--hostargument tobokeh serveresponsiveargument to plots and layout functionsPlot.toolbar_stickypropertyTool.plotpropertybokeh.sampledata.population.load_populationfunctionbokeh.util.notebookmodule
Release History¶
To support publishing all release information on one page, the
bokeh_index_toctree module and contents have been immediately moved to
bokeh_releases. Since this facility had no use outside building
official Bokeh documentation, no deprecation was given.
CDS column_names property¶
ColumnDataSource models had a Bokeh property column_names for specifying
the list of column names in source.data. This information was duplicative
and had to be explicitly maintained in a fragile way. It has been replaced by
read-only properties in both Python and JavaScript that always accurately
report the current column names automatically. Setting column_names is
no longer supported, however as this possibility has never been officially
documented or demonstrated, it is not expected to affect any standard usage.
Tools renderers property¶
Previously the default value, an empty list, corresponded to automatically
choosing all available renderers for hit testing. Now, a new default value
"auto" is used for that, so that an empty list can mean “hit test no
renderers”. A value of None may also be used to indicate no hit testing
should occur. Since there is typically no reason to explicitly set a property
to its default value, it is not expected that this change impacts any standard
usage.
bokehjs’ source directory renamed¶
To finalize the rewrite of bokehjs in TypeScript, the source directory was
renamed from src/coffee to src/lib. This change affects only bokehjs’
contributors or other advanced users (e.g. when repackaging bokehjs with
Webpack or other JavaScript module bundler).
BOKEH_DOCS_MISSING_API_KEY_OK environment variable¶
This environment variable is no longer used by Bokeh. Previously, the
bokeh.sphinxext plot directive would always fail by default if a
GOOGLE_API_KEY environment variable was not defined, and this environment
variable could be set to override that default behavior. Now, builds will
succeed by default, even witout a Google API key defined (but Google Maps plots
will not fully render). To require an API be defined (i.e. to restore the
previous behavior) you can now set bokeh_missing_google_api_key_ok = False
in the Sphinx config file.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.15¶
Bokeh Version 0.12.15 (Mar 2018) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights
include:
Switched to Chrome headless for CI image tests, will support better WebGL testing (#6594)
Updated data source selections to be proper Bokeh models (#6845)
Fixed memory leaks with certain kinds of Bokeh server usage (#7468)
Added new glyphs for hexagon markers and hex tiles, and a new
hexbinmethod #7638, (#4786)Completed BokehJS port to TypeScript (#6481)
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Additionally, we are pleased to announce Bokeh joins NumFOCUS Sponsored Projects.
Migration Guide¶
DataTable¶
The mis-named property DataTable.row_header has been deprecated. This
property confusingly controlled the presence of an index column in a
DataTable. Now, use the index_position property to specify where
an index column should be located in the table (use None to suppress
the index column).
Additionally, new properties index_header and index_width are
now available to further customize the index column appearance.
Selections¶
The handling of selections has needed attention in Bokeh for some time.
This release adds a new Bokeh model Selection
to represent selections on data sources. Having a proper Bokeh model makes
selections simpler to use and to synchronize in apps than the previous
“bare dict” that represented selections.
The new Selection model is found in
the same location on data sources, i.e. source.selected. It has the
following properties:
.indices # which scatter typer indices have been hit
# previously selected["1d"].indices
.line_indices # which point(s) on a line have been hit
# previously selected["0d"].indices
.multiline_indices # which points on which line of a MultiLine
# previously selected["2d"].indices
In the near future, a property image_indices will be added to support
hit testing of image glyphs.
All code should update to use these new properties. For now read only
access to things like selected['1d'].indices will continue to function
as before for compatibility. However, programmatically setting selections
must now go through the mode properties, i.e. .indices, .line_indices,
etc.
Grid Bounds¶
Grids now automatically defer to any existing axis bounds when their own bounds are set to “auto”. Previously grids used always used the full range bounds. This change makes it simpler to have axes and grids both use a consistent set of bounds.
Minor Ticks¶
Minor ticks are no longer displayed outside explicitly set axis bounds. Previously minor ticks would display one extra “major tick” distance outside explicit range bounds.
NO_DATA_RENDERERS¶
This validation warning resulted in false or irrelevant warnings in many reasonable configurations, and has been removed.
Document and ServerContext callbacks¶
All Document and ServerContext methods that add callbacks can now add the same callback multiple times. Methods that remove callbacks now receive the value returned from a previous method call that added the callback. Example:
# Was
doc.add_next_tick_callback(my_cb)
doc.remove_next_tick_callback(my_cb)
# Now
cb_id = doc.add_next_tick_callback(my_cb)
doc.remove_next_tick_callback(cb_id)
Sphinx Version¶
The bokeh.sphinxext Sphinx extension has been updated to work with current versions. Sphinx >= 1.6 is now required to use the extension.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.14¶
Bokeh Version 0.12.14 (Feb 2018) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights
include:
Addition of several tools to draw and edit point, rect, multi-line and patches glyphs (#6370) by modifying the underlying ColumnDataSource.
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Deprecations Removed¶
The following deprecated features have been removed in this release:
DynamicImageRenderer (consider GeoViews instead)
BokehJS support for *.tsx templates (not typically user-facing)
autoload_server (use server_document or server_session instead)
New Runtime Dependency¶
The package packaging, available via both conda and pip, was added as a
new runtime dependency.
Mapping of Unknown Categorical Factors¶
Previously, data (e.g in a CDS column) referring to a categorical factor that
did not exist in the relevant FactorRange, would cause an error in the
browser. Now, any such attempted mappings will silently return NaN. Any
data points with these factors as coordinates will not render.
The practical motivation for this change is that updating a FactorRange
to have a new set of factors could result in an inconsistency triggering the
error condition, causing plots to fail to render. With this change, the use-case
of updating factor ranges should work more smoothly, however there will be no
immediate indication of problems in case “bad” factors are included accidentally
in data other than the data points not being rendered.
Change To Text Glyph Legend¶
Previously Text Glyphs added to legends would always unconditionally render the word “text” as the visual symbol, which was not useful. Now, text glyphs render an empty space in legends. This is helpful when it is desired to use an interactive legend mute or hide both a primary glyph, as well as some associated text that goes with it. For more discussion, see #7337.
MercatorTileSource change¶
MercatorTileSource models previously snapped to the closest zoom level resulting in user supplied axis ranges to be largely ignored. The default behavior has now been changed from snapping to the closest zoom level to simply maintaining the correct aspect ratio, while keeping the user defined bounds contained within the axis ranges.
The old behavior may be restored by setting enabling the snap_to_zoom property.
Defining views’ CSS classes¶
This was previously done through MyView.prototype.className, which didn’t respect class structure, so it was often necessary to duplicate CSS rules in sub-views. The new approach is to override css_classes() method, e.g.:
class MyView extends MyOtherView {
css_classes() {
return super.css_classes().concat("my-view")
}
}
This change affects only creators of custom extensions.
HasProps.initialize()¶
Previously HasProps.initialize() took attrs and options as its arguments.
This was nearly never used and so it was removed. The preferred way to configure
values of attributes is to use bokehjs’ properties system. This change affects
only creators of custom extensions.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.13¶
Bokeh Version 0.12.13 (Dec 2017) is a targeted bugfix release that
addresses two issues:
push_notebookregression in0.12.11Windows package install failures due to reserved “aux” filename
For full details see the CHANGELOG.
Migration Guide¶
BokehJS Changes¶
BokehJS doesn’t require custom styles to make “responsive” layout modes work anymore. This means that there are no additional styles added a page, like margins. This results in margins working differently and now default to browser defaults. If you want to restore the previous behavior, then add the following to your HTML:
<style>
html {
width: 100%;
height: 100%;
}
body {
width: 90%;
height: 100%;
margin: auto;
}
</style>
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.11¶
Bokeh Version 0.12.11 (Nov 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
Stepglyph for step lines added (#3644)Level-of-Detail works with linked plots (#5937)
Bokeh applications in notebooks made simpler to create (#6565)
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
BokehJS Changes¶
To help with the eventual migration to TypeScript, we have switched to the new CoffeeScript compiler. This should be completely transparent to standard users but custom extensions may need small changes in some specific cases, for example, the “Ion Range Slider” required the following change:
- onChange: @slide,
- onFinish: @slidestop
+ onChange: (data) => @slide(data),
+ onFinish: (data) => @slidestop(data),
Shorthand initialization syntax for Range1d(start, end) in bokehjs was removed due to technical difficulties. Use full new Range1d({start, end}) syntax instead. The short syntax may be restored at some point as a part of bokeh-api package.
The coordinate system of canvas layout and related infrastructure (positioning, hit testing, etc.) is new “screen”, where the origin is left-top corner of the canvas. This change shouldn’t affect users, however it affects custom model developers. Follow updated examples for new development patterns.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.10¶
Bokeh Version 0.12.10 (Oct 2017) is an incremental update that adds a few
important features and fixes several bugs. For full details see the
CHANGELOG.
Migration Guide¶
Deprecations Removed¶
The following previous deprecations have been removed:
app_pathfrom functions inbokeh.client.sessionandbokeh.embedstandalone_html_page_for_modelsfrombokeh.embed'patch'and'stream'event names (use'patching'and'streaming')webgl,x_mapper_type,y_mapper_type, andtool_eventsfromPlotGlyphs methods now only accept either all sequence literals, OR all column names
ResizeTool(previously made a no-op) has been removed
New Deprecations¶
The boolean responsive parameter to Figure and bokeh.layouts has
been deprecated. The sizing_mode enum should be used instead. Use
sizing_mode='fixed' for responsive=False and
sizing_mode='scale_width' for responsive=True instead.
The function bokeh.sampledata.population.load_population has been
deprecated. Use the attribute bokeh.sampledata.population.data instead.
Code Moves¶
The module bokeh.util.notebook has been deprecated. The functions it
contains have been moved to bokeh.io.notebook.
The function bokeh.io.set_curdoc is now bokeh.io.doc.set_curdoc.
Named color objects now live in bokeh.colors.named instead of directly in
bokeh.colors. Additionally color utilities such as NamedColor have been
moved inside the package, and marked as internal API. Using string names for
colors works exactly as before.
Dead Code Removal¶
The following unused code was removed immediately:
Aggregationfrombokeh.core.enumsPyPy detection functions from
bokeh.utilZeppelin related code (support should come from external notebook hook)
Additionally the attribute bokeh.__base_version__ was removed. Computing
it at all times made importing Bokeh take substantial fractions of a second
longer than necessary. It is not expected this change should affect any
users, but if you need this value, the bokeh.util.version.base_version
function can be used.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.9¶
Bokeh Version 0.12.9 (Sep 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
JupyterLab integration with the jupyterlab_bokeh extension
Efficient binary transport for sending arrays to clients
Improvements to new Graph/Network capability
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
Deprecated bokeh.charts support removed¶
The bokeh.charts module, which was simply a compatibility shim to load the
separate bkcharts package, has been removed. Additionally, Bokeh itself no
longer lists bkcharts as a dependency. In order to continue using
bkcharts code, the bkcharts package must be installed separately.
Deprecated MPL compatibility removed¶
The bokeh.mpl module and all supporting code in bokeh.core.compat has
been removed. Bokeh no longer offers or attempts any automatic MPL conversion.
Table Date Formatter Changes¶
A regression in 0.12.7 caused the DateFormatter to stop functioning.
The problem has been fixed, however instead of the previously accepted JQuery
style formats, the``format`` property now only accepts
standard strftime format strings (making it consistent with
DatetimeTickFormatter)any of the following additional predefined formats names:
Format name(s)
Format string
Example Output
ATOM/W3C/RFC-3339/ISO-8601"%Y-%m-%d"2014-03-01
COOKIE"%a, %d %b %Y"Sat, 01 Mar 2014
RFC-850"%A, %d-%b-%y"Saturday, 01-Mar-14
RFC-1123/RFC-2822"%a, %e %b %Y"Sat, 1 Mar 2014
RSS/RFC-822/RFC-1036"%a, %e %b %y"Sat, 1 Mar 14
TIMESTAMP(ms since epoch)
1393632000000
Note that the previously available format name
TICKSis no longer supported.
Old Testing Functions Removed¶
The functions bokeh.test and bokeh.util.testing.runtests have been
removed immediately. Tests should be run as described in the testing section
of the Developer’s Guide.
The function bokeh.util.testing.print_versions has been removed
immediately. The bokeh info command (or python -m bokeh info) should be
used instead.
Refactor of bokeh.client and bokeh.document¶
The bokeh.client and bokeh.document packages were refactored, to make
maintenance and testing simpler, and to improve overall code quality. No
commonly used or demonstrated public APIs were affected, (no example code
required any changes). The other files that were moved or changed are not
expected to impact user code.
End of Official Support for Python 3.4¶
Starting with this release, Bokeh is no longer continuously tested against Python 3.4. Use of Bokeh with Python 3.4 will very likely still work, but there are no longer any guarantees backed by CI testing.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.7¶
Bokeh Version 0.12.7 (Aug 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
Support graphs/trees/networks (#187) including configurable and extendable policies for highlighting and selection.
Filterable/Sliceable CDS views (#4070)
Pass HTTP request args to embedded sessions (#5992)
New
Expressionmodels for client-side computations, includingStack, for stacking CDS columns.New module bokeh.transform with helper functions for simplifying
DataSpecexpressions, includingjitter(),dodge(),factor_cmap(), etc.Added
hbar_stack()andvbar_stack()to greatly simplify creation of stacked bar charts.Improvements for using Bokeh with Categorical data:
Support multi-level categories and hierarchical axes
Arbitrary limits on category names (e.g. no
':') have been liftedOptional Pandas integration creates CDS from directly from
GroupByobjectsCategorical Bar, Heatmap and Scatter plots easier to create with stable
bokeh.plottingAPIsNew User’s Guide chapter Handling categorical data
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
New Embed Functions for Bokeh Applications¶
Two new embed functions similar to autoload_server are added, that have
simpler APIs and are more focused:
bokeh.embed.server_document()for embedding new sessions for entire Bokeh documents in HTML pages. (More common)bokeh.embed.server_session()for embedding existing sessions for specified Bokeh models in HTML pages (Less common)
Additionally, with these new methods one may choose to not load the JS/CSS
resource files by passing resources="none" as a parameter.
Deprecations Removed¶
The following previously deprecated modules or features have been removed:
bokeh.iconsmoduleLegacy anchor and legend locations
left_centerandright_centerImageRGBA.rowsandImageRGBA.colspropertiesHBoxandVBoxinbokeh.layoutsvalidatekeyword argument forbokeh.io.save
New Deprecations¶
bokeh.embed.autoload_server has been deprecated and replaced with the
two simpler functions server_document() and
server_session() described above.
bokeh.models.tools.tool_events has been deprecated. Users should instead
use the SelectionGeometry event present on Plot or Figure.
DynamicImageRenderer and Plot.add_dynamic_image have been deprecated.
For GIS-related use-cases built on top of Bokeh, consider using
GeoViews, or creating a Custom Extension.
ResizeTool is deprecated and also immediately is a NO-OP on the Python
side. ResizeTool has been removed from BokehJS entirely.
BokehJS Widgets Bundle Split¶
The bokeh-widgets bundle was split into bokeh-widgets and
bokeh-tables. This is to reduce the weight of the main widgets’ bundle.
Bokeh includes bokeh-tables automatically when necessary, so this change
should be transparent for most users. However, users of custom templates or
other advanced embedding scenarios (including the use of components) may
be affected. In short, if your application is responsible for loading Bokeh
resources, then it should take care of loading the bokeh-tables as well.
TapTool Callback Calling Convention¶
The TapTool strayed from usual callback calling convention by passing a glyph
data source as cb_obj. This has been rectified, and now the tool follows the
usual convention: the tool itself is passed as cb_obj and the data source is
passed as part of the optional cb_data. Existing usage of OpenURL is
unaffected by this change, but any CustomJS callbacks used with the tap tool
will need to be updated to reflect this change.
DataTable Selection Highlighting Signal¶
The DataTable now responds to the signal source.change.emit(), instead of
source.properties.selected.change.emit(), to visually highlight the rows in the
DataTable that are part of the selection. If you have used
source.properties.selected.change.emit() in CustomJS code, you will need to
change it to source.change.emit().
The DataTable responds automatically to changes in its data source’s selected
property. However, because of Bokeh’s change detection machinery, only a replacement
of the selected property causes a change signal to be emitted, and not a partial update
(e.g. source.selected['1d']['indices'] = [1, 2]). If you use a partial update in CustomJS
code, you will need to emit the change signal yourself:
customjs = CustomJS(args=dict(source=source), code="""
source['selected']['1d'].indices = [1, 2]
source.change.emit();
""")
Refactoring of bokeh.server contents¶
The bokeh.server module was refactored in order to be easier to document
and maintain, as well as simpler for user’s to use in more sophisticated use
cases. These changes are not expected to impact standard usage of Bokeh in any
way:
All protocol-related code was moved to a new module
bokeh.protocolThe
Serverclass was split intoServer(no API changes) and a newBaseServerthat can be used when explicit coordination of low level Tornado components is required.Missing sections added to reference guide, and docsctring coverage greatly expanded.
Old cruft code to handle Tornado < 4.3 (which is no longer supported) was removed.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.6¶
Bokeh Version 0.12.6 (Jun 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
Headless, programmatic export of SVG and PNG images (#538)
New annotations
BandandWhiskerfor displaying error estimates (#2352)Fine-grained sub-element patching for images and other “multi” glyphs (#6285)
Hover hit-testing extended to segments and all markers (#5907, #5907)
Fixes for sorting and selecting from DataTables (#3564, #6115)
Large cleanup and refactor of the layout system (#4764, #4810, #5131, #5518, #6213, #6287)
Improved formatting options for hover tool fields and axis tick labels (#1239, #1671, #2595, #6079)
Many other bugfixes and docs additions are also included. For full details see the CHANGELOG.
Migration Guide¶
As the project approaches a 1.0 release, it is necessary to make some changes to bring interfaces and functionality up to a point that can be maintained long-term. We try to limit such changes as much as possible, and have a period of deprecation.
New deprecations¶
The Plot.webgl property has been deprecated in place of a new property
Plot.output_backend in order to avoid conflicts between WebGL and a new
SVG backend. If you are using plot.webgl = True, you should switch to
setting plot.output_backend = "webgl" for the future.
Old deprecations removed¶
All previous deprecations up to 0.12.3 have be removed. Below is the
complete list of removals.
Deprecated
Button.typeproperty has been removed.Deprecated
Legendproperties:legends,legend_margin,legend_padding,legend_spacinghave been removed.Deprecated
DatetimeTickFormatter.formatsproperty has been removed.Tooldimensions may not only be specified with enum values.
New models for Scales¶
The following BokehJS classes have been moved and renamed:
Old |
New |
|---|---|
|
|
|
|
|
|
Previously, these Mapper classes were internal implementation details. The new Scale classes are first-class Bokeh models and are accessible from Python. This was done to facilitate future work supporting custom, user-defined scales.
There is a new Plot validation check to ensure that Scales and Ranges on a
dimension are compatible. By default, Plot models are configured with
LinearScale models which (along with LogScale models) are compatible
with Range1d and DataRange1d range models.
One inevitable breaking change is that users employing a FactorRange in
the bokeh.model API will have to specify a CategoricalScale on the same
dimension. For example:
plot = Plot()
plot.x_range = DataRange1d()
plot.y_range = FactorRange(["Mon", "Tues", "Wed", "Thurs", "Fri"])
plot.y_scale = CategoricalScale()
The bokeh.plotting.figure function should this range and scale
compatibility handling automagically in most cases.
As part of this work, some BokehJS attributes were renamed to be consistent with the new terminology:
Old |
New |
|---|---|
|
|
|
|
|
|
|
|
Since these attributes may be present in user code (e.g CustomJS callbacks or extensions), the old names will continue to work for some time, with a deprecation warning in the JS console.
New signaling API¶
Previously BokehJS used Backbone events for communication between models. As part of an ongoing migration to TypeScript, the Backbone dependency was removed, and the relevant portion replaces with a minimal, type-safe API for signaling.
This change primarily affects contributors working on BokehJS and writers of extensions.
Old |
New |
|---|---|
|
|
|
|
|
|
|
|
Python Datetime handling¶
Bokeh has not handled Python datetime values consistently with NumPy
datetime64. Bokeh aims to treat all datetime values “as-is”, but in some
cases a local timezone conversion could affect Python datetime values. This
has been corrected. In case there is code that depends on the erroneous
behavior, please note that the new behavior is effective immediately and is
now maintained under test to be consistent with NumPy values. See the issue
#5499 for more details.
Layout API and behaviour changes¶
Layout was previously handled on document level and there was one solver per
document. This was changed to one solver per root, so document isn’t anymore
responsible for any layout related stuff. All logic and APIs were moved to
views, specifically to LayoutDOM. For example, if your code relied on
document.resize(width, height), then you should use view.resize(width, height),
where view is an associated view of any of document’s root models.
Views can be obtained through Bokeh.index. To resize all roots use
for (var key in Bokeh.index) {
Bokeh.index[key].resize(width, height);
}
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.5¶
Bokeh Version 0.12.5 (Mar 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
New general capability for Python/JS events (#3210, #3748, #5278)
Bokeh apps easily viewable inline in Jupyter Notebooks (#3461)
Confusing
--hostparameter no longer necessary (#5692)Interactive legends can now control glyph visibility (#2274, #3715)
Many fixes and improvements to
GMapPlotincluding a newgmapfunction for creating Google Maps plots easily (#2822, #2940, #3737, #4835, #5592, #5826, #5845)CustomJSTransformnow available for CDS columns (#5015)Sophisticated “pivot” example app contributed (#5894)
Themes now work with
componentsand in Jupyter notebooks (#4722, #4952, )
Many other bugfixes and docs additions are also included. For full details see the CHANGELOG.
Migration Guide¶
Known Issues¶
The ClientSession APIs defined in bokeh.client.session, such as push_session, don’t currently support the new on_event interface for UI event callbacks in Bokeh Server application. You may track the issue on GitHub (#6092).
As the project approaches a 1.0 release, it is necessary to make some changes to bring interfaces and functionality up to a point that can be maintained long-term. We try to limit such changes as much as possible, and have a period of deprecation.
New Deprecations¶
MPL COMPATIBILITY IS DEPRECATED
Bokeh’s MPL compatibility was implemented using a third-party library that
only exposes a small fraction of all Matplotlib functionality, and is
now no longer being actively maintained. The Bokeh team unfortunately does
not have the resources to continue supporting this functionality, which
was never more than extremely limited in capability, and often produced
substandard results. Accordingly, in order to support the long term health
of the project, it has been decided to remove all MPL compatibility support
on the occasion of a 1.0 release. Any code that currently uses to_bokeh
will continue to work with a deprecation warning until that time.
The bokeh.embed.standalone_html_page_for_models method has been deprecated
in place of bokeh.embed.file_html. For details see pull request 5978.
The validate keyword argument to bokeh.io.save has been deprecated.
Future usage of bokeh.io.save will always validate the document before
outputting a file.
Deprecations removed¶
All previous deprecations up to 0.12.0 have be removed. Below is the
complete list of removals.
Modules and functions and classes that have been removed:
Functions Removed |
Modules Removed |
Classes Removed |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
||
|
The methods bokeh.document.add and push_notebook of
ColumnDataSource have been removed.
The bokeh.io.output_server function has been also been removed.
Additionally, bokeh.io.push and other supporting functions or
properties that are useless without output_server have been
removed. This includes any transitive imports of these functions
from other modules.
Additionally, the property bokeh.charts.builder.Builder.sort_legend was
removed, as well as the following properties of Plot
border_fillbackground_filllogoresponsivetitle_text_aligntitle_text_alphatitle_text_baselinetitle_text_colortitle_text_fonttitle_text_font_size
Host Parameter Obsoleted¶
The --host parameter is now unnecessary. For compatibility, supplying
it will currently cause a warning to be displayed, but it will otherwise
be ignored, and apps will run as normal. In a future release, supplying it
will result in an error.
The --host parameter for the Bokeh server was confusing and difficult to
explain. As long as the Bokeh server relied on the HTTP “host” header to
provide URLs to resources, the --host parameter was a necessary precaution
against certain kinds of HTTP spoofing attacks. However, the Bokeh server
has been updated to no longer require the use of the “host” header (and this
is maintained under test). Accordingly, there is no need to have any check
on the value of the “host” header, and so --host is no longer needed.
Document and Model Refactoring¶
In order that document.py and models.py only contain things that might
be of usual interest to users, some changes and rearrangements were made.
The abstract class decorator was moved from models.py to
has_props.py. The class decorator now also adds an admonition to the
docstring of any class marked abstract that it is not useful to instantiate
directly.
The metaclass Viewable has been renamed to MetaModel.
The document.py module has been split up, and parts that would not be of
normal interest to most users have been moved to better locations.
These changes are not expected to impact user code in any way. For complete details see pull request 5786.
JQuery and underscore.js removed from BokehJS¶
JQuery has been removed as a build dependency of BokehJS. The variable Bokeh.$ is no longer available. If you require JQuery (i.e. for a custom extension or when using the JavaScript API) you will need to provide it explicitly.
underscore.js has been removed as a build dependency of BokehJS. The variable Bokeh._ is no longer available. If you require underscore.js (i.e. for a custom extension or when using the JavaScript API) you will need to provide it explicitly.
Both of these removals together result in a ~10% reduction in the size of the minified BokehJS library.
Default tooltip position for lines changed to nearest point¶
When showing tooltips for lines, the new default is to label the nearest point, instead of the previous point, which used to be the default.
HTTP Request information for apps limited to query arguments¶
The request previously attribute was added to session contexts as a way to
expose HTTP query parameters. It was discovered that providing the entire
request is not compatible with the usage of --num-procs. A method was
found to satisfy the original feature request for query arguments, together
with --num-procs (but only for query arguments). Accordingly the only
attribute that can now be accessed on request is .arguments, e.g.:
curdoc().session_context.request.arguments
Attempting to access any other attribute on request will result in an
error.
Default save file¶
If user-specified or default destination cannot be written to, a temporary
file is generated instead. This mostly affects using output_file in an
interactive session which formerly could result in a PermissionError.
For details see pull request 5942.
The bokeh.io.save method will now only accept a LayoutDOM object and
no longer a Document object for its obj argument. This aligns the
bokeh.io.save argument types with bokeh.io.show.
Reorganization of bokeh’s examples¶
Low-level examples, located under examples/models, were split into file
and server examples and are available under examples/models/file and
examples/models/server respectively (similarly to plotting examples).
Enabling WebGL via URL parameters disallowed¶
Previously it was possible to enable WebGL with ?webgl=1 URL parameter.
With addition of a separate bokeh-gl bundle, this usage is no longer
supportable. WebGL rendering is still configurable using the Plot.webgl
property.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.4¶
Bokeh Version 0.12.4 (Jan 2017) is an incremental update that adds a few
important features and fixes several bugs. Some of the highlights include:
Efficient binary array protocol. (#2204)
A general mechanism to add
CustomJScallbacks to any property. (#5498)Several fixes to log plots. (#2789, #3834, #5389, #5549, #5576)
Guidance and examples for embedding a Bokeh server directly in standalone scripts, Jupyter notebooks, and Tornado and Flask applications.
Support for read-only (client-side) properties, e.g. plot inner dimensions (#5199)
Improved documentation for the bokeh.palettes module. (#5619)
Major refactor of
bokeh.coreincluding expanded documentation and tests (#5626, #5627)
Many other small bugfixes and docs additions. For full details see the CHANGELOG.
Migration Guide¶
As the project approaches a 1.0 release, it is necessary to make some changes to bring interfaces and functionality up to a point that can be maintained long-term. We try to limit such changes as much as possible, and have a period of deprecation.
Broken Dialog Removed¶
The Dialog widget has been broken for some time. Due to lack of user
reports about it, and because custom extensions now provide a path for users
to integrate third party JS dialog libraries, this widget has been removed
immediately.
Custom Extension Import/Export¶
BokehJS is making a slow migration to TypeScript to support long-term stability and maintainability. This necessitates some short term changes for writing custom extensions.
JavaScript extension code with requires and module.exports, such as:
Model = require "model"
class DateGapTickFormatter extends TickFormatter
# implementation here
module.exports =
Model: DateGapTickFormatter
should be re-written as:
import {Model} from "model"
export class DateGapTickFormatter extends TickFormatter
# implementation here
Legend Locations¶
To improve consistency, the following locations names have changed:
old location name |
new location name |
|---|---|
|
|
|
|
The old location names will continue to work for some time with a deprecation warning.
App Current Directory¶
Directory style apps no longer chdir into the app directory. The module
attribute __file__ should be used to construct any file paths relative
to main.py for use with open, etc.
Window Titles¶
Bokeh apps embedded with autoload_server will no longer set the browser
window title.
Positional Argument Order For hbar¶
In order to provide much improved interactive help (true function signatures
and rich auto-generated docstrings) the order of the left and right
parameters to hbar had to be swapped (cannot have non-default args after
a default arg). The new function signature is:
p.hbar(y, height, right, left=0, **kwargs)
Old bokeh-server Command Removed¶
Since 0.11, the old bokeh-server command remained and only printed a
message directing to information about using bokeh serve. It has been
removed completely.
Cruft auto Functions removed¶
The following functions in bokeh.io were long unused and have been
removed: autoadd, autopush, and autosave.
Eco Templates No Longer Supported¶
BokehJS has migrated to using .tsx templates. Provisional support for
including .eco templates has been removed from both BokehJS and the
Bokeh Python library.
Base64 serialisation and Python 3.3¶
The addition a binary protocol that uses a base 64 encoding for NumPy arrays means that Bokeh will not function with NumPy arrays on Python 3.3, due to a bug in Python. A possible workaround is to convert all arrays to plain python lists. As a reminder, Bokeh official support includes Python 2.7 and 3.4+ only.
BokehJS BackboneView $ Removed¶
In part of a longer effort to remove the JQuery dependency from BokehJS
entirely, the $ attribute that BokehJS added to BackboneView
has been removed. Use e.g., @$el.find instead.
Additionally, use of Bokeh.$ and Bokeh._
Refactor of bokeh.core¶
It is expected that all of these these changes should be below the level that standard users will ever be exposed to. These changes are listed here for completeness.
The overly large bokeh.core.properties module has been split up. This
improves maintainability and allows the contents of bokeh.core.properties
to limited to things of that might be useful to users writing custom models.
The new file structure:
bokeh.core.has_propsbokeh.core.propertiesbokeh.core.property.basesbokeh.core.property.containersbokeh.core.property.descriptorsbokeh.core.property.descriptor_factorybokeh.core.property.override
The following class names have been changed to improve intent and clarity (i.e. only things that are actually Python descriptors are named “Descriptor”):
old class name |
new class name |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
The following unused and non-useful properties were removed in this effort:
Align, Event, Function, and This.
The default value for the owner parameter of the __get__ method
on property descriptors was an unnecessary change to the standard Python
descriptor protocol, and has been removed.
Additionally, the HasProps.set method has been removed. The name caused
problems with the Sphinx docs build, and it was an unnecessary duplicate of
HasProps.update (which should be used instead).
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.3¶
Bokeh Version 0.12.3 (Oct 2016) is a minor, incremental update that adds
a few new small features and fixes several bugs. Some of the highlights include:
BokehJS reduced in size by nearly twenty percent
New Categorical color mapper
Tap tool and tooltips working for VBar and HBar
Better hover tool support for some Charts
Auto-generate legends from data in a column
Many small bugfixes
Migration Guide¶
As the project approaches a 1.0 release, it is necessary to make some changes to bring interfaces and functionality up to a point that can be maintained long-term. We try to limit such changes as much as possible, and have a period of deprecation.
Specifying Font Sizes¶
Setting text font size properties directly as strings (e.g. font_size="13px")
has been UN-DEPRECATED. This usage will continue to work, without any further
deprecation warning. (https://github.com/bokeh/bokeh/pull/5274)
output_server¶
The output_server function is deprecated and will be removed in the near
future. Use bokeh.client functions such as push_session instead.
(https://github.com/bokeh/bokeh/pull/5225)
Glyph Methods and Data Sources¶
It is now deprecated to supply both sequence literals and an explicit source to glyph methods. For example:
p.circle([1,2,3], y='foo', source=source) # BAD
Either provide only sequence literals, e.g:
p.circle([1,2,3], y=[4,5,6])
or put all data into the explicitly provided source, e.g:
p.circle(x='foo, y='foo', source=source)
The older usage will continue to function for some time with a deprecation warning, and will result in an error in a future release. (https://github.com/bokeh/bokeh/pull/5187)
FuncTickFormatter¶
FuncTickFormatter instances using JavaScript or CoffeeScript now require code snippets (i.e., function bodies) instead of full function definitions. Additionally, these formatters now accept Bokeh models as arguments so that the models can be readily available to the formatter function code. (https://github.com/bokeh/bokeh/pull/4659/files)
Legend¶
Several legend properties had duplicative legend_ prefixes. The following
property names have been changed:
old property name |
new property name |
|---|---|
|
|
|
|
|
|
The old property names will continue to work for some time with a deprecation warning.
Additionally, the legends property of Legend has been renamed to items,
and given a new type. The new type now accepts a list of LegendItem models,
instead of a list of tuples. The previous format is still accepted for
convenience and compatibility and values are converted automatically. The
legends property will also continue to work for some time with a
deprecation warning.(https://github.com/bokeh/bokeh/pull/5229)
Dimensions¶
Specifying dimensions for tools has changed. The 'x' and 'y' aliases
for 'width' and 'height' have been immediately removed.
Additionally, instead of List(Enum(Dimension), dimensions are now specified
more simply as Enum(Dimension) with valid values "width", "height",
and "both". The previous format will continue to work for some time and be
converted automatically with a deprecation warning.
(https://github.com/bokeh/bokeh/pull/5225)
BokehJS Notes¶
The BokehJS codebase organization has been cleaned up. The file
common/hittest.coffeehas been moved tocore/hittest.coffee. Other files that are unlikely to be used directly by users have also been moved. (https://github.com/bokeh/bokeh/pull/5266)The BokehJS class
GlyphViewno longer inherits fromRenderer.View, it now subclassesBokehView. (https://github.com/bokeh/bokeh/pull/5189)The BokehJS palettes are now only available in the
bokeh-api.jsbundle, and not inbokeh.[min].js(https://github.com/bokeh/bokeh/pull/5183)The BokehJS bundle
bokeh-compiler.jshas been removed completely. All Coffeescript code (for extension modules, etc.) is now pre-compiled by the Bokeh Python library. (https://github.com/bokeh/bokeh/pull/4946)
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.2¶
Bokeh version 0.12.2 (Sept 2016) is aminor update that adds a few “small in footprint, but big in impact” features and several bug fixes including:
Client-side color mapping support for all glyphs
New color bar annotation
Support for loading external resources in custom models - Check out the new LaTeX example at: LaTeX
Hit-testing support for MultiLine glyphs
Improved hover tooltip default styling
Addition of the Brewer qualitative color palettes
Fix intermittent issues with BokehJS loading in Jupyter Notebooks
Split of the Bokeh JS API into a stand-alone bundle
Many small bug fixes
Migration Guide¶
Jupyter Notebook output changes¶
As part of the changes to ensure that the BokehJS client library has loaded
before attempting to render plots in the notebook, a new notebook_handle
argument was added to the bokeh.io.show method. When set to True (with
output_notebook enabled), the show method will return a handle that
can be used with push_notebook.
For users who rely on the notebook handles to update plots out of their render
order, you’ll have to add notebook_handle=True to your show invocations
like below:
from bokeh.plotting import figure
from bokeh.io import output_notebook, push_notebook, show
output_notebook()
plot = figure()
plot.circle([1,2,3], [4,6,5])
handle = show(plot, notebook_handle=True)
# Update the plot title in the earlier cell
plot.title = "New Title"
push_notebook(handle=handle)
BokehJS API Changes¶
In order to shrink the size of the main BokehJS library and reduce pageload times, the Bokeh JS API has been separated into it’s own bokeh-api(.min).js bundle. For users requiring the JS API, it will be necessary to add the new resource to their HTML templates.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.1¶
Bokeh Version 0.12.1 (Jul 2016) is a minor, incremental update that adds
a few new small features and fixes several bugs. Some of the highlights include:
Add
.patchmethod toColumnDataSourcefor efficient partial updates.Add
.visibleproperty to all glyphs for easy on/off capability.Add qualitative Brewer colormapps to
bokeh.palettes.Add new
VBarandHBarglyph types.Update BokehJS to use use RBush 2.0.1 for more efficient spatial indexing.
Restore
ResizeToolfunctionality for simple layouts.Fix Windows support for conda build, docs build, and running unit tests.
Fix a bug in the HTML template for
autoload_servercausing incorrect layouts.Fix a bug in the toolbar CSS, causing it to interfere with hit testing and selection.
Fix WebGL support for Safari, and WebGL bug affecting line thickness.
Fix intermittent issues with BokehJS loading in Jupyter notebooks.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.12.0¶
Bokeh Version 0.12.0 (Jun 2016) is a large release with many new
improvements:
Responsive layout and styling improvements throughout
BokehJS plotting and charts APIs for pure JS dev
Legends can be placed outside / next to the central plot area
Expanded WebGL support to all markers, fixed webgl bugs
New color palettes: Viridis, Magma, Inferno, and Plasma
New model types:
Arrow, Title, and Label annotations
LogColorMapper for scaled color mapping
FuncTickFormatter for simpler custom ticking
Support for computed transforms (e.g. Jitter) on data columns
Documentation improvements:
re-done user gude sections for layout
new user guide sections for JS APIs
new user guide sections for custom extensions
Server features:
unlocked callbacks for use with threads
“–num-threads” option for simpler deployment
new index landing page listing installed aps
UX improvements
toolbar moved to the right, and made sticky, by default
left aligned title, closer in, by default
smaller, italic axes labels
New hosted demos at https://demo.bokeh.org
Many small bug fixes
Migration Guide¶
Known Issues¶
Currently the most reliable sizing modes for layouts are “fixed” and
“scale_width”. Other modes may work, or may produce undesired effects.
Work on layout is still ongoing. Support for “mixes” sizing modes
will come in a future release. Additionally, the ResizeTool does
not function reliably with responsive layout, and will most likely
be deprecated in a future release.
Google Maps¶
Google has made a change to their terms of use for google maps, and “effective immediately”, ALL google maps API calls MUST have an API key, or they will not function:
All Bokeh GMapPlot models must have their api_key property set,
or they will not function properly. PLEASE NOTE: all previously created
GMap plots from any previous version of Bokeh are affect by this TOS
change.
Examples¶
All WebGL examples have been moved under examples/webgl. The
timeout.py and random_tiles app examples have been removed
in favor of new, better examples. Several examples of new layout
capability are under examples/howto/layout.
BokehJS¶
The mechanism for declaring properties on BokehJS has changed, with the
addition of the @define, @override and @internal methods.
This may affect existing custom extesnions. Until now, BokehJS details
were considered an internal implementation detail. In the future, more
attention will be given to BokehJS stability.
Deprecations and Compatibility¶
The new layout work was a large undertaking. As a result, there are many deprecations, including hplot, vplot, etc. Almost all old functions will continue to function, while issuing deprecation warnings. However, there are newer functions that should be preferred. The most up-to-date guidance for layout going forward is at:
In most cases it was possible to move forward with a deprecation, for the time being, but there are two small hard compatibility breaks that could not be avoided:
Plot.title¶
This attribute is now a Title object. It is no longer possible to set, e.g.
p.title = "some text" as a string value. Instead, you must do:
p.title.text = “some_text”
It is still possible to pass the title` keyword argument a string value
to figure and Charts, as a convenience. Additionally all other title
related properties on Plot, e.g title_text_color continue to work
for now, while issuing deprecation warnings.
session.show¶
The ClientSession.show method must now be explicitly passed the thing to
be shown. It is no longer possible to call, e.g. session.show() without
a parameter. Instead, you must do:
session.show(plot)
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.11.1¶
Bokeh version 0.11.1 (Feb 2016) focuses on providing bug fixes, small
features, and documentation improvements. Highlights include:
settings and documentation for Bokeh server behind an SSL terminated proxy
bugfixes:
MultiSelect works
Oval legend renders correctly
Plot title orientation setting works
Annulus glyph works on IE/Edge
features:
preview of new streaming API in OHLC demo
undo/redo tool add, reset tool now resets plot size
“bokeh static” and “bokeh sampledata” commands
can now create Bokeh apps directly from Jupyter Notebooks
headers and content type now configurable on AjaxDataSource
Additionally some internal work has started to refactor and clean up BokehJS to bring the class and file structure into closer alignment with the Bokeh python library.
Migration Guide¶
Range update callbacks now return the range object as cb_obj (not the plot)
Layouts (HBox, VBox, VBoxForm) have been moved from bokeh.models.widgets to bokeh.models.layouts, but continue to be importable from bokeh.models
BlazeDataSource has been removed; it will be maintained by the Blaze team in the future.
The broken BokehJS API has been removed. We are actively seeking a champion/maintainer for a new BokehJS API.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.11.0¶
Bokeh Version 0.11.0 (Jan 2016) is a large release with many new improvements
New Tornado and websocket-based Bokeh Server
bokehcommand line tool for creating applicationsexpanded docs including deployment guidance
video demonstrations and tutorials
supports async, periodic, timeout and model event callbacks
python client API
User-Defined Models allowing anyone to extend Bokeh
GeoJSON data source and map tiles renderer
WebGL support for rendering lines
Python -> JS compilation for CustomJS callbacks (Py3 only for now)
New general push_notebook() based on Jupyter comms
Updates to charts
all legacy charts converted
more examples and expanded docs
UX improvements
configurable and “auto” range bounds
wheel zoom scroll capture turned off by default
hover policy for glyphs
responsive improvements
Known issues
annulus glyph does not render correctly on IE and Edge
many small bug fixes
Migration Guide¶
Known Issues¶
Server output in the Jupyter notebook with output_server is currently not functioning correctly, and will be fixed in a follow on 0.11.1 release shortly. However, new notebook comms can enable many of the same kinds of interactions and notebook-based apps without a Bokeh server.
The Image glyph does not currently work with the Bokeh server, and will be fixed in a follow on 0.11.1 release shortly.
Deprecations¶
The previous Flask-based bokeh-server has been completely removed and
replaced with the new bokeh serve based on Tornado and a websocket
protocol. If you require to use bokeh-server you will have to remain on
Bokeh version 0.10.0 or lower.
All “old-style” charts in bokeh._legacy_charts have been updated to use
the more consistent and powerful bokeh.charts interface, and
bokeh._legacy_charts has been removed.
Bokeh deprecation warnings, which are not enabled by default python, have now been unconditionally enabled and are always displayed.
ColumnDataSource.push_notebook() has been deprecated (but still works)
in favor of the more general bokeh.io.push_notebook() base on Jupyter
notebook websocket comms.
The following modules have been deprecated (but still work), with new counterparts as described in this table:
Old location |
New location |
|---|---|
|
|
|
|
|
|
|
|
|
|
Additionally, the following modules that should not be of interest to general users have been moved immediately, without deprecation:
Old location |
New location |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
If you have been using file_html and manually passing in
js_resources or css_resources, your call will no longer
work. You can still do this, but you pass a tuple to the resources
argument.
Before:
html = file_html(layout, None, title=title, template=template, js_resources=js_resources, css_resources=css_resources)
v0.11:
html = file_html(layout, resources=(js_resources, css_resources), title=title, template=template)
Note you can pass None in place of either js_resources or css_resources.
|
Filename |
Hash |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
0.10.0¶
Bokeh 0.10.0 (Sep 2015) provides several new features such as WebGL support,
a new refactored and more powerful chart interface and responsive plots. Also
bugfixes and enhancements in our documentation, testing and build machinery,
and examples.
Initial webgl support (check our new examples: maps city, iris blend, scatter 10K, clustering.py)
New charts interface supporting aggregation (see our new Bars, BoxPlot, Histogram and Scatter examples)
Responsive plots
Lower-level jsresources & cssresources (allow more subtle uses of resources)
Several test machinery fixes
Several build machinery enhancements
More pytest-related fixes and enhancements
More docs fixes and enhancements
Now the glyph methods return the glyph renderer (not the plot)
Gmap points moves consistently
Added alpha control for imageurl objects
Removed python33 testing and packaging
Removed multiuserblazeserver
Migration Guide¶
This release introduced a new, often requested style of chart interface that
is centered around Pandas DataFrames. All of “old style” charts in the
bokeh.charts interface have been moved to bokeh._legacy_charts,
which will eventually be removed, when all charts have been updated.
To continue to use the old charts, replace``bokeh.charts`` with
bokeh._legacy_charts, e.g.:
from bokeh.charts import Area
becomes
from bokeh._legacy_charts import Area
|
Filename |
Hash |
|---|---|
|
|
|
|
0.9.3¶
Bokeh 0.9.3 (Aug 2015) provides several usability enhancements, better
docs, new examples, a lot of bug fixes and an improved testing machinery (using
pytest and selenium-based test).
Support horizontal or vertical spans
Provide raw_components version of bokeh.embed.components
Prevent Bokeh from eating scroll events if wheel tool is not active
bokeh.models.actions are now called bokeh.models.callbacks and Callback is now CustomJS
Additional validation warnings
Cleaned up gulp source mapping
Fixes in our build machinery
Cleaned up models section of the reference guide
Use pytest instead of nose
Beginning to add selenium tests
|
Filename |
Hash |
|---|---|
|
|
|
|
0.9.2¶
Bokeh 0.9.2 (Jul 2015) provides several bugfixes. Additionally, the MPL
compatibility layer was updated.
Several nan-related fixes including the slow rendering of plots
Removed some unused dependencies
Fixes in our automated release process
Fixed the patchs vanishing on selection
More control over ticks and gridlines
MPL compatibility updated
Several examples updated
|
Filename |
Hash |
|---|---|
|
|
|
|
0.9.1¶
Bokeh 0.9.1 (Jul 2015) focused on extending Bokeh’s new callback system by
adding more places where callbacks can be used, expanding and improving the
new User’s Guide, exposing better ways to embed Bokeh plots and widgets into
your own layouts, and providing validation error and warning feedback to
diagnose problems.
New callbacks options for hover, selection, and range updates
Documentation for widgets and new callbacks in the User’s Guide
Much more flexible embed.components that can embed multiple objects
Implemented a validation framework to provide errors and warnings
More than 30 smaller bugfixes
|
Filename |
Hash |
|---|---|
|
|
|
|
0.9.0¶
Bokeh 0.9.9 (May 2015) provides sophisticated interactions in static plots
using a new Callback Action, a complete rewrite of the User guide and big
BokehJS refactoring switching to use browserify.
Callback Action, serverless interactivity in static plots
Hover inspection along lines
Client side LOD downsampling for interactive tools
Full User guide rewrite
Reduce BokehJS boilerplate and switch to use browserify
Several example bugfixes
|
Filename |
Hash |
|---|---|
|
|
|
|
0.8.2¶
Bokeh 0.8.2 (Mar 2015) is a quick release focused on some refactoring,
bug fixes and improved documentation.
Collect implicit interfaces into a single bokeh.io module
Fixed notebook css issues
Update notebooks to be compatible with IPython 3.0
Easy bokeh applet generation using the simpleapp module
Develop installation enhancements
A new User guide intro and some other docs styling enhancements
Some other minor examples bugfixes
|
Filename |
Hash |
|---|---|
|
|
|
|
0.8.1¶
Bokeh 0.8.1 (Feb 2015) is focused on stability, bug fixes and improved
documentation.
Fixed HoverTool
Fixed Abstract rendering implementation and docs
Fixed chart gallery and docs
Removed leftovers from the old plotting API implementation
Some other minor docs fixes
|
Filename |
Hash |
|---|---|
|
|
|
|
0.8.0¶
Bokeh 0.8.0 (Feb 2015) includes many major new features:
New and updated language bindings: R, JavaScript, Julia, Scala, and Lua now available
Better bokeh-server experience:
live gallery for server apps and examples!
new “publish” mode Bokeh plots and apps
docs and advice for real-world deployments
Simpler and more easily extensible charts architecture, with new Horizon chart
Dramatic build and documentation improvements:
100% complete reference guide
full docs and BokehJS version deployed for every “dev” build and RC
sphinx extensions for easy inline plots
Shaded grid bands, configurable hover tool, and pan/zoom for categorical plots
Improved and more robust crossfilter
AjaxDataSource for clients to stream data without a Bokeh server
In addition, many bugfixes and small features, both old and new — over 100 issues — were closed for this release! Additionally several new contributors helped out in a big way. Special thanks to Sarah Bird, Mathieu Drapeau, Samantha Hughes, and Nick Roth.
|
Filename |
Hash |
|---|---|
|
|
|
|
0.7.1¶
Bokeh 0.7.1 (Jan 2015) focused on stability, bug fixes, improved
documentation and better examples.
Several bokeh.charts bug fixes and enhancements, such as configurable tools
Docs improvements, in particular, documenting json for bokeh.models
Mpl compatibility improved, now returning the plot object
A lot of encoding fixes, including fixes in some of our sample data
Faster runs in TravisCI using the new docker-based containerized infrastructure
New and improved examples, such as the Interactive Image Processing with Numba and Bokeh notebook
0.7.0¶
Bokeh 0.7.0 (Dec 2014) focused on new features and capability, particularly
arounduser interface and experience:
IPython widgets and animations without a Bokeh server
Touch UI working for tools on mobile devices
Vastly improved linked data table
More new (and improving) bokeh.charts (high level charting interface)
Color mappers on the python side
Improved toolbar
Many new tools: lasso, poly, and point selection, crosshair inspector
Migration Guide¶
Additionally, note that the “implicit” plotting interface of plotting.py has been deprecated, and will be removed in Bokeh 0.8. In a nutshell, code such as:
figure()
hold()
line()
circle()
show()
Should be replaced with the more explicit code:
p = figure()
p.line()
p.circle()
show(p)
0.6.1¶
Bokeh 0.6.1 (Sep 2014) is a minor release.
Toolbar enhancements
bokeh-server fixes
Improved documentation
Button widgets
Google map support in the Python side
Code cleanup in the JS side and examples
New examples
0.6.0¶
Bokeh 0.6.0 (Sep 2014) is an incremental update:
Abstract Rendering recipes for large data sets: isocontour, heatmap, hdalpha
Improved, configurable tool bar for plots
Full Python 3 support for bokeh-server
Much expanded User Guide
Support for multiple axes
Plot object graph query interface
New charts in bokeh.charts: TimeSeries and Categorical HeatMap
Hit-testing for patch glyphs
0.5.2¶
Bokeh 0.5.2 (Aug 2014) is an incremental update:
New Layout system
Improved automate testing infrastructure
AR testing, server-side downsample fixes and ISO Contours
New “dashboard-like” example: examples/app/applet/stock_example.py
0.5.1¶
Bokeh 0.5.1 (Jul 2014) is an incremental update:
Hover activated by default
Boxplot in bokeh.charts
Better messages when you forgot to start the bokeh-server
Fixed some packaging bugs
Fixed NBviewer rendering
Fixed some Unicodeencodeerror
0.5.0¶
Bokeh 0.5.0 (Jul 2014) adds the following features:
Widgets
Initial AR integration
bokeh.charts (scatter, bar, histogram)
improved embedding API
minor ticks, plot frame, and log axes
0.4.4¶
Bokeh 0.4.4 (Apr 2014) is a minor release:
Improved MPL interface, subplots, styling plus more examples
TravisCI testing integration
Tool enhancements, constrained pan/zoom, more hover glyphs
Server remote data and downsampling examples
Initial work for Bokeh “app” concept
0.4.2¶
Bokeh 0.4.2 (Mar 2014) is a minor release:
Improved MPL interface, PolyCollection plus examples
Extensive tutorial with exercises and solutions
%bokeh magic for IPython notebook
InMemory storage backend for bokeh-server (usable without Redis)
0.4.1¶
Bokeh 0.4.1 (Feb 2014) is a minor release:
Improved MPL interface, LineCollection plus examples
Scala interface
Categorical axes and ranges
Hover tool
Improved pan/zoom tool interactions
0.4.0¶
Bokeh 0.4.4 (Feb 2014) is an incremental release with several important
new pieces of work:
Preliminary work on Matplotlib support: convert MPL figures to Bokeh plots
Tool improvements:
“always on” pan tool and wheel zoom tool
box zoom tool
viewport reset tool
Enhanced datetime axis, with better performance and nicer ticking
Expanded testing, including TravisCI integrations and static image output using PhantomJS
RGBA and color mapped image plots now available from Python
Python 3 support!
Vastly improved documentation for glyphs, with inline examples and JSFiddle integration
0.3.0¶
Bokeh 0.3.0 (Nov 2013) is a minor release:
refactor bokehjs to use grunt for coffee build
merge bokeh and bokehjs repositories
various bug fixes
additional and improved examples and docs
0.2.0¶
Bokeh 0.2.0 (Oct 2013) is a minor release:
bokeh.plotting interface for schematized plotting, that wraps the low-level interface
Performance improvements in BokehJS
Fixed rendering glitches for HiDPI/Retina displays
Greatly improved Python interface architecture
Many more examples, much improved docs
0.1.0¶
Bokeh 0.1.0 (Apr 2013) is the initial public release of the Bokeh project:
Basic low-level interface, consisting of wrapper objects for BokehJS rendering primitives, glyphs, tools
Beginnings of the ggplot-style interface that wraps the low-level interface
Simple line/scatter/bar/image plots with a Matplotlib-like interface
Static HTML output
Live server output
IPython notebook embedding capability
Table widget
Pan, Zoom, Select, Resize tools
initial Python implementation of Abstract Rendering