Models

Glyphs

Bokeh.AnnularWedgeConstant

Render annular wedges.

Properties

  • AnnularWedge: direction, end_angle, end_angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, inner_radius, inner_radius_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, outer_radius, outer_radius_units, start_angle, start_angle_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.AnnulusConstant

Render annuli.

Properties

  • Annulus: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, inner_radius, inner_radius_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, outer_radius, outer_radius_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ArcConstant

Render arcs.

Properties

  • Arc: direction, end_angle, end_angle_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, radius, radius_units, start_angle, start_angle_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BezierConstant

Render Bezier curves.

For more information consult the Wikipedia article for Bezier curve.

Properties

  • Bezier: cx0, cx1, cy0, cy1, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x0, x1, y0, y1.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CircleConstant

Render circle markers.

Properties

  • Circle: radius, radius_dimension, radius_units.

  • Marker: angle, angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, hit_dilation, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, size, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ConnectedXYGlyphConstant

Base class of glyphs with x and y coordinate attributes and a connected topology.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EllipseConstant

Render ellipses.

Properties

  • Ellipse: angle, angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, height, height_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, width, width_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FillGlyphConstant

Glyphs with fill properties

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GlyphConstant

Base class for all glyph models.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HAreaConstant

Render a horizontally directed area between two equal length sequences of x-coordinates with the same y-coordinates.

Properties

  • HArea: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, x1, x2, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HBarConstant

Render horizontal bars, given a center coordinate, height and (left, right) coordinates.

Properties

  • HBar: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, height, left, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, right, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HatchGlyphConstant

Glyphs with Hatch properties

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HexTileConstant

Render horizontal tiles on a regular hexagonal grid.

Properties

  • HexTile: aspect_scale, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, orientation, q, r, scale, size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ImageConstant

Render images given as scalar data together with a color mapper.

In addition to the defined model properties, Image also can accept a keyword argument palette in place of an explicit color_mapper. The value should be a list of colors, or the name of one of the built-in palettes in bokeh.palettes. This palette will be used to automatically construct a ColorMapper model for the color_mapper property.

If both palette and color_mapper are passed, a ValueError exception will be raised. If neither is passed, then the Greys9 palette will be used as a default.

Properties

  • Image: color_mapper, dh, dh_units, dilate, dw, dw_units, global_alpha, image, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ImageRGBAConstant

Render images given as RGBA data.

Properties

  • ImageRGBA: dh, dh_units, dilate, dw, dw_units, global_alpha, image, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ImageURLConstant

Render images loaded from given URLs.

Properties

  • ImageURL: anchor, angle, angle_units, dilate, global_alpha, h, h_units, retry_attempts, retry_timeout, url, w, w_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LineConstant

Render a single line.

The Line glyph is different from most other glyphs in that the vector of values only produces one glyph on the Plot.

Note

Due to limitations in the underlying HTML canvas, it is possible that a line is not drawn when one or more of its coordinates is very far outside the viewport. This behavior is different for different browsers. See :bokeh-issue:`11498` for more information.

Properties

  • Line: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LineGlyphConstant

Glyphs with line properties

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MarkerConstant

Base class for glyphs that are simple markers with line and fill properties, located at an (x, y) location with a specified size.

Note

For simplicity, all markers have both line and fill properties declared, however some marker types (asterisk, cross, x) only draw lines. For these markers, the fill values are simply ignored.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Marker: angle, angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, hit_dilation, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, size, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MultiLineConstant

Render several lines.

The data for the MultiLine glyph is different in that the vector of values is not a vector of scalars. Rather, it is a "list of lists".

Properties

  • MultiLine: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, xs, ys.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MultiPolygonsConstant

Render several MultiPolygon.

Modeled on geoJSON - the data for the MultiPolygons glyph is different in that the vector of values is not a vector of scalars. Rather, it is a "list of lists of lists of lists".

During box selection only multi-polygons entirely contained in the selection box will be included.

Properties

  • MultiPolygons: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, xs, ys.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.OvalConstant

Render ovals.

This glyph renders ovals using Bezier curves, which are similar, but not identical to ellipses. In particular, widths equal to heights will not render circles. Use the Ellipse glyph for that.

Properties

  • Oval: angle, angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, height, height_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, width, width_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PatchConstant

Render a single patch.

The Patch glyph is different from most other glyphs in that the vector of values only produces one glyph on the Plot.

Properties

  • Patch: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PatchesConstant

Render several patches.

The data for the Patches glyph is different in that the vector of values is not a vector of scalars. Rather, it is a "list of lists".

During box selection only patches entirely contained in the selection box will be included.

Properties

  • Patches: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, xs, ys.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.QuadConstant

Render axis-aligned quads.

Properties

  • Quad: bottom, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, left, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, right, top.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.QuadraticConstant

Render parabolas.

Properties

  • Quadratic: cx, cy, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x0, x1, y0, y1.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RayConstant

Render rays.

Properties

  • Ray: angle, angle_units, length, length_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RectConstant

Render rectangles.

Properties

  • Rect: angle, angle_units, dilate, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, height, height_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, width, width_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScatterConstant

Render scatter markers selected from a predefined list of designs.

Use Scatter to draw any of Bokeh's built-in marker types: asterisk, circle, circle_cross, circle_dot, circle_x, circle_y, cross, dash, diamond, diamond_cross, diamond_dot, dot, hex, hex_dot, inverted_triangle, plus, square, square_cross, square_dot, square_pin, square_x, star, star_dot, triangle, triangle_dot, triangle_pin, x, or y. This collection is available in :class:`~bokeh.core.enums.MarkerType`.

Bokeh's built-in markers consist of a set of base markers, most of which can be combined with different kinds of additional visual features:

You can select marker types in two ways:

  • To draw the same marker for all values, use the marker attribute to specify the name of a specific marker. For example:

    glyph = Scatter(x="x", y="y", size="sizes", marker="square")
    plot.add_glyph(source, glyph)

    This will render square markers for all points.

  • Alternatively, to use marker types specified in a data source column, assign the column name to the marker attribute. For example:

    # source.data['markers'] = ["circle", "square", "circle", ... ]
    
    glyph = Scatter(x="x", y="y", size="sizes", marker="markers")
    plot.add_glyph(source, glyph)
Note

When you draw circle markers with Scatter, you can only assign a size in screen units (by passing a number of pixels to the size property). In case you want to define the radius of circles in data units, use the :class:`~bokeh.models.glyphs.Circle` glyph instead of the Scatter glyph.

Note

Scatter markers with multiple marker types may be drawn in a different order when using the WebGL output backend. This is an explicit trade-off made in the interests of performance.

Properties

  • Scatter: marker.

  • Marker: angle, angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, hit_dilation, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, size, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SegmentConstant

Render segments.

Properties

  • Segment: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, x0, x1, y0, y1.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StepConstant

Render step lines.

Step levels can be draw before, after, or centered on each point, according to the value of the mode property.

The x-coordinates are assumed to be (and must be) sorted in ascending order for steps to be properly rendered.

Properties

  • Step: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, mode, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextConstant

Render text.

Properties

  • Text: angle, angle_units, text, text_align, text_alpha, text_baseline, text_color, text_font, text_font_size, text_font_style, text_line_height, x, x_offset, y, y_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextGlyphConstant

Glyphs with text properties

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.VAreaConstant

Render a vertically directed area between two equal length sequences of y-coordinates with the same x-coordinates.

Properties

  • VArea: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, x, y1, y2.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.VBarConstant

Render vertical bars, given a center coordinate, width and (top, bottom) coordinates.

Properties

  • VBar: bottom, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, top, width, x.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WedgeConstant

Render wedges.

Properties

  • Wedge: direction, end_angle, end_angle_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, radius, radius_units, start_angle, start_angle_units, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.XYGlyphConstant

Base class of glyphs with x and y coordinate attributes.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Data Sources

Bokeh.AjaxDataSourceConstant

A data source that can populate columns by making Ajax calls to REST endpoints.

The AjaxDataSource can be especially useful if you want to make a standalone document (i.e. not backed by the Bokeh server) that can still dynamically update using an existing REST API.

The response from the REST API should match the .data property of a standard ColumnDataSource, i.e. a JSON dict that maps names to arrays of values:

{
    'x' : [1, 2, 3, ...],
    'y' : [9, 3, 2, ...]
}

Alternatively, if the REST API returns a different format, a CustomJS callback can be provided to convert the REST response into Bokeh format, via the adapter property of this data source.

Initial data can be set by specifying the data property directly. This is necessary when used in conjunction with a FactorRange, even if the columns in data` are empty.

A full example can be seen at :bokeh-tree:`examples/howto/ajax_source.py`

Properties

  • AjaxDataSource: content_type, http_headers, if_modified, method, polling_interval.

  • WebDataSource: adapter, data_url, max_size, mode.

  • ColumnDataSource: column_names, data.

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColumnDataSourceConstant

Maps names of columns to sequences or arrays.

The ColumnDataSource is a fundamental data structure of Bokeh. Most plots, data tables, etc. will be driven by a ColumnDataSource.

If the ColumnDataSource initializer is called with a single argument that can be any of the following:

  • A Python dict that maps string names to sequences of values, e.g. lists, arrays, etc.

    data = {'x': [1,2,3,4], 'y': np.array([10.0, 20.0, 30.0, 40.0])}
    
    source = ColumnDataSource(data)
Note

ColumnDataSource only creates a shallow copy of data. Use e.g. ColumnDataSource(copy.deepcopy(data)) if initializing from another ColumnDataSource.data object that you want to keep independent.

  • A Pandas DataFrame object

    source = ColumnDataSource(df)

    In this case the CDS will have columns corresponding to the columns of the DataFrame. If the DataFrame columns have multiple levels, they will be flattened using an underscore (e.g. level_0_col_level_1_col). The index of the DataFrame will be flattened to an Index of tuples if it's a MultiIndex, and then reset using reset_index. The result will be a column with the same name if the index was named, or level_0_name_level_1_name if it was a named MultiIndex. If the Index did not have a name or the MultiIndex name could not be flattened/determined, the reset_index function will name the index column index, or level_0 if the name index is not available.

  • A Pandas GroupBy object

    group = df.groupby(('colA', 'ColB'))

    In this case the CDS will have columns corresponding to the result of calling group.describe(). The describe method generates columns for statistical measures such as mean and count for all the non-grouped original columns. The CDS columns are formed by joining original column names with the computed measure. For example, if a DataFrame has columns 'year' and 'mpg'. Then passing df.groupby('year') to a CDS will result in columns such as 'mpg_mean'

    If the GroupBy.describe result has a named index column, then CDS will also have a column with this name. However, if the index name (or any subname of a MultiIndex) is None, then the CDS will have a column generically named index for the index.

    Note this capability to adapt GroupBy objects may only work with Pandas >=0.20.0.

Note

There is an implicit assumption that all the columns in a given ColumnDataSource all have the same length at all times. For this reason, it is usually preferable to update the .data property of a data source "all at once".

Properties

  • ColumnDataSource: column_names, data.

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColumnarDataSourceConstant

A base class for data source types, which can be mapped onto a columnar format.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataSourceConstant

A base class for data source types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GeoJSONDataSourceConstant

Properties

  • GeoJSONDataSource: geojson.

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ServerSentDataSourceConstant

A data source that can populate columns by receiving server sent events endpoints.

Properties

  • WebDataSource: adapter, data_url, max_size, mode.

  • ColumnDataSource: column_names, data.

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WebDataSourceConstant

Base class for web column data sources that can update from data URLs.

Note

This base class is typically not useful to instantiate on its own.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • WebDataSource: adapter, data_url, max_size, mode.

  • ColumnDataSource: column_names, data.

  • ColumnarDataSource: selection_policy.

  • DataSource: selected.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Axes

Bokeh.AxisConstant

A base class that defines common properties for all axis types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalAxisConstant

An axis that displays ticks and labels for categorical ranges.

The CategoricalAxis can handle factor ranges with up to two levels of nesting, including drawing a separator line between top-level groups of factors.

Properties

  • CategoricalAxis: group_label_orientation, group_text_align, group_text_alpha, group_text_baseline, group_text_color, group_text_font, group_text_font_size, group_text_font_style, group_text_line_height, separator_line_alpha, separator_line_cap, separator_line_color, separator_line_dash, separator_line_dash_offset, separator_line_join, separator_line_width, subgroup_label_orientation, subgroup_text_align, subgroup_text_alpha, subgroup_text_baseline, subgroup_text_color, subgroup_text_font, subgroup_text_font_size, subgroup_text_font_style, subgroup_text_line_height.

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ContinuousAxisConstant

A base class for all numeric, non-categorical axes types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DatetimeAxisConstant

A LinearAxis that picks nice numbers for tick locations on a datetime scale. Configured with a DatetimeTickFormatter by default.

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LinearAxisConstant

An axis that picks nice numbers for tick locations on a linear scale. Configured with a BasicTickFormatter by default.

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LogAxisConstant

An axis that picks nice numbers for tick locations on a log scale. Configured with a LogTickFormatter by default.

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MercatorAxisConstant

An axis that picks nice numbers for tick locations on a Mercator scale. Configured with a MercatorTickFormatter by default.

  • Args::

    • dimension ('lat' or 'lon', optional) :: Whether this axis will display latitude or longitude values. (default: 'lat')

Properties

  • Axis: axis_label, axis_label_standoff, axis_label_text_align, axis_label_text_alpha, axis_label_text_baseline, axis_label_text_color, axis_label_text_font, axis_label_text_font_size, axis_label_text_font_style, axis_label_text_line_height, axis_line_alpha, axis_line_cap, axis_line_color, axis_line_dash, axis_line_dash_offset, axis_line_join, axis_line_width, bounds, fixed_location, formatter, major_label_orientation, major_label_overrides, major_label_policy, major_label_standoff, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Ranges

Bokeh.DataRangeConstant

A base class for all data range types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • DataRange: names, renderers.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataRange1dConstant

An auto-fitting range in a continuous scalar dimension.

By default the start and end of the range automatically assume min and max values of the data for associated renderers.

Properties

  • DataRange1d: bounds, default_span, end, flipped, follow, follow_interval, max_interval, min_interval, only_visible, range_padding, range_padding_units, start.

  • DataRange: names, renderers.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FactorRangeConstant

A Range of values for a categorical dimension.

In addition to supplying factors as a keyword argument to the FactorRange initializer, you may also instantiate with a sequence of positional arguments:

FactorRange("foo", "bar") # equivalent to FactorRange(factors=["foo", "bar"])

Users will normally supply categorical values directly:

p.circle(x=["foo", "bar"], ...)

BokehJS will create a mapping from "foo" and "bar" to a numerical coordinate system called synthetic coordinates. In the simplest cases, factors are separated by a distance of 1.0 in synthetic coordinates, however the exact mapping from factors to synthetic coordinates is affected by he padding properties as well as whether the number of levels the factors have.

Users typically do not need to worry about the details of this mapping, however it can be useful to fine tune positions by adding offsets. When supplying factors as coordinates or values, it is possible to add an offset in the synthetic coordinate space by adding a final number value to a factor tuple. For example:

p.circle(x=[("foo", 0.3), ...], ...)

will position the first circle at an x position that is offset by adding 0.3 to the synthetic coordinate for "foo".

Properties

  • FactorRange: bounds, end, factor_padding, factors, group_padding, max_interval, min_interval, range_padding, range_padding_units, start, subgroup_padding.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RangeConstant

A base class for all range types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.Range1dConstant

A fixed, closed range [start, end] in a continuous scalar dimension.

In addition to supplying start and end keyword arguments to the Range1d initializer, you can also instantiate with the convenience syntax:

Range(0, 10) # equivalent to Range(start=0, end=10)

Properties

  • Range1d: bounds, end, max_interval, min_interval, reset_end, reset_start, start.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Annotations

Bokeh.AnnotationConstant

Base class for all annotation models.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ArrowConstant

Render arrows as an annotation.

See :ref:`userguide_annotations_arrows` for information on plotting arrows.

Properties

  • Arrow: end, end_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, start, start_units, x_end, x_start, y_end, y_start.

  • DataAnnotation: source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BandConstant

Render a filled area band along a dimension.

See :ref:`userguide_annotations_bands` for information on plotting bands.

Properties

  • Band: base, base_units, dimension, fill_alpha, fill_color, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, lower, lower_units, upper, upper_units.

  • DataAnnotation: source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BoxAnnotationConstant

Render a shaded rectangular region as an annotation.

See :ref:`userguide_annotations_box_annotations` for information on plotting box annotations.

Properties

  • BoxAnnotation: bottom, bottom_units, fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, left, left_units, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, render_mode, right, right_units, top, top_units.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColorBarConstant

Render a color bar based on a color mapper.

See :ref:`userguide_annotations_color_bars` for information on plotting color bars.

Properties

  • ColorBar: background_fill_alpha, background_fill_color, bar_line_alpha, bar_line_cap, bar_line_color, bar_line_dash, bar_line_dash_offset, bar_line_join, bar_line_width, border_line_alpha, border_line_cap, border_line_color, border_line_dash, border_line_dash_offset, border_line_join, border_line_width, color_mapper, formatter, height, label_standoff, location, major_label_overrides, major_label_policy, major_label_text_align, major_label_text_alpha, major_label_text_baseline, major_label_text_color, major_label_text_font, major_label_text_font_size, major_label_text_font_style, major_label_text_line_height, major_tick_in, major_tick_line_alpha, major_tick_line_cap, major_tick_line_color, major_tick_line_dash, major_tick_line_dash_offset, major_tick_line_join, major_tick_line_width, major_tick_out, margin, minor_tick_in, minor_tick_line_alpha, minor_tick_line_cap, minor_tick_line_color, minor_tick_line_dash, minor_tick_line_dash_offset, minor_tick_line_join, minor_tick_line_width, minor_tick_out, orientation, padding, scale_alpha, ticker, title, title_standoff, title_text_align, title_text_alpha, title_text_baseline, title_text_color, title_text_font, title_text_font_size, title_text_font_style, title_text_line_height, width.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataAnnotationConstant

Base class for annotations that utilize a data source.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • DataAnnotation: source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LabelConstant

Render a single text label as an annotation.

Label will render a single text label at given x and y coordinates, which can be in either screen (pixel) space, or data (axis range) space.

The label can also be configured with a screen space offset from x and y, by using the x_offset and y_offset properties.

Additionally, the label can be rotated with the angle property.

There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border.

See :ref:`userguide_annotations_labels` for information on plotting labels.

Properties

  • Label: angle, angle_units, background_fill_alpha, background_fill_color, border_line_alpha, border_line_cap, border_line_color, border_line_dash, border_line_dash_offset, border_line_join, border_line_width, text, text_align, text_alpha, text_baseline, text_color, text_font, text_font_size, text_font_style, text_line_height, x, x_offset, x_units, y, y_offset, y_units.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LabelSetConstant

Render multiple text labels as annotations.

LabelSet will render multiple text labels at given x and y coordinates, which can be in either screen (pixel) space, or data (axis range) space. In this case (as opposed to the single Label model), x and y can also be the name of a column from a :class:`~bokeh.models.sources.ColumnDataSource`, in which case the labels will be "vectorized" using coordinate values from the specified columns.

The label can also be configured with a screen space offset from x and y, by using the x_offset and y_offset properties. These offsets may be vectorized by giving the name of a data source column.

Additionally, the label can be rotated with the angle property (which may also be a column name.)

There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border.

The data source is provided by setting the source property.

Properties

  • LabelSet: angle, angle_units, background_fill_alpha, background_fill_color, border_line_alpha, border_line_cap, border_line_color, border_line_dash, border_line_dash_offset, border_line_join, border_line_width, render_mode, text, text_align, text_alpha, text_baseline, text_color, text_font, text_font_size, text_font_style, text_line_height, x, x_offset, x_units, y, y_offset, y_units.

  • DataAnnotation: source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LegendConstant

Render informational legends for a plot.

See :ref:`userguide_annotations_legends` for information on plotting legends.

Properties

  • Legend: background_fill_alpha, background_fill_color, border_line_alpha, border_line_cap, border_line_color, border_line_dash, border_line_dash_offset, border_line_join, border_line_width, click_policy, glyph_height, glyph_width, inactive_fill_alpha, inactive_fill_color, items, label_height, label_standoff, label_text_align, label_text_alpha, label_text_baseline, label_text_color, label_text_font, label_text_font_size, label_text_font_style, label_text_line_height, label_width, location, margin, orientation, padding, spacing, title, title_standoff, title_text_align, title_text_alpha, title_text_baseline, title_text_color, title_text_font, title_text_font_size, title_text_font_style, title_text_line_height.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolyAnnotationConstant

Render a shaded polygonal region as an annotation.

See :ref:`userguide_annotations_polygon_annotations` for information on plotting polygon annotations.

Properties

  • PolyAnnotation: fill_alpha, fill_color, hatch_alpha, hatch_color, hatch_extra, hatch_pattern, hatch_scale, hatch_weight, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, xs, xs_units, ys, ys_units.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SlopeConstant

Render a sloped line as an annotation.

See :ref:`userguide_annotations_slope` for information on plotting slopes.

Properties

  • Slope: gradient, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, y_intercept.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SpanConstant

Render a horizontal or vertical line span.

See :ref:`userguide_annotations_spans` for information on plotting spans.

Properties

  • Span: dimension, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, location, location_units, render_mode.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextAnnotationConstant

Base class for text annotation models such as labels and titles.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TitleConstant

Render a single title box as an annotation.

See :ref:`userguide_annotations_titles` for information on plotting titles.

Properties

  • Title: align, background_fill_alpha, background_fill_color, border_line_alpha, border_line_cap, border_line_color, border_line_dash, border_line_dash_offset, border_line_join, border_line_width, offset, standoff, text, text_alpha, text_color, text_font, text_font_size, text_font_style, text_line_height, vertical_align.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToolbarPanelConstant

Properties

  • ToolbarPanel: toolbar.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TooltipConstant

Render a tooltip.

Note

This model is currently managed by BokehJS and is not useful directly from python.

Properties

  • Tooltip: attachment, inner_only, show_arrow.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WhiskerConstant

Render a whisker along a dimension.

See :ref:`userguide_annotations_whiskers` for information on plotting whiskers.

Properties

  • Whisker: base, base_units, dimension, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width, lower, lower_head, lower_units, upper, upper_head, upper_units.

  • DataAnnotation: source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Other Renderers

Bokeh.DataRendererConstant

An abstract base class for data renderer types (e.g. GlyphRenderer, GraphRenderer).

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GlyphRendererConstant

Properties

  • GlyphRenderer: data_source, glyph, hover_glyph, muted, muted_glyph, nonselection_glyph, selection_glyph, view.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GraphRendererConstant

Properties

  • GraphRenderer: edge_renderer, inspection_policy, layout_provider, node_renderer, selection_policy.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GridConstant

Display horizontal or vertical grid lines at locations given by a supplied Ticker.

Properties

  • Grid: axis, band_fill_alpha, band_fill_color, band_hatch_alpha, band_hatch_color, band_hatch_extra, band_hatch_pattern, band_hatch_scale, band_hatch_weight, bounds, dimension, grid_line_alpha, grid_line_cap, grid_line_color, grid_line_dash, grid_line_dash_offset, grid_line_join, grid_line_width, minor_grid_line_alpha, minor_grid_line_cap, minor_grid_line_color, minor_grid_line_dash, minor_grid_line_dash_offset, minor_grid_line_join, minor_grid_line_width, ticker.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GuideRendererConstant

A base class for all guide renderer types. GuideRenderer is not generally useful to instantiate on its own.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RendererConstant

An abstract base class for renderer types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TileRendererConstant

Properties

  • TileRenderer: alpha, render_parents, smoothing, tile_source.

  • Renderer: coordinates, group, level, visible, x_range_name, y_range_name.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Tools

Bokeh.ActionToolConstant

A base class for tools that are buttons in the toolbar.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BoxEditToolConstant

toolbar icon: box_edit_icon

Allows drawing, dragging and deleting Rect glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. When drawing a new box the data will always be added to the ColumnDataSource on the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x, y, width and height values of the glyph. Any additional columns in the data source will be padded with empty_value, when adding a new box.

The supported actions include:

  • Add box: Hold shift then click and drag anywhere on the plot or double tap once to start drawing, move the mouse and double tap again to finish drawing.

  • Move box: Click and drag an existing box, the box will be dropped once you let go of the mouse button.

  • Delete box: Tap a box to select it then press <<backspace>> key while the mouse is within the plot area.

To Move or Delete multiple boxes at once:

  • Move selection: Select box(es) with <<shift>>+tap (or another selection tool) then drag anywhere on the plot. Selecting and then dragging on a specific box will move both.

  • Delete selection: Select box(es) with <<shift>>+tap (or another selection tool) then press <<backspace>> while the mouse is within the plot area.

Properties

  • BoxEditTool: dimensions, num_objects.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BoxSelectToolConstant

toolbar icon: box_select_icon

The box selection tool allows users to make selections on a Plot by showing a rectangular region by dragging the mouse or a finger over the plot area. The end of the drag event indicates the selection region is ready.

See :ref:`userguide_styling_selected_unselected_glyphs` for information on styling selected and unselected glyphs.

Properties

  • BoxSelectTool: dimensions, origin, overlay, select_every_mousemove.

  • SelectTool: mode, names, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BoxZoomToolConstant

toolbar icon: box_zoom_icon

The box zoom tool allows users to define a rectangular egion of a Plot to zoom to by dragging he mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

Note

BoxZoomTool is incompatible with GMapPlot due to the manner in which Google Maps exert explicit control over aspect ratios. Adding this tool to a GMapPlot will have no effect.

Properties

  • BoxZoomTool: dimensions, match_aspect, origin, overlay.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CrosshairToolConstant

toolbar icon: crosshair_icon

The crosshair tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector's menu associated with the toolbar icon shown above.

The crosshair tool draws a crosshair annotation over the plot, centered on the current mouse position. The crosshair tool may be configured to draw across only one dimension by setting the dimension property to only width or height.

Properties

  • CrosshairTool: dimensions, line_alpha, line_color, line_width.

  • InspectTool: toggleable.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomActionConstant

Execute a custom action, e.g. CustomJS callback when a toolbar icon is activated.

Example:

tool = CustomAction(icon="icon.png",
                    callback=CustomJS(code='alert("foo")'))

plot.add_tools(tool)

Properties

  • CustomAction: callback, icon.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DragConstant

A base class for tools that respond to drag events.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EditToolConstant

A base class for all interactive draw tool types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FreehandDrawToolConstant

toolbar icon: freehand_draw_icon

Allows freehand drawing of Patches and MultiLine glyphs. The glyph to draw may be defined via the renderers property.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

The supported actions include:

  • Draw vertices: Click and drag to draw a line

  • Delete patch/multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.

Properties

  • FreehandDrawTool: num_objects.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GestureToolConstant

A base class for tools that respond to drag events.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HelpToolConstant

A button tool to provide a "help" link to users.

The hover text can be customized through the help_tooltip attribute and the redirect site overridden as well.

Properties

  • HelpTool: redirect.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HoverToolConstant

toolbar icon: hover_icon

The hover tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector's menu associated with the toolbar icon shown above.

By default, the hover tool displays informational tooltips whenever the cursor is directly over a glyph. The data to show comes from the glyph's data source, and what to display is configurable with the tooltips property that maps display names to columns in the data source, or to special known variables.

Here is an example of how to configure and use the hover tool:

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("fill color", "$color[hex]:fill_color"),
    ("fill color", "$color:fill_color"),
    ("fill color", "$swatch:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
    ("baz", "@baz{safe}"),
    ("total", "@total{$0,0.00}"
]

You can also supply a Callback to the HoverTool, to build custom interactions on hover. In this case you may want to turn the tooltips off by setting tooltips=None.

Warning

When supplying a callback or custom template, the explicit intent of this Bokeh Model is to embed raw HTML and JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Hover tool does not currently work with the following glyphs:

Properties

  • HoverTool: anchor, attachment, callback, formatters, line_policy, mode, muted_policy, names, point_policy, renderers, show_arrow, tooltips.

  • InspectTool: toggleable.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.InspectToolConstant

A base class for tools that perform "inspections", e.g. HoverTool.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • InspectTool: toggleable.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LassoSelectToolConstant

toolbar icon: lasso_select_icon

The lasso selection tool allows users to make selections on a Plot by indicating a free-drawn "lasso" region by dragging the mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

See :ref:`userguide_styling_selected_unselected_glyphs` for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

Properties

  • LassoSelectTool: overlay, select_every_mousemove.

  • SelectTool: mode, names, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LineEditToolConstant

toolbar icon: line_edit_icon

The LineEditTool allows editing the intersection points of one or more Line glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the intersections is set via the intersection_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the declared``empty_value``, when adding a new point.

The supported actions include:

  • Show intersections: Double tap an existing line

  • Move point: Drag an existing point and let go of the mouse button to release it.

Properties

  • LineEditTool: dimensions, intersection_renderer.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PanToolConstant

toolbar icon: pan_icon

The pan tool allows the user to pan a Plot by left-dragging a mouse, or on touch devices by dragging a finger or stylus, across the plot region.

The pan tool also activates the border regions of a Plot for "single axis" panning. For instance, dragging in the vertical border or axis will effect a pan in the vertical direction only, with horizontal dimension kept fixed.

Properties

  • PanTool: dimensions.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PointDrawToolConstant

toolbar icon: point_draw_icon

The PointDrawTool allows adding, dragging and deleting point-like glyphs (i.e subclasses of``XYGlyph``) on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. Any newly added points will be inserted on the ColumnDataSource of the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the given empty_value when adding a new point.

Note

The data source updates will trigger data change events continuously throughout the edit operations on the BokehJS side. In Bokeh server apps, the data source will only be synced once, when the edit operation finishes.

The supported actions include:

  • Add point: Tap anywhere on the plot

  • Move point: Tap and drag an existing point, the point will be dropped once you let go of the mouse button.

  • Delete point: Tap a point to select it then press <<backspace>> key while the mouse is within the plot area.

Properties

  • PointDrawTool: add, drag, num_objects.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolyDrawToolConstant

toolbar icon: poly_draw_icon

The PolyDrawTool allows drawing, selecting and deleting Patches and MultiLine glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

If a vertex_renderer with an point-like glyph is supplied then the PolyDrawTool will use it to display the vertices of the multi-lines or patches on all supplied renderers. This also enables the ability to snap to existing vertices while drawing.

The supported actions include:

  • Add patch or multi-line: Double tap to add the first vertex, then use tap to add each subsequent vertex, to finalize the draw action double tap to insert the final vertex or press the <<esc> key.

  • Move patch or ulti-line: Tap and drag an existing patch/multi-line, the point will be dropped once you let go of the mouse button.

  • Delete patch or multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.

Properties

  • PolyDrawTool: drag, num_objects.

  • PolyTool: vertex_renderer.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolyEditToolConstant

toolbar icon: poly_edit_icon

The PolyEditTool allows editing the vertices of one or more Patches or MultiLine glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the vertices is set via the vertex_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared``empty_value``, when adding a new point.

The supported actions include:

  • Show vertices: Double tap an existing patch or multi-line

  • Add vertex: Double tap an existing vertex to select it, the tool will draw the next point, to add it tap in a new location. To finish editing and add a point double tap otherwise press the <<esc> key to cancel.

  • Move vertex: Drag an existing vertex and let go of the mouse button to release it.

  • Delete vertex: After selecting one or more vertices press <<backspace>> while the mouse cursor is within the plot area.

Properties

  • PolyTool: vertex_renderer.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolySelectToolConstant

toolbar icon: poly_select_icon

The polygon selection tool allows users to make selections on a Plot by indicating a polygonal region with mouse clicks. single clicks (or taps) add successive points to the definition of the polygon, and a double click (or tap) indicates the selection region is ready.

See :ref:`userguide_styling_selected_unselected_glyphs` for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

Properties

  • PolySelectTool: overlay.

  • SelectTool: mode, names, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolyToolConstant

A base class for polygon draw/edit tools. .. note:

This is an abstract base class used to help organize the hierarchy of Bokeh
model types. **It is not useful to instantiate on its own.**

Properties

  • PolyTool: vertex_renderer.

  • EditTool: custom_icon, empty_value, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RangeToolConstant

toolbar icon: range_icon

The range tool allows the user to update range objects for either or both of the x- or y-dimensions by dragging a corresponding shaded annotation to move it or change its boundaries.

A common use case is to add this tool to a plot with a large fixed range, but to configure the tool range from a different plot. When the user manipulates the overlay, the range of the second plot will be updated automatically.

Properties

  • RangeTool: overlay, x_interaction, x_range, y_interaction, y_range.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RedoToolConstant

toolbar icon: redo_icon

Redo tool reverses the last action performed by undo tool.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ResetToolConstant

toolbar icon: reset_icon

The reset tool is an action. When activated in the toolbar, the tool resets the data bounds of the plot to their values when the plot was initially created.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SaveToolConstant

toolbar icon: save_icon

The save tool is an action. When activated, the tool opens a download dialog which allows to save an image reproduction of the plot in PNG format. If automatic download is not support by a web browser, the tool falls back to opening the generated image in a new tab or window. User then can manually save it by right clicking on the image and choosing "Save As" (or similar) menu item.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScrollConstant

A base class for tools that respond to scroll events.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SelectToolConstant

A base class for tools that perform "selections", e.g. BoxSelectTool.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • SelectTool: mode, names, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TapConstant

A base class for tools that respond to tap/click events.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TapToolConstant

toolbar icon: tap_icon

The tap selection tool allows the user to select at single points by left-clicking a mouse, or tapping with a finger.

See :ref:`userguide_styling_selected_unselected_glyphs` for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

Properties

  • TapTool: behavior, callback, gesture.

  • SelectTool: mode, names, renderers.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToolConstant

A base class for all interactive tool types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.UndoToolConstant

toolbar icon: undo_icon

Undo tool allows to restore previous state of the plot.

Properties

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WheelPanToolConstant

toolbar icon: wheel_pan_icon

The wheel pan tool allows the user to pan the plot along the configured dimension using the scroll wheel.

Properties

  • WheelPanTool: dimension.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WheelZoomToolConstant

toolbar icon: wheel_zoom_icon

The wheel zoom tool will zoom the plot in and out, centered on the current mouse location.

The wheel zoom tool also activates the border regions of a Plot for "single axis" zooming. For instance, zooming in the vertical border or axis will effect a zoom in the vertical direction only, with the horizontal dimension kept fixed.

Properties

  • WheelZoomTool: dimensions, maintain_focus, speed, zoom_on_axis.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ZoomInToolConstant

toolbar icon: zoom_in_icon

The zoom-in tool allows users to click a button to zoom in by a fixed amount.

Properties

  • ZoomInTool: dimensions, factor.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ZoomOutToolConstant

toolbar icon: zoom_out_icon

The zoom-out tool allows users to click a button to zoom out by a fixed amount.

Properties

  • ZoomOutTool: dimensions, factor, maintain_focus.

  • Tool: description.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Transforms

Bokeh.CategoricalColorMapperConstant

Map categorical factors to colors.

Values that are passed to this mapper that are not in the factors list will be mapped to nan_color.

Properties

  • CategoricalMapper: end, factors, start.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalMapperConstant

Base class for mappers that map categorical factors to other values.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • CategoricalMapper: end, factors, start.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalMarkerMapperConstant

Map categorical factors to marker types.

Values that are passed to this mapper that are not in the factors list will be mapped to default_value.

Note

This mappers is primarily only useful with the Scatter marker glyph that be parameterized by marker type.

Properties

  • CategoricalMarkerMapper: default_value, markers.

  • CategoricalMapper: end, factors, start.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalPatternMapperConstant

Map categorical factors to hatch fill patterns.

Values that are passed to this mapper that are not in the factors list will be mapped to default_value.

Added in version 1.1.1

Properties

  • CategoricalPatternMapper: default_value, patterns.

  • CategoricalMapper: end, factors, start.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalScaleConstant

Represent a scale transformation between a categorical source range and continuous target range.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColorMapperConstant

Base class for color mapper types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ContinuousColorMapperConstant

Base class for continuous color mapper types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ContinuousColorMapper: domain, high, high_color, low, low_color.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ContinuousScaleConstant

Represent a scale transformation between continuous ranges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomJSTransformConstant

Apply a custom defined transform to data.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • CustomJSTransform: args, func, v_func.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DodgeConstant

Apply either fixed dodge amount to data.

Properties

  • Dodge: range, value.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EqHistColorMapperConstant

Properties

  • EqHistColorMapper: bins, rescale_discrete_levels.

  • ContinuousColorMapper: domain, high, high_color, low, low_color.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.InterpolatorConstant

Base class for interpolator transforms.

Interpolators return the value of a function which has been evaluated between specified (x, y) pairs of data. As an example, if two control point pairs were provided to the interpolator, a linear interpolaction at a specific value of 'x' would result in the value of 'y' which existed on the line connecting the two control points.

The control point pairs for the interpolators can be specified through either

  • A literal sequence of values:

interp = Interpolator(x=[1, 2, 3, 4, 5], y=[2, 5, 10, 12, 16])
  • or a pair of columns defined in a ColumnDataSource object:

interp = Interpolator(x="year", y="earnings", data=jewlery_prices))

This is the base class and is not intended to end use. Please see the documentation for the final derived classes (Jitter, LineraInterpolator, StepInterpolator) for more information on their specific methods of interpolation.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Interpolator: clip, data, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.JitterConstant

Apply either a uniform or normally sampled random jitter to data.

Properties

  • Jitter: distribution, mean, range, width.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LinearColorMapperConstant

Map numbers in a range [low, high] linearly into a sequence of colors (a palette).

For example, if the range is [0, 99] and the palette is ['red', 'green', 'blue'], the values would be mapped as follows:

      x < 0  : 'red'     # values < low are clamped
 0 <= x < 33 : 'red'
33 <= x < 66 : 'green'
66 <= x < 99 : 'blue'
99 <= x      : 'blue'    # values > high are clamped

Properties

  • ContinuousColorMapper: domain, high, high_color, low, low_color.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LinearInterpolatorConstant

Compute a linear interpolation between the control points provided through the x, y, and data parameters.

Properties

  • Interpolator: clip, data, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LinearScaleConstant

Represent a linear scale transformation between continuous ranges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LogColorMapperConstant

Map numbers in a range [low, high] into a sequence of colors (a palette) on a natural logarithm scale.

For example, if the range is [0, 25] and the palette is ['red', 'green', 'blue'], the values would be mapped as follows:

         x < 0     : 'red'     # values < low are clamped
0     <= x < 2.72  : 'red'     # math.e ** 1
2.72  <= x < 7.39  : 'green'   # math.e ** 2
7.39  <= x < 20.09 : 'blue'    # math.e ** 3
20.09 <= x         : 'blue'    # values > high are clamped
Warning

The LogColorMapper only works for images with scalar values that are non-negative.

Properties

  • ContinuousColorMapper: domain, high, high_color, low, low_color.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LogScaleConstant

Represent a log scale transformation between continuous ranges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MapperConstant

Base class for mappers.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScaleConstant

Base class for Scale models that represent an invertible computation to be carried out on the client-side.

JavaScript implementations should implement the following methods:

Note

code-block compute(x: number): number { # compute and return the transform of a single value } v_compute(xs: Arrayable<number>): Arrayable<number> { # compute and return the transform of an array of values } invert(sx: number): number { # compute and return the inverse transform of a single value } v_invert(sxs: Arrayable<number>): Arrayable<number> { # compute and return the inverse transform of an array of values }

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScanningColorMapperConstant

Properties

  • ContinuousColorMapper: domain, high, high_color, low, low_color.

  • ColorMapper: nan_color, palette.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StepInterpolatorConstant

Compute a step-wise interpolation between the points provided through the x, y, and data parameters.

Properties

  • StepInterpolator: mode.

  • Interpolator: clip, data, x, y.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TransformConstant

Base class for Transform models that represent a computation to be carried out on the client-side.

JavaScript implementations should implement the following methods:

Note

code-block compute(x: number): number { # compute and return the transform of a single value } v_compute(xs: Arrayable<number>): Arrayable<number> { # compute and return the transform of an array of values }

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Filters

Bokeh.BooleanFilterConstant

A BooleanFilter filters data by returning the subset of data corresponding to indices where the values of the booleans array is True.

Properties

  • BooleanFilter: booleans.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomJSFilterConstant

Filter data sources with a custom defined JavaScript function.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • CustomJSFilter: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FilterConstant

A Filter model represents a filtering operation that returns a row-wise subset of data when applied to a ColumnDataSource.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GroupFilterConstant

A GroupFilter represents the rows of a ColumnDataSource where the values of the categorical column column_name match the group variable.

Properties

  • GroupFilter: column_name, group.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.IndexFilterConstant

An IndexFilter filters data by returning the subset of data at a given set of indices.

Properties

  • IndexFilter: indices.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Widgets

Bokeh.AbstractButtonConstant

A base class that defines common properties for all button types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • AbstractButton: button_type, icon, label.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.AbstractGroupConstant

Abstract base class for all kinds of groups.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.AbstractSliderConstant
Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.AutocompleteInputConstant

Single-line input widget with auto-completion.

Properties

  • AutocompleteInput: case_sensitive, completions, min_characters, restrict.

  • TextLikeInput: max_length, placeholder, value, value_input.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ButtonConstant

A click button.

Properties

  • AbstractButton: button_type, icon, label.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ButtonGroupConstant

Abstract base class for groups with items rendered as buttons.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ButtonGroup: button_type, orientation.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CheckboxButtonGroupConstant

A group of check boxes rendered as toggle buttons.

Properties

  • CheckboxButtonGroup: active.

  • ButtonGroup: button_type, orientation.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CheckboxGroupConstant

A group of check boxes.

Properties

  • CheckboxGroup: active.

  • Group: inline.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColorPickerConstant

Color picker widget

Warning

This widget as a limited support on Internet Explorer (it will be displayed as a simple text input).

Properties

  • ColorPicker: color.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataCubeConstant

Specialized DataTable with collapsing groups, totals, and sub-totals.

Properties

  • DataCube: grouping, target.

  • DataTable: auto_edit, autosize_mode, columns, editable, fit_columns, frozen_columns, frozen_rows, header_row, index_header, index_position, index_width, reorderable, row_height, scroll_to_selection, selectable, sortable.

  • TableWidget: source, view.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataTableConstant

Two-dimensional grid for visualization and editing large amounts of data.

Properties

  • DataTable: auto_edit, autosize_mode, columns, editable, fit_columns, frozen_columns, frozen_rows, header_row, index_header, index_position, index_width, reorderable, row_height, scroll_to_selection, selectable, sortable.

  • TableWidget: source, view.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DatePickerConstant

Calendar-based date picker widget.

Properties

  • DatePicker: disabled_dates, enabled_dates, inline, max_date, min_date, position, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DateRangeSliderConstant

Slider-based date range selection widget.

Properties

  • DateRangeSlider: end, start, step, value, value_throttled.

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DateSliderConstant

Slider-based date selection widget.

Properties

  • DateSlider: end, start, step, value, value_throttled.

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DatetimeRangeSliderConstant

Slider-based datetime range selection widget.

Properties

  • DatetimeRangeSlider: end, start, step, value, value_throttled.

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DivConstant

A block (div) of text.

This Bokeh model corresponds to an HTML <div> element.

Properties

  • Div: render_as_text.

  • Markup: disable_math, style, text.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DropdownConstant

A dropdown button.

Properties

  • Dropdown: menu, split.

  • AbstractButton: button_type, icon, label.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FileInputConstant

Present a file-chooser dialog to users and return the contents of the selected files.

Properties

  • FileInput: accept, filename, mime_type, multiple, value.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GroupConstant

Abstract base class for groups with items rendered as check/radio boxes.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Group: inline.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.InputWidgetConstant

Abstract base class for input widgets.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MarkupConstant

Base class for Bokeh models that represent HTML markup elements.

Markups include e.g., <div>, <p>, and <pre>.

Content can be interpreted as TeX and LaTeX input when rendering as HTML. TeX/LaTeX processing can be disabled by setting disable_math to True.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Markup: disable_math, style, text.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MultiChoiceConstant

MultiChoice widget.

Properties

  • MultiChoice: delete_button, max_items, option_limit, options, placeholder, search_option_limit, solid, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MultiSelectConstant

Multi-select widget.

Properties

  • MultiSelect: options, size, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NumericInputConstant

Numeric input widget.

Properties

  • NumericInput: format, high, low, mode, placeholder, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ParagraphConstant

A block (paragraph) of text.

This Bokeh model corresponds to an HTML <p> element.

Properties

  • Markup: disable_math, style, text.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PasswordInputConstant

Single-line password input widget.

This widget hides the input value so that it is not visible in the browser.

Warning

Secure transmission of the password to Bokeh server application code requires configuring the server for SSL (i.e. HTTPS) termination.

Properties

  • TextLikeInput: max_length, placeholder, value, value_input.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PreTextConstant

A block (paragraph) of pre-formatted text.

This Bokeh model corresponds to an HTML <pre> element.

Properties

  • Markup: disable_math, style, text.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RadioButtonGroupConstant

A group of radio boxes rendered as toggle buttons.

Properties

  • RadioButtonGroup: active.

  • ButtonGroup: button_type, orientation.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RadioGroupConstant

A group of radio boxes.

Properties

  • RadioGroup: active.

  • Group: inline.

  • AbstractGroup: labels.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RangeSliderConstant

Range-slider based number range selection widget.

Properties

  • RangeSlider: end, start, step, value, value_throttled.

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SelectConstant

Single-select widget.

Properties

  • Select: options, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SliderConstant

Slider-based number selection widget.

Properties

  • Slider: end, start, step, value, value_throttled.

  • AbstractSlider: bar_color, direction, format, orientation, show_value, title, tooltips.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SpinnerConstant

Numeric Spinner input widget.

Properties

  • Spinner: page_step_multiplier, step, value_throttled, wheel_wait.

  • NumericInput: format, high, low, mode, placeholder, value.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TableWidgetConstant

Abstract base class for data table (data grid) widgets.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • TableWidget: source, view.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextAreaInputConstant

Multi-line input widget.

Properties

  • TextAreaInput: cols, rows.

  • TextLikeInput: max_length, placeholder, value, value_input.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextInputConstant

Single-line input widget.

Properties

  • TextLikeInput: max_length, placeholder, value, value_input.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextLikeInputConstant

Base class for text-like input widgets.

Properties

  • TextLikeInput: max_length, placeholder, value, value_input.

  • InputWidget: title.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToggleConstant

A two-state toggle button.

Properties

  • Toggle: active.

  • AbstractButton: button_type, icon, label.

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WidgetConstant

A base class for all interactive widget types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Widget: default_size.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Layouts

Bokeh.BoxConstant

Abstract base class for Row and Column. Do not use directly.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Box: children, spacing.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ColumnConstant

Lay out child components in a single vertical row.

Children can be specified as positional arguments, as a single argument that is a sequence, or using the children keyword argument.

Properties

  • Column: rows.

  • Box: children, spacing.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FigureConstant

Create a new Figure for plotting.

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

Figure objects have many glyph methods that can be used to draw vectorized graphical glyphs:

There is a scatter function that can be parameterized by marker type:

  • :func:`~bokeh.plotting.Figure.scatter`

There are also specialized methods for stacking bars:

  • bars: :func:`~bokeh.plotting.Figure.hbar_stack`, :func:`~bokeh.plotting.Figure.vbar_stack`

  • lines: :func:`~bokeh.plotting.Figure.hline_stack`, :func:`~bokeh.plotting.Figure.vline_stack`

  • areas: :func:`~bokeh.plotting.Figure.harea_stack`, :func:`~bokeh.plotting.Figure.varea_stack`

As well as one specialized method for making simple hexbin plots:

  • :func:`~bokeh.plotting.Figure.hexbin`

In addition to all the Figure property attributes, the following options are also accepted:

Properties

  • Plot: above, aspect_scale, axes, axis, background_fill_alpha, background_fill_color, below, border_fill_alpha, border_fill_color, center, extra_x_ranges, extra_x_scales, extra_y_ranges, extra_y_scales, frame_height, frame_width, grid, grids, hidpi, inner_height, inner_width, left, legend, legends, lod_factor, lod_interval, lod_threshold, lod_timeout, match_aspect, min_border, min_border_bottom, min_border_left, min_border_right, min_border_top, outer_height, outer_width, outline_line_alpha, outline_line_cap, outline_line_color, outline_line_dash, outline_line_dash_offset, outline_line_join, outline_line_width, output_backend, ranges, renderers, reset_policy, right, scales, title, title_location, toolbar, toolbar_location, toolbar_sticky, tools, x_axes, x_axis, x_grid, x_grids, x_range, x_scale, y_axes, y_axis, y_grid, y_grids, y_range, y_scale.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GMapConstant

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

  • Args::

    • google_api_key (str):: Google requires an API key be supplied for maps to function. See:

      https://developers.google.com/maps/documentation/javascript/get-api-key

    • map_options: (:class:`~bokeh.models.map_plots.GMapOptions`): Configuration specific to a Google Map

In addition to all the Bokeh model property attributes documented below, the Figure initializer also accepts the following options, which can help simplify configuration:

Properties

  • GMapPlot: api_key, api_version, map_options.

  • Plot: above, aspect_scale, axes, axis, background_fill_alpha, background_fill_color, below, border_fill_alpha, border_fill_color, center, extra_x_ranges, extra_x_scales, extra_y_ranges, extra_y_scales, frame_height, frame_width, grid, grids, hidpi, inner_height, inner_width, left, legend, legends, lod_factor, lod_interval, lod_threshold, lod_timeout, match_aspect, min_border, min_border_bottom, min_border_left, min_border_right, min_border_top, outer_height, outer_width, outline_line_alpha, outline_line_cap, outline_line_color, outline_line_dash, outline_line_dash_offset, outline_line_join, outline_line_width, output_backend, ranges, renderers, reset_policy, right, scales, title, title_location, toolbar, toolbar_location, toolbar_sticky, tools, x_axes, x_axis, x_grid, x_grids, x_range, x_scale, y_axes, y_axis, y_grid, y_grids, y_range, y_scale.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GMapPlotConstant

A Bokeh Plot with a Google Map displayed underneath.

Data placed on this plot should be specified in decimal lat/lon coordinates e.g. (37.123, -122.404). It will be automatically converted into the web mercator projection to display properly over google maps tiles.

The api_key property must be configured with a Google API Key in order for GMapPlot to function. The key will be stored in the Bokeh Document JSON.

Note that Google Maps exert explicit control over aspect ratios at all times, which imposes some limitations on GMapPlot:

  • Only Range1d ranges are supported. Attempting to use other range types will result in an error.

  • Usage of BoxZoomTool is incompatible with GMapPlot. Adding a BoxZoomTool will have no effect.

Properties

  • GMapPlot: api_key, api_version, map_options.

  • Plot: above, aspect_scale, axes, axis, background_fill_alpha, background_fill_color, below, border_fill_alpha, border_fill_color, center, extra_x_ranges, extra_x_scales, extra_y_ranges, extra_y_scales, frame_height, frame_width, grid, grids, hidpi, inner_height, inner_width, left, legend, legends, lod_factor, lod_interval, lod_threshold, lod_timeout, match_aspect, min_border, min_border_bottom, min_border_left, min_border_right, min_border_top, outer_height, outer_width, outline_line_alpha, outline_line_cap, outline_line_color, outline_line_dash, outline_line_dash_offset, outline_line_join, outline_line_width, output_backend, ranges, renderers, reset_policy, right, scales, title, title_location, toolbar, toolbar_location, toolbar_sticky, tools, x_axes, x_axis, x_grid, x_grids, x_range, x_scale, y_axes, y_axis, y_grid, y_grids, y_range, y_scale.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GridBoxConstant

Properties

  • GridBox: children, cols, rows, spacing.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HTMLBoxConstant

A component which size is determined by its HTML content.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LayoutDOMConstant

The base class for layoutable components.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MapPlotConstant

Abstract base class for map plot models.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Plot: above, aspect_scale, axes, axis, background_fill_alpha, background_fill_color, below, border_fill_alpha, border_fill_color, center, extra_x_ranges, extra_x_scales, extra_y_ranges, extra_y_scales, frame_height, frame_width, grid, grids, hidpi, inner_height, inner_width, left, legend, legends, lod_factor, lod_interval, lod_threshold, lod_timeout, match_aspect, min_border, min_border_bottom, min_border_left, min_border_right, min_border_top, outer_height, outer_width, outline_line_alpha, outline_line_cap, outline_line_color, outline_line_dash, outline_line_dash_offset, outline_line_join, outline_line_width, output_backend, ranges, renderers, reset_policy, right, scales, title, title_location, toolbar, toolbar_location, toolbar_sticky, tools, x_axes, x_axis, x_grid, x_grids, x_range, x_scale, y_axes, y_axis, y_grid, y_grids, y_range, y_scale.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PlotConstant

Model representing a plot, containing glyphs, guides, annotations.

Properties

  • Plot: above, aspect_scale, axes, axis, background_fill_alpha, background_fill_color, below, border_fill_alpha, border_fill_color, center, extra_x_ranges, extra_x_scales, extra_y_ranges, extra_y_scales, frame_height, frame_width, grid, grids, hidpi, inner_height, inner_width, left, legend, legends, lod_factor, lod_interval, lod_threshold, lod_timeout, match_aspect, min_border, min_border_bottom, min_border_left, min_border_right, min_border_top, outer_height, outer_width, outline_line_alpha, outline_line_cap, outline_line_color, outline_line_dash, outline_line_dash_offset, outline_line_join, outline_line_width, output_backend, ranges, renderers, reset_policy, right, scales, title, title_location, toolbar, toolbar_location, toolbar_sticky, tools, x_axes, x_axis, x_grid, x_grids, x_range, x_scale, y_axes, y_axis, y_grid, y_grids, y_range, y_scale.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RowConstant

Lay out child components in a single horizontal row.

Children can be specified as positional arguments, as a single argument that is a sequence, or using the children keyword argument.

Properties

  • Row: cols.

  • Box: children, spacing.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SpacerConstant

A container for space used to fill an empty spot in a row or column.

Properties

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TabsConstant

A panel widget with navigation tabs.

Properties

  • Tabs: active, tabs, tabs_location.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToolbarBoxConstant

A layoutable toolbar that can accept the tools of multiple plots, and can merge the tools into a single button for convenience.

Properties

  • ToolbarBox: toolbar, toolbar_location.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WidgetBoxConstant

Create a column of bokeh widgets with predefined styling.

WidgetBox is DEPRECATED and will beremoved in Bokeh 3.0, use 'Column' instead.

Properties

  • Column: rows.

  • Box: children, spacing.

  • LayoutDOM: align, aspect_ratio, background, css_classes, disabled, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, visible, width, width_policy.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Tickers

Bokeh.AdaptiveTickerConstant

Generate "nice" round ticks at any magnitude.

Creates ticks that are "base" multiples of a set of given mantissas. For example, with base=10 and mantissas=[1, 2, 5], the ticker will generate the sequence:

..., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100, ...

Properties

  • AdaptiveTicker: base, mantissas, max_interval, min_interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BasicTickerConstant

Generate ticks on a linear scale.

Note

This class may be renamed to LinearTicker in the future.

Properties

  • AdaptiveTicker: base, mantissas, max_interval, min_interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BinnedTickerConstant

Ticker that aligns ticks exactly at bin boundaries of a scanning color mapper.

Properties

  • BinnedTicker: mapper, num_major_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalTickerConstant

Generate ticks for categorical ranges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CompositeTickerConstant

Combine different tickers at different scales.

Uses the min_interval and max_interval interval attributes of the tickers to select the appropriate ticker at different scales.

Properties

  • CompositeTicker: tickers.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ContinuousTickerConstant

A base class for non-categorical ticker types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DatetimeTickerConstant

Generate nice ticks across different date and time scales.

Properties

  • CompositeTicker: tickers.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DaysTickerConstant

Generate ticks spaced apart by specific, even multiples of days.

Properties

  • DaysTicker: days.

  • SingleIntervalTicker: interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FixedTickerConstant

Generate ticks at fixed, explicitly supplied locations.

Note

The desired_num_ticks property is ignored by this Ticker.

Properties

  • FixedTicker: minor_ticks, ticks.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LogTickerConstant

Generate ticks on a log scale.

Properties

  • AdaptiveTicker: base, mantissas, max_interval, min_interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MercatorTickerConstant

Generate nice lat/lon ticks form underlying WebMercator coordinates.

Properties

  • MercatorTicker: dimension.

  • AdaptiveTicker: base, mantissas, max_interval, min_interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MonthsTickerConstant

Generate ticks spaced apart by specific, even multiples of months.

Properties

  • MonthsTicker: months.

  • SingleIntervalTicker: interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SingleIntervalTickerConstant

Generate evenly spaced ticks at a fixed interval regardless of scale.

Properties

  • SingleIntervalTicker: interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TickerConstant

A base class for all ticker types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.YearsTickerConstant

Generate ticks spaced apart even numbers of years.

Properties

  • SingleIntervalTicker: interval.

  • ContinuousTicker: desired_num_ticks, num_minor_ticks.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Tick Formatters

Bokeh.BasicTickFormatterConstant

Display tick values from continuous ranges as "basic numbers", using scientific notation when appropriate by default.

Properties

  • BasicTickFormatter: power_limit_high, power_limit_low, precision, use_scientific.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CategoricalTickFormatterConstant

Display tick values from categorical ranges as string values.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DatetimeTickFormatterConstant

A TickFormatter for displaying datetime values nicely across a range of scales.

DatetimeTickFormatter has the following properties (listed together with their default values) that can be used to control the formatting of axis ticks at different scales scales:

microseconds = ['%fus']

milliseconds = ['%3Nms', '%S.%3Ns']

seconds = ['%Ss']

minsec = [':%M:%S']

minutes = [':%M', '%Mm']

hourmin = ['%H:%M']

hours = ['%Hh', '%H:%M']

days = ['%m/%d', '%a%d']

months = ['%m/%Y', '%b %Y']

years = ['%Y']

Each scale property can be set to format or list of formats to use for formatting datetime tick values that fall in in that "time scale". By default, only the first format string passed for each time scale will be used. By default, all leading zeros are stripped away from the formatted labels.

This list of supported strftime formats is reproduced below.

  • %a: The abbreviated name of the day of the week according to the current locale.

  • %A: The full name of the day of the week according to the current locale.

  • %b: The abbreviated month name according to the current locale.

  • %B: The full month name according to the current locale.

  • %c: The preferred date and time representation for the current locale.

  • %C: The century number (year/100) as a 2-digit integer.

  • %d: The day of the month as a decimal number (range 01 to 31).

  • %D: Equivalent to %m/%d/%y. (Americans should note that in many other countries %d/%m/%y is rather common. This means that in international context this format is ambiguous and should not be used.)

  • %e: Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.

  • %f: Microsecond as a decimal number, zero-padded on the left (range 000000-999999). This is an extension to the set of directives available to timezone.

  • %F: Equivalent to %Y-%m-%d (the ISO 8601 date format).

  • %G: The ISO 8601 week-based year with century as a decimal number. The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as %Y, except that if the ISO week number belongs to the previous or next year, that year is used instead.

  • %g: Like %G, but without century, that is, with a 2-digit year (00-99).

  • %h: Equivalent to %b.

  • %H: The hour as a decimal number using a 24-hour clock (range 00 to 23).

  • %I: The hour as a decimal number using a 12-hour clock (range 01 to 12).

  • %j: The day of the year as a decimal number (range 001 to 366).

  • %k: The hour (24-hour clock) as a decimal number (range 0 to 23). Single digits are preceded by a blank. (See also %H.)

  • %l: The hour (12-hour clock) as a decimal number (range 1 to 12). Single digits are preceded by a blank. (See also %I.) (TZ)

  • %m: The month as a decimal number (range 01 to 12).

  • %M: The minute as a decimal number (range 00 to 59).

  • %n: A newline character. Bokeh text does not currently support newline characters.

  • %N: Nanosecond as a decimal number, zero-padded on the left (range 000000000-999999999). Supports a padding width specifier, i.e. %3N displays 3 leftmost digits. However, this is only accurate to the millisecond level of precision due to limitations of timezone.

  • %p: Either "AM" or "PM" according to the given time value, or the corresponding strings for the current locale. Noon is treated as "PM" and midnight as "AM".

  • %P: Like %p but in lowercase: "am" or "pm" or a corresponding string for the current locale.

  • %r: The time in a.m. or p.m. notation. In the POSIX locale this is equivalent to %I:%M:%S %p.

  • %R: The time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.

  • %s: The number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).

  • %S: The second as a decimal number (range 00 to 60). (The range is up to 60 to allow for occasional leap seconds.)

  • %t: A tab character. Bokeh text does not currently support tab characters.

  • %T: The time in 24-hour notation (%H:%M:%S).

  • %u: The day of the week as a decimal, range 1 to 7, Monday being 1. See also %w.

  • %U: The week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. See also %V and %W.

  • %V: The ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. See also %U and %W.

  • %w: The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.

  • %W: The week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.

  • %x: The preferred date representation for the current locale without the time.

  • %X: The preferred time representation for the current locale without the date.

  • %y: The year as a decimal number without a century (range 00 to 99).

  • %Y: The year as a decimal number including the century.

  • %z: The +hhmm or -hhmm numeric timezone (that is, the hour and minute offset from UTC).

  • %Z: The timezone name or abbreviation.

  • %%: A literal '%' character.

Warning

The client library BokehJS uses the timezone library to format datetimes. The inclusion of the list below is based on the claim that timezone makes to support "the full compliment of GNU date format specifiers." However, this claim has not been tested exhaustively against this list. If you find formats that do not function as expected, please submit a github issue, so that the documentation can be updated appropriately.

Properties

  • DatetimeTickFormatter: days, hourmin, hours, microseconds, milliseconds, minsec, minutes, months, seconds, years.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.FuncTickFormatterConstant

Display tick values that are formatted by a user-defined function.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • FuncTickFormatter: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LogTickFormatterConstant

Display tick values from continuous ranges as powers of some base.

Most often useful in conjunction with a LogTicker.

Properties

  • LogTickFormatter: min_exponent, ticker.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MercatorTickFormatterConstant

A TickFormatter for values in WebMercator units.

Some map plot types internally use WebMercator to describe coordinates, plot bounds, etc. These units are not very human-friendly. This tick formatter will convert WebMercator units into Latitude and Longitude for display on axes.

Properties

  • MercatorTickFormatter: dimension.

  • BasicTickFormatter: power_limit_high, power_limit_low, precision, use_scientific.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NumeralTickFormatterConstant

Tick formatter based on a human-readable format string.

Properties

  • NumeralTickFormatter: format, language, rounding.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PrintfTickFormatterConstant

Tick formatter based on a printf-style format string.

Properties

  • PrintfTickFormatter: format.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TickFormatterConstant

A base class for all tick formatter types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Labeling Policies

Bokeh.AllLabelsConstant

Select all labels even if they overlap.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomLabelingPolicyConstant

Select labels based on a user-defined policy function.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing it to Bokeh.

Properties

  • CustomLabelingPolicy: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LabelingPolicyConstant

Base class for labeling policies. .. note:

This is an abstract base class used to help organize the hierarchy of Bokeh
model types. **It is not useful to instantiate on its own.**

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NoOverlapConstant

Basic labeling policy avoiding label overlap.

Properties

  • NoOverlap: min_distance.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Math Text

Bokeh.AsciiConstant

Render mathematical content using AsciiMath notation.

Properties

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MathMLConstant

Render mathematical content using MathML notation. See :ref:`userguide_styling_math` in the user guide for more information.

Properties

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MathTextConstant

Base class for renderers of mathematical content.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TeXConstant

Render mathematical content using LaTeX notation. See :ref:`userguide_styling_math` in the user guide for more information.

Note

Bokeh uses MathJax to render text containing mathematical notation.

MathJax only supports math-mode macros (no text-mode macros). You can see more about differences between standard TeX/LaTeX and MathJax here: https://docs.mathjax.org/en/latest/input/tex/differences.html

Properties

  • TeX: inline, macros.

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Expressions

Bokeh.CoordinateTransformConstant

Base class for coordinate transforms. .. note:

This is an abstract base class used to help organize the hierarchy of Bokeh
model types. **It is not useful to instantiate on its own.**

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CumSumConstant

An expression for generating arrays by cumulatively summing a single column from a ColumnDataSource.

Properties

  • CumSum: field, include_zero.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomJSExprConstant

Evaluate a JavaScript function/generator.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • CustomJSExpr: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EdgeCoordinatesConstant

Node coordinate expression obtained from LayoutProvider

Properties

  • GraphCoordinates: layout.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ExpressionConstant

Base class for Expression models that represent a computation to be carried out on the client-side.

JavaScript implementations should implement the following methods:

Note

code-block v_compute(source: ColumnarDataSource): Arrayable { # compute and return array of values }

Note

If you wish for results to be cached per source and updated only if the source changes, implement _v_compute: (source) instead.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GraphCoordinatesConstant

Abstract class for coordinate transform expression obtained from LayoutProvider

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • GraphCoordinates: layout.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NodeCoordinatesConstant

Node coordinate expression obtained from LayoutProvider

Properties

  • GraphCoordinates: layout.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PolarTransformConstant

Transform from polar to cartesian coordinates.

Properties

  • PolarTransform: angle, angle_units, direction, radius.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StackConstant

An expression for generating arrays by summing different columns from a ColumnDataSource.

This expression is useful for implementing stacked bar charts at a low level.

Properties

  • Stack: fields.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.XComponentConstant

X-component of a coordinate system transform to cartesian coordinates.

Properties

  • XYComponent: transform.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.XYComponentConstant

Base class for bi-variate expressions. .. note:

This is an abstract base class used to help organize the hierarchy of Bokeh
model types. **It is not useful to instantiate on its own.**

Properties

  • XYComponent: transform.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.YComponentConstant

Y-component of a coordinate system transform to cartesian coordinates.

Properties

  • XYComponent: transform.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source

Other

Bokeh.AbstractIconConstant

An abstract base class for icon widgets.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ArrowHeadConstant

Base class for arrow heads.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ArrowHead: size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.AvgAggregatorConstant

Simple average across multiple rows.

Properties

  • RowAggregator: field_.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BBoxTileSourceConstant

Has the same default tile origin as the WMTSTileSource but requested tiles use a {XMIN}, {YMIN}, {XMAX}, {YMAX} e.g. http://your.custom.tile.service?bbox={XMIN},{YMIN},{XMAX},{YMAX}.

Properties

  • BBoxTileSource: use_latlon.

  • MercatorTileSource: snap_to_zoom, wrap_around.

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BaseTextConstant

Base class for renderers of text content of various kinds.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.BooleanFormatterConstant

Boolean (check mark) cell formatter.

Properties

  • BooleanFormatter: icon.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CDSViewConstant

A view into a ColumnDataSource that represents a row-wise subset.

Properties

  • CDSView: filters, source.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CallbackConstant

Base class for interactive callback.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CanvasTextureConstant

Properties

  • CanvasTexture: code.

  • Texture: repetition.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CellEditorConstant

Abstract base class for data table's cell editors.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CellFormatterConstant

Abstract base class for data table's cell formatters.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CheckboxEditorConstant

Boolean value cell editor.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CoordinateMappingConstant

A mapping between two coordinate systems.

Properties

  • CoordinateMapping: x_scale, x_source, x_target, y_scale, y_source, y_target.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomJSConstant

Execute a JavaScript function.

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • CustomJS: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.CustomJSHoverConstant

Define a custom formatter to apply to a hover tool field.

This model can be configured with JavaScript code to format hover tooltips. The JavaScript code has access to the current value to format, some special variables, and any format configured on the tooltip. The variable value will contain the untransformed value. The variable special_vars will provide a dict with the following contents:

  • x data-space x-coordinate of the mouse

  • y data-space y-coordinate of the mouse

  • sx screen-space x-coordinate of the mouse

  • sy screen-space y-coordinate of the mouse

  • data_x data-space x-coordinate of the hovered glyph

  • data_y data-space y-coordinate of the hovered glyph

  • indices column indices of all currently hovered glyphs

  • name value of the name property of the hovered glyph renderer

If the hover is over a "multi" glyph such as Patches or MultiLine then a segment_index key will also be present.

Finally, the value of the format passed in the tooltip specification is available as the format variable.

Example:

As an example, the following code adds a custom formatter to format WebMercator northing coordinates (in meters) as a latitude:

lat_custom = CustomJSHover(code="""
    const projections = Bokeh.require("core/util/projections");
    const x = special_vars.x
    const y = special_vars.y
    const coords = projections.wgs84_mercator.invert(x, y)
    return "" + coords[1]
""")

p.add_tools(HoverTool(
    tooltips=[( 'lat','@y{custom}' )],
    formatters={'@y':lat_custom}
))
Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Properties

  • CustomJSHover: args, code.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DataModelConstant

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DateEditorConstant

Calendar-based date cell editor.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.DateFormatterConstant

Date cell formatter.

Properties

  • DateFormatter: format.

  • StringFormatter: font_style, nan_format, text_align, text_color.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EdgesAndLinkedNodesConstant

With the EdgesAndLinkedNodes policy, inspection or selection of graph edges will result in the inspection or selection of the edge and of the linked graph nodes. There is no direct selection or inspection of graph nodes.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.EdgesOnlyConstant

With the EdgesOnly policy, only graph edges are able to be selected and inspected. There is no selection or inspection of graph nodes.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GMapOptionsConstant

Options for GMapPlot objects.

Properties

  • GMapOptions: map_type, scale_control, styles, tilt.

  • MapOptions: lat, lng, zoom.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GraphHitTestPolicyConstant
Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.GroupingInfoConstant

Describes how to calculate totals and sub-totals

Properties

  • GroupingInfo: aggregators, collapsed, getter.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.HTMLTemplateFormatterConstant

HTML formatter using a template. This uses Underscore's template method and syntax. http://underscorejs.org/#template The formatter has access other items in the row via the dataContext object passed to the formatter. So, for example, if another column in the datasource was named url, the template could access it as:

<a href="<%= url %>"><%= value %></a>

To use a different set of template delimiters, pass the appropriate values for evaluate, interpolate', or `escape. See the Underscore template documentation for more information. http://underscorejs.org/#template

Example: Simple HTML template to format the column value as code.

HTMLTemplateFormatter(template='<code><%= value %></code>')

Example: Use values from other columns (manufacturer and model) to build a hyperlink.

HTMLTemplateFormatter(template=
    '<a href="https:/www.google.com/search?q=<%= manufacturer %>+<%= model %>" target="_blank"><%= value %></a>'
)

Properties

  • HTMLTemplateFormatter: template.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ImageURLTextureConstant

Properties

  • ImageURLTexture: url.

  • Texture: repetition.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.IntEditorConstant

Spinner-based integer cell editor.

Properties

  • IntEditor: step.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.IntersectRenderersConstant

When a data source is shared between multiple renderers, a row in the data source will only be selected if that point for each renderer is selected. The selection is made from the intersection of hit test results from all renderers.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LayoutProviderConstant
Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.LegendItemConstant

Properties

  • LegendItem: index, label, renderers, visible.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MapOptionsConstant

Abstract base class for map options' models.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • MapOptions: lat, lng, zoom.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MaxAggregatorConstant

Largest value across multiple rows.

Properties

  • RowAggregator: field_.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MaximumConstant

Computes maximum value of a data source's column.

Properties

  • Maximum: field, initial.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MercatorTileSourceConstant

A base class for Mercator tile services (e.g. WMTSTileSource).

Properties

  • MercatorTileSource: snap_to_zoom, wrap_around.

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MinAggregatorConstant

Smallest value across multiple rows.

Properties

  • RowAggregator: field_.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.MinimumConstant

Computes minimum value of a data source's column.

Properties

  • Minimum: field, initial.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ModelConstant

Base class for all objects stored in Bokeh Document instances.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NodesAndLinkedEdgesConstant

With the NodesAndLinkedEdges policy, inspection or selection of graph nodes will result in the inspection or selection of the node and of the linked graph edges. There is no direct selection or inspection of graph edges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NodesOnlyConstant

With the NodesOnly policy, only graph nodes are able to be selected and inspected. There is no selection or inspection of graph edges.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NormalHeadConstant

Render a closed-body arrow head.

Properties

  • NormalHead: fill_alpha, fill_color, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width.

  • ArrowHead: size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NumberEditorConstant

Spinner-based number cell editor.

Properties

  • NumberEditor: step.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.NumberFormatterConstant

Number cell formatter.

Properties

  • NumberFormatter: format, language, rounding.

  • StringFormatter: font_style, nan_format, text_align, text_color.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.OpenHeadConstant

Render an open-body arrow head.

Properties

  • OpenHead: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width.

  • ArrowHead: size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.OpenURLConstant

Open a URL in a new or current tab or window.

Properties

  • OpenURL: same_tab, url.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PanelConstant

A single-widget container with title bar and controls.

Properties

  • Panel: child, closable, disabled, title.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PercentEditorConstant

IntEditor optimized for editing percentages.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.PlainTextConstant

Represents plain text in contexts where text parsing is allowed.

Properties

  • BaseText: text.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ProxyToolbarConstant

A toolbar that allow to merge and proxy tools of toolbars in multiple plots.

Properties

  • ProxyToolbar: toolbars.

  • ToolbarBase: autohide, logo, tools.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.QUADKEYTileSourceConstant

Has the same tile origin as the WMTSTileSource but requests tiles using a quadkey argument instead of X, Y, Z e.g. http://your.quadkey.tile.host/{Q}.png

Properties

  • MercatorTileSource: snap_to_zoom, wrap_around.

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RendererGroupConstant

A collection of renderers.

Properties

  • RendererGroup: visible.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.RowAggregatorConstant

Abstract base class for data cube's row formatters.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • RowAggregator: field_.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScalarExpressionConstant

Base class for for scalar expressions. .. note:

This is an abstract base class used to help organize the hierarchy of Bokeh
model types. **It is not useful to instantiate on its own.**

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ScientificFormatterConstant

Display numeric values from continuous ranges as "basic numbers", using scientific notation when appropriate by default.

Properties

  • ScientificFormatter: power_limit_high, power_limit_low, precision.

  • StringFormatter: font_style, nan_format, text_align, text_color.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SelectEditorConstant

Select cell editor.

Properties

  • SelectEditor: options.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SelectionConstant

A Selection represents a portion of the data in a DataSource, which can be visually manipulated in a plot.

Selections are typically created by selecting points in a plot with a SelectTool, but can also be programmatically specified.

For most glyphs, the indices property is the relevant value to use.

Properties

  • Selection: indices, line_indices, multiline_indices.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SelectionPolicyConstant
Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StaticLayoutProviderConstant

Properties

  • StaticLayoutProvider: graph_layout.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StringEditorConstant

Basic string cell editor with auto-completion.

Properties

  • StringEditor: completions.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.StringFormatterConstant

Basic string cell formatter.

Properties

  • StringFormatter: font_style, nan_format, text_align, text_color.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.SumAggregatorConstant

Simple sum across multiple rows.

Properties

  • RowAggregator: field_.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TMSTileSourceConstant

Contains tile config info and provides urls for tiles based on a templated url e.g. http://your.tms.server.host/{Z}/{X}/{Y}.png. The defining feature of TMS is the tile-origin in located at the bottom-left.

TMSTileSource can also be helpful in implementing tile renderers for custom tile sets, including non-spatial datasets.

Properties

  • MercatorTileSource: snap_to_zoom, wrap_around.

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TableColumnConstant

Table column widget.

Properties

  • TableColumn: default_sort, editor, field, formatter, sortable, title, visible, width.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TeeHeadConstant

Render a tee-style arrow head.

Properties

  • TeeHead: line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width.

  • ArrowHead: size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextEditorConstant

Multi-line string cell editor.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TextureConstant

Base class for Texture models that represent fill patterns.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • Texture: repetition.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TileSourceConstant

A base class for all tile source types.

In general, tile sources are used as a required input for TileRenderer.

Properties

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.TimeEditorConstant

Spinner-based time cell editor.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToolbarConstant

Collect tools to display for a single plot.

Properties

  • Toolbar: active_drag, active_inspect, active_multi, active_scroll, active_tap.

  • ToolbarBase: autohide, logo, tools.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.ToolbarBaseConstant

A base class for different toolbars.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

Properties

  • ToolbarBase: autohide, logo, tools.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.UnionRenderersConstant

When a data source is shared between multiple renderers, selecting a point on from any renderer will cause that row in the data source to be selected. The selection is made from the union of hit test results from all renderers.

Properties

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.VeeHeadConstant

Render a vee-style arrow head.

Properties

  • VeeHead: fill_alpha, fill_color, line_alpha, line_cap, line_color, line_dash, line_dash_offset, line_join, line_width.

  • ArrowHead: size.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source
Bokeh.WMTSTileSourceConstant

Behaves much like TMSTileSource but has its tile-origin in the top-left.

This is the most common used tile source for web mapping applications. Such companies as Google, MapQuest, Stamen, Esri, and OpenStreetMap provide service which use the WMTS specification e.g. http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png.

Properties

  • MercatorTileSource: snap_to_zoom, wrap_around.

  • TileSource: attribution, extra_url_vars, initial_resolution, max_zoom, min_zoom, tile_size, url, x_origin_offset, y_origin_offset.

  • Model: js_event_callbacks, js_property_callbacks, name, subscribed_events, syncable, tags.

source