bokeh.models.grids — Anaconda Enterprise 4.4 documentation

Anaconda Enterprise: Documentation

# bokeh.models.grids

A guide renderer for displaying grid lines on Bokeh plots.

class `bokeh.models.grids.` `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: `NumberSpec`

    The fill alpha of alternating bands between Grid lines.

  `band_fill_color`

    property type: `ColorSpec`

    The fill color of alternating bands between Grid lines.

  `bounds`

    property type: `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: `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: `NumberSpec`

    The line alpha of the Grid lines.

  `grid_line_cap`

    property type: `Enum` ( `LineCap` )

    The line cap of the Grid lines.

  `grid_line_color`

    property type: `ColorSpec`

    The line color of the Grid lines.

  `grid_line_dash`

    property type: `DashPattern`

    The line dash of the Grid lines.

  `grid_line_dash_offset`

    property type: `Int`

    The line dash offset of the Grid lines.

  `grid_line_join`

    property type: `Enum` ( `LineJoin` )

    The line join of the Grid lines.

  `grid_line_width`

    property type: `NumberSpec`

    The line width of the Grid lines.

  `minor_grid_line_alpha`

    property type: `NumberSpec`

    The line alpha of the minor Grid lines.

  `minor_grid_line_cap`

    property type: `Enum` ( `LineCap` )

    The line cap of the minor Grid lines.

  `minor_grid_line_color`

    property type: `ColorSpec`

    The line color of the minor Grid lines.

  `minor_grid_line_dash`

    property type: `DashPattern`

    The line dash of the minor Grid lines.

  `minor_grid_line_dash_offset`

    property type: `Int`

    The line dash offset of the minor Grid lines.

  `minor_grid_line_join`

    property type: `Enum` ( `LineJoin` )

    The line join of the minor Grid lines.

  `minor_grid_line_width`

    property type: `NumberSpec`

    The line width of the minor Grid lines.

  `ticker`

    property type: `Instance` ( `Ticker` )

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

  `x_range_name`

    property type: `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: `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.

JSON Prototype

    {
      "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": "8c38e710-fb37-483b-a2e6-efe18a25a848",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "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,
      "subscribed_events": [],
      "tags": [],
      "ticker": null,
      "visible": true,
      "x_range_name": "default",
      "y_range_name": "default"
    }