bokeh.models.axes¶

Guide renderers for various kinds of axes that can be added to Bokeh plots

class Axis(**kwargs)[source]¶

Bases: bokeh.models.renderers.GuideRenderer

A base class that defines common properties for all axis types. Axis is not generally useful to instantiate on its own.

axis_label¶

property type: String

A text label for the axis, displayed parallel to the axis rule.

Note

LaTeX notation is not currently supported; please see #647 to track progress or contribute.

axis_label_standoff¶

property type: Int

The distance in pixels that the axis labels should be offset from the tick labels.

axis_label_text_align¶

property type: Enum ( TextAlign )

The text align of the axis label.

axis_label_text_alpha¶

property type: NumberSpec

The text alpha of the axis label.

axis_label_text_baseline¶

property type: Enum ( TextBaseline )

The text baseline of the axis label.

axis_label_text_color¶

property type: ColorSpec

The text color of the axis label.

axis_label_text_font¶

property type: String

The text font of the axis label.

axis_label_text_font_size¶

property type: FontSizeSpec

The text font size of the axis label.

axis_label_text_font_style¶

property type: Enum ( FontStyle )

The text font style of the axis label.

axis_line_alpha¶

property type: NumberSpec

The line alpha of the axis line.

axis_line_cap¶

property type: Enum ( LineCap )

The line cap of the axis line.

axis_line_color¶

property type: ColorSpec

The line color of the axis line.

axis_line_dash¶

property type: DashPattern

The line dash of the axis line.

axis_line_dash_offset¶

property type: Int

The line dash offset of the axis line.

axis_line_join¶

property type: Enum ( LineJoin )

The line join of the axis line.

axis_line_width¶

property type: NumberSpec

The line width of the axis line.

bounds¶

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

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

formatter¶

property type: Instance ( TickFormatter )

A TickFormatter to use for formatting the visual appearance of ticks.

major_label_orientation¶

property type: Either ( Enum ( Enumeration(horizontal, vertical) ), Float )

What direction the major label text should be oriented. If a i number is supplied, the angle of the text is measured from horizontal.

major_label_standoff¶

property type: Int

The distance in pixels that the major tick labels should be offset from the associated ticks.

major_label_text_align¶

property type: Enum ( TextAlign )

The text align of the major tick labels.

major_label_text_alpha¶

property type: NumberSpec

The text alpha of the major tick labels.

major_label_text_baseline¶

property type: Enum ( TextBaseline )

The text baseline of the major tick labels.

major_label_text_color¶

property type: ColorSpec

The text color of the major tick labels.

major_label_text_font¶

property type: String

The text font of the major tick labels.

major_label_text_font_size¶

property type: FontSizeSpec

The text font size of the major tick labels.

major_label_text_font_style¶

property type: Enum ( FontStyle )

The text font style of the major tick labels.

major_tick_in¶

property type: Int

The distance in pixels that major ticks should extend into the main plot area.

major_tick_line_alpha¶

property type: NumberSpec

The line alpha of the major ticks.

major_tick_line_cap¶

property type: Enum ( LineCap )

The line cap of the major ticks.

major_tick_line_color¶

property type: ColorSpec

The line color of the major ticks.

major_tick_line_dash¶

property type: DashPattern

The line dash of the major ticks.

major_tick_line_dash_offset¶

property type: Int

The line dash offset of the major ticks.

major_tick_line_join¶

property type: Enum ( LineJoin )

The line join of the major ticks.

major_tick_line_width¶

property type: NumberSpec

The line width of the major ticks.

major_tick_out¶

property type: Int

The distance in pixels that major ticks should extend out of the main plot area.

minor_tick_in¶

property type: Int

The distance in pixels that minor ticks should extend into the main plot area.

minor_tick_line_alpha¶

property type: NumberSpec

The line alpha of the minor ticks.

minor_tick_line_cap¶

property type: Enum ( LineCap )

The line cap of the minor ticks.

minor_tick_line_color¶

property type: ColorSpec

The line color of the minor ticks.

minor_tick_line_dash¶

property type: DashPattern

The line dash of the minor ticks.

minor_tick_line_dash_offset¶

property type: Int

The line dash offset of the minor ticks.

minor_tick_line_join¶

property type: Enum ( LineJoin )

The line join of the minor ticks.

minor_tick_line_width¶

property type: NumberSpec

The line width of the minor ticks.

minor_tick_out¶

property type: Int

The distance in pixels that major ticks should extend out of the main plot area.

ticker¶

property type: Instance ( Ticker )

A Ticker to use for computing locations of axis components.

x_range_name¶

property type: String

A particular (named) x-range to use for computing screen locations when rendering an axis 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 an axis on the plot. If unset, use the default y-range.

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": null,
  "id": "cb15dc54-b46b-48be-829b-f6945ceadad9",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class CategoricalAxis(**kwargs)[source]¶

Bases: bokeh.models.axes.Axis

An axis that picks evenly spaced tick locations for a collection of categories/factors.

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": {
    "id": "5b0e6059-3bdf-494a-a1cf-cbf8a507c4ad",
    "type": "CategoricalTickFormatter"
  },
  "id": "ab1e4916-e136-4c75-8a1b-1c8c316af06d",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": {
    "id": "5d657499-ccee-4761-8e15-22073621454e",
    "type": "CategoricalTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class ContinuousAxis(**kwargs)[source]¶

Bases: bokeh.models.axes.Axis

A base class for all numeric, non-categorical axes types. ContinuousAxis is not generally useful to instantiate on its own.

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": null,
  "id": "617597a2-c366-4ace-9e74-fd486eb730c8",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class DatetimeAxis(**kwargs)[source]¶

Bases: bokeh.models.axes.LinearAxis

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

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": {
    "id": "6e3bb00d-5f1f-4083-a860-b024c5c85d02",
    "type": "DatetimeTickFormatter"
  },
  "id": "a867578c-7f24-40fe-938c-4ba949a4a3c1",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": {
    "id": "95baf748-d221-43a5-84ab-5cffb5fc3e13",
    "type": "DatetimeTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class LinearAxis(**kwargs)[source]¶

Bases: bokeh.models.axes.ContinuousAxis

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

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": {
    "id": "51d6fa5b-611b-48ea-822f-e480b3f8527d",
    "type": "BasicTickFormatter"
  },
  "id": "fbe747d6-d99e-457b-a09e-f7dc7391a3c9",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": {
    "id": "34502a90-fd25-41df-9bfd-35a2dffe8d36",
    "type": "BasicTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class LogAxis(**kwargs)[source]¶

Bases: bokeh.models.axes.ContinuousAxis

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

JSON Prototype

{
  "axis_label": "",
  "axis_label_standoff": 5,
  "axis_label_text_align": "left",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "bottom",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "10pt"
  },
  "axis_label_text_font_style": "italic",
  "axis_line_alpha": {
    "value": 1.0
  },
  "axis_line_cap": "butt",
  "axis_line_color": {
    "value": "black"
  },
  "axis_line_dash": [],
  "axis_line_dash_offset": 0,
  "axis_line_join": "miter",
  "axis_line_width": {
    "value": 1
  },
  "bounds": "auto",
  "formatter": {
    "id": "f88a34d8-bd3e-4e52-a583-62af68df1c60",
    "type": "LogTickFormatter"
  },
  "id": "6ef7d192-502c-4489-be64-af9eaa501849",
  "js_callbacks": {},
  "level": "overlay",
  "major_label_orientation": "horizontal",
  "major_label_standoff": 5,
  "major_label_text_align": "center",
  "major_label_text_alpha": {
    "value": 1.0
  },
  "major_label_text_baseline": "alphabetic",
  "major_label_text_color": {
    "value": "#444444"
  },
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": {
    "value": "8pt"
  },
  "major_label_text_font_style": "normal",
  "major_tick_in": 2,
  "major_tick_line_alpha": {
    "value": 1.0
  },
  "major_tick_line_cap": "butt",
  "major_tick_line_color": {
    "value": "black"
  },
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "miter",
  "major_tick_line_width": {
    "value": 1
  },
  "major_tick_out": 6,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": {
    "value": 1.0
  },
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": {
    "value": "black"
  },
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "miter",
  "minor_tick_line_width": {
    "value": 1
  },
  "minor_tick_out": 4,
  "name": null,
  "plot": null,
  "tags": [],
  "ticker": {
    "id": "0931e78b-b5d8-4d0c-af6c-6407d81f66d8",
    "type": "LogTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}