''' This is the Bokeh charts interface. It gives you a high level API to build
complex plot is a simple way.
This is the main Chart class which is able to build several plots using the low
level Bokeh API. It setups all the plot characteristics and lets you plot
different chart types, taking OrderedDict as the main input. It also supports
the generation of several outputs (file, server, notebook).
'''
from __future__ import absolute_import
from collections import defaultdict
import warnings
import numpy as np
from bokeh.core.enums import enumeration
from bokeh.core.properties import Auto, Either, Enum, String, value
from bokeh.models import CategoricalAxis, DatetimeAxis, FactorRange, glyphs, Grid, HoverTool, Legend, LegendItem, LinearAxis, markers, Plot
from bokeh.plotting import DEFAULT_TOOLS
from bokeh.plotting.helpers import _process_tools_arg, _glyph_function, _process_active_tools
from bokeh.util._plot_arg_helpers import _convert_responsive
Scale = enumeration('linear', 'categorical', 'datetime')
class ChartDefaults(object):
def apply(self, chart):
"""Apply this defaults to a chart."""
if not isinstance(chart, Chart):
raise ValueError(
"ChartsDefaults should be only used on Chart objects but it's being used on %s instead." % chart
)
all_props = set(chart.properties_with_values(include_defaults=True))
dirty_props = set(chart.properties_with_values(include_defaults=False))
for k in list(all_props.difference(dirty_props)) + \
list(chart.__deprecated_attributes__):
if k == 'tools':
value = getattr(self, k, True)
if getattr(chart, '_tools', None) is None:
chart._tools = value
else:
if hasattr(self, k):
setattr(chart, k, getattr(self, k))
defaults = ChartDefaults()
[docs]class Chart(Plot):
""" The main Chart class, the core of the ``Bokeh.charts`` interface.
"""
__view_model__ = "Plot"
__subtype__ = "Chart"
xlabel = String(None, help="""
A label for the x-axis. (default: None)
""")
ylabel = String(None, help="""
A label for the y-axis. (default: None)
""")
xscale = Either(Auto, Enum(Scale), help="""
What kind of scale to use for the x-axis.
""")
yscale = Either(Auto, Enum(Scale), help="""
What kind of scale to use for the y-axis.
""")
_defaults = defaults
__deprecated_attributes__ = (
'filename', 'server', 'notebook', 'width', 'height', 'xgrid', 'ygrid', 'legend'
'background_fill', 'border_fill', 'logo', 'tools',
'title_text_baseline', 'title_text_align', 'title_text_alpha', 'title_text_color',
'title_text_font_style', 'title_text_font_size', 'title_text_font', 'title_standoff'
)
_xgrid = True
_ygrid = True
_legend = True
@Plot.xgrid.setter
def xgrid(self, value):
warnings.warn("Non-functional 'xgrid' setter has been removed; use 'xgrid' keyword argument to Chart instead")
@Plot.ygrid.setter
def ygrid(self, value):
warnings.warn("Non-functional 'ygrid' setter has been removed; use 'ygrid' keyword argument to Chart instead")
@Plot.legend.setter
def legend(self, value):
warnings.warn("Non-functional 'legend' setter has been removed; use 'legend' keyword argument to Chart instead")
[docs] def __init__(self, *args, **kwargs):
# pop tools as it is also a property that doesn't match the argument
# supported types
tools = kwargs.pop('tools', None)
for name in ['xgrid', 'ygrid', 'legend']:
if name in kwargs:
kwargs["_" + name] = kwargs[name]
del kwargs[name]
if 'responsive' in kwargs and 'sizing_mode' in kwargs:
raise ValueError("Chart initialized with both 'responsive' and 'sizing_mode' supplied, supply only one")
if 'responsive' in kwargs:
kwargs['sizing_mode'] = _convert_responsive(kwargs['responsive'])
del kwargs['responsive']
self._active_drag = kwargs.pop('active_drag', 'auto')
self._active_scroll = kwargs.pop('active_scroll', 'auto')
self._active_tap = kwargs.pop('active_tap', 'auto')
title_text = kwargs.pop("title", None)
super(Chart, self).__init__(*args, **kwargs)
self.title.text = title_text
defaults.apply(self)
if tools is not None:
self._tools = tools
# TODO (fpliger): we do this to still support deprecated document but
# should go away when __deprecated_attributes__ is empty
for k in self.__deprecated_attributes__:
if k in kwargs:
setattr(self, k, kwargs[k])
self._glyphs = []
self._built = False
self._builders = []
self._renderer_map = []
self._ranges = defaultdict(list)
self._labels = defaultdict(list)
self._scales = defaultdict(list)
self._tooltips = []
if hasattr(self, '_tools'):
self.create_tools(self._tools, self._active_drag, self._active_scroll, self._active_tap)
[docs] def add_renderers(self, builder, renderers):
self.renderers += renderers
self._renderer_map.extend({ r._id : builder for r in renderers })
[docs] def add_builder(self, builder):
self._builders.append(builder)
builder.create(self)
[docs] def add_ranges(self, dim, range):
self._ranges[dim].append(range)
[docs] def add_labels(self, dim, label):
self._labels[dim].append(label)
[docs] def add_scales(self, dim, scale):
self._scales[dim].append(scale)
def _get_labels(self, dim):
if not getattr(self, dim + 'label') and len(self._labels[dim]) > 0:
return self._labels[dim][0]
else:
return getattr(self, dim + 'label')
[docs] def create_axes(self):
self._xaxis = self.make_axis('x', "below", self._scales['x'][0], self._get_labels('x'))
self._yaxis = self.make_axis('y', "left", self._scales['y'][0], self._get_labels('y'))
[docs] def create_grids(self, xgrid=True, ygrid=True):
if xgrid:
self.make_grid(0, self._xaxis.ticker)
if ygrid:
self.make_grid(1, self._yaxis.ticker)
[docs] def start_plot(self):
"""Add the axis, grids and tools
"""
self.create_axes()
self.create_grids(self._xgrid, self._ygrid)
if self.toolbar.tools:
self.create_tools(self._tools, self._active_drag, self._active_scroll, self._active_tap)
if len(self._tooltips) > 0:
self.add_tools(HoverTool(tooltips=self._tooltips))
[docs] def add_legend(self, chart_legends):
"""Add the legend to your plot, and the plot to a new Document.
It also add the Document to a new Session in the case of server output.
Args:
legends(List(Tuple(String, List(GlyphRenderer)): A list of
tuples that maps text labels to the legend to corresponding
renderers that should draw sample representations for those
labels.
"""
location = None
if self._legend is True:
location = "top_left"
else:
location = self._legend
items = []
for legend in chart_legends:
items.append(LegendItem(label=value(legend[0]), renderers=legend[1]))
if location:
legend = Legend(location=location, items=items)
self.add_layout(legend)
[docs] def make_axis(self, dim, location, scale, label):
"""Create linear, date or categorical axis depending on the location,
scale and with the proper labels.
Args:
location(str): the space localization of the axis. It can be
``left``, ``right``, ``above`` or ``below``.
scale (str): the scale on the axis. It can be ``linear``, ``datetime``
or ``categorical``.
label (str): the label on the axis.
Return:
axis: Axis instance
"""
# ToDo: revisit how to handle multiple ranges
# set the last range to the chart's range
if len(self._ranges[dim]) == 0:
raise ValueError('Ranges must be added to derive axis type.')
data_range = self._ranges[dim][-1]
setattr(self, dim + '_range', data_range)
if scale == "auto":
if isinstance(data_range, FactorRange):
scale = 'categorical'
else:
scale = 'linear'
if scale == "linear":
axis = LinearAxis(axis_label=label)
elif scale == "datetime":
axis = DatetimeAxis(axis_label=label)
elif scale == "categorical":
axis = CategoricalAxis(
major_label_orientation=np.pi / 4, axis_label=label
)
else:
axis = LinearAxis(axis_label=label)
self.add_layout(axis, location)
return axis
[docs] def make_grid(self, dimension, ticker):
"""Create the grid just passing the axis and dimension.
Args:
dimension(int): the dimension of the axis, ie. xaxis=0, yaxis=1.
ticker (obj): the axis.ticker object
Return:
grid: Grid instance
"""
grid = Grid(dimension=dimension, ticker=ticker)
self.add_layout(grid)
return grid
annular_wedge = _glyph_function(glyphs.AnnularWedge)
annulus = _glyph_function(glyphs.Annulus)
arc = _glyph_function(glyphs.Arc)
asterisk = _glyph_function(markers.Asterisk)
bezier = _glyph_function(glyphs.Bezier)
circle = _glyph_function(markers.Circle)
circle_cross = _glyph_function(markers.CircleCross)
circle_x = _glyph_function(markers.CircleX)
cross = _glyph_function(markers.Cross)
diamond = _glyph_function(markers.Diamond)
diamond_cross = _glyph_function(markers.DiamondCross)
ellipse = _glyph_function(glyphs.Ellipse)
hbar = _glyph_function(glyphs.HBar)
image = _glyph_function(glyphs.Image)
image_rgba = _glyph_function(glyphs.ImageRGBA)
image_url = _glyph_function(glyphs.ImageURL)
inverted_triangle = _glyph_function(markers.InvertedTriangle)
line = _glyph_function(glyphs.Line)
multi_line = _glyph_function(glyphs.MultiLine)
oval = _glyph_function(glyphs.Oval)
patch = _glyph_function(glyphs.Patch)
patches = _glyph_function(glyphs.Patches)
quad = _glyph_function(glyphs.Quad)
quadratic = _glyph_function(glyphs.Quadratic)
ray = _glyph_function(glyphs.Ray)
rect = _glyph_function(glyphs.Rect)
segment = _glyph_function(glyphs.Segment)
square = _glyph_function(markers.Square)
square_cross = _glyph_function(markers.SquareCross)
square_x = _glyph_function(markers.SquareX)
text = _glyph_function(glyphs.Text)
triangle = _glyph_function(markers.Triangle)
vbar = _glyph_function(glyphs.VBar)
wedge = _glyph_function(glyphs.Wedge)
x = _glyph_function(markers.X)
