bokeh.models.grids¶

A guide renderer for displaying grid lines on Bokeh plots.

class Grid(**kwargs)¶

Bases: bokeh.models.renderers.GuideRenderer

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

band_fill_alpha¶

property type: band_fill_alpha:NumberSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Float)), Float)

The fill alpha of alternating bands between Grid lines.

band_fill_color¶

property type: band_fill_color:ColorSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Color)), Color)

The fill color of alternating bands between Grid lines.

bounds¶

property type: bounds:Either(Auto, Tuple(Float, Float))

Bounds for the rendered grid lines. If unset, the grid lines will span the entire plot in the given dimension.

dimension¶

property type: dimension:Int

Which dimension the Axis Grid lines will intersect. The x-axis is dimension 0 (vertical Grid lines) and the y-axis is dimension 1 (horizontal Grid lines).

grid_line_alpha¶

property type: grid_line_alpha:NumberSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Float)), Float)

The line alpha of the Grid lines.

grid_line_cap¶

property type: grid_line_cap:Enum(‘butt’, ‘round’, ‘square’)

The line cap of the Grid lines.

grid_line_color¶

property type: grid_line_color:ColorSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Color)), Color)

The line color of the Grid lines.

grid_line_dash¶

property type: grid_line_dash:DashPattern

The line dash of the Grid lines.

grid_line_dash_offset¶

property type: grid_line_dash_offset:Int

The line dash offset of the Grid lines.

grid_line_join¶

property type: grid_line_join:Enum(‘miter’, ‘round’, ‘bevel’)

The line join of the Grid lines.

grid_line_width¶

property type: grid_line_width:NumberSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Float)), Float)

The line width of the Grid lines.

minor_grid_line_alpha¶

property type: minor_grid_line_alpha:NumberSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Float)), Float)

The line alpha of the minor Grid lines.

minor_grid_line_cap¶

property type: minor_grid_line_cap:Enum(‘butt’, ‘round’, ‘square’)

The line cap of the minor Grid lines.

minor_grid_line_color¶

property type: minor_grid_line_color:ColorSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Color)), Color)

The line color of the minor Grid lines.

minor_grid_line_dash¶

property type: minor_grid_line_dash:DashPattern

The line dash of the minor Grid lines.

minor_grid_line_dash_offset¶

property type: minor_grid_line_dash_offset:Int

The line dash offset of the minor Grid lines.

minor_grid_line_join¶

property type: minor_grid_line_join:Enum(‘miter’, ‘round’, ‘bevel’)

The line join of the minor Grid lines.

minor_grid_line_width¶

property type: minor_grid_line_width:NumberSpec(String, Dict(String, Either(String, Instance(Transform), Instance(ColorMapper), Float)), Float)

The line width of the minor Grid lines.

ticker¶

property type: ticker:Instance(Ticker)

The Ticker to use for computing locations for the Grid lines.

x_range_name¶

property type: x_range_name:String

A particular (named) x-range to use for computing screen locations when rendering a grid on the plot. If unset, use the default x-range.

y_range_name¶

property type: y_range_name:String

A particular (named) y-range to use for computing screen locations when rendering a grid on the plot. If unset, use the default y-range.

{
  "band_fill_alpha": {
    "value": 0
  },
  "band_fill_color": {
    "value": null
  },
  "bounds": "auto",
  "dimension": 0,
  "grid_line_alpha": {
    "value": 1.0
  },
  "grid_line_cap": "butt",
  "grid_line_color": {
    "value": "#e5e5e5"
  },
  "grid_line_dash": [],
  "grid_line_dash_offset": 0,
  "grid_line_join": "miter",
  "grid_line_width": {
    "value": 1
  },
  "id": "5426520d-eeb4-4442-834d-65cabd72359c",
  "level": "underlay",
  "minor_grid_line_alpha": {
    "value": 1.0
  },
  "minor_grid_line_cap": "butt",
  "minor_grid_line_color": {
    "value": null
  },
  "minor_grid_line_dash": [],
  "minor_grid_line_dash_offset": 0,
  "minor_grid_line_join": "miter",
  "minor_grid_line_width": {
    "value": 1
  },
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}