`bokeh.models.axes`¶

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

class Axis(**kwargs)¶

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: axis_label:String

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

Note

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

axis_label_standoff¶

property type: axis_label_standoff:Int

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

axis_label_text_align¶

property type: axis_label_text_align:Enum(‘left’, ‘right’, ‘center’)

The text align of the axis label.

axis_label_text_alpha¶

property type: axis_label_text_alpha:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The text alpha of the axis label.

axis_label_text_baseline¶

property type: axis_label_text_baseline:Enum(‘top’, ‘middle’, ‘bottom’, ‘alphabetic’, ‘hanging’)

The text baseline of the axis label.

axis_label_text_color¶

property type: axis_label_text_color:ColorSpec(String, Dict(String, Either(String, Color)), Color)

The text color of the axis label.

axis_label_text_font¶

property type: axis_label_text_font:String

The text font of the axis label.

axis_label_text_font_size¶

property type: axis_label_text_font_size:FontSizeSpec(String, Dict(String, Either(String, List(String))), List(String))

The text font size of the axis label.

axis_label_text_font_style¶

property type: axis_label_text_font_style:Enum(‘normal’, ‘italic’, ‘bold’)

The text font style of the axis label.

axis_line_alpha¶

property type: axis_line_alpha:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line alpha of the axis line.

axis_line_cap¶

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

The line cap of the axis line.

axis_line_color¶

property type: axis_line_color:ColorSpec(String, Dict(String, Either(String, Color)), Color)

The line color of the axis line.

axis_line_dash¶

property type: axis_line_dash:DashPattern

The line dash of the axis line.

axis_line_dash_offset¶

property type: axis_line_dash_offset:Int

The line dash offset of the axis line.

axis_line_join¶

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

The line join of the axis line.

axis_line_width¶

property type: axis_line_width:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line width of the axis line.

bounds¶

property type: bounds: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: formatter:Instance(TickFormatter)

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

location¶

property type: location:Either(Auto, Enum(‘above’, ‘below’, ‘left’, ‘right’))

Where should labels and ticks be located in relation to the axis rule.

major_label_orientation¶

property type: major_label_orientation:Either(Enum(‘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: major_label_standoff:Int

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

major_label_text_align¶

property type: major_label_text_align:Enum(‘left’, ‘right’, ‘center’)

The text align of the major tick labels.

major_label_text_alpha¶

property type: major_label_text_alpha:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The text alpha of the major tick labels.

major_label_text_baseline¶

property type: major_label_text_baseline:Enum(‘top’, ‘middle’, ‘bottom’, ‘alphabetic’, ‘hanging’)

The text baseline of the major tick labels.

major_label_text_color¶

property type: major_label_text_color:ColorSpec(String, Dict(String, Either(String, Color)), Color)

The text color of the major tick labels.

major_label_text_font¶

property type: major_label_text_font:String

The text font of the major tick labels.

major_label_text_font_size¶

property type: major_label_text_font_size:FontSizeSpec(String, Dict(String, Either(String, List(String))), List(String))

The text font size of the major tick labels.

major_label_text_font_style¶

property type: major_label_text_font_style:Enum(‘normal’, ‘italic’, ‘bold’)

The text font style of the major tick labels.

major_tick_in¶

property type: major_tick_in:Int

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

major_tick_line_alpha¶

property type: major_tick_line_alpha:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line alpha of the major ticks.

major_tick_line_cap¶

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

The line cap of the major ticks.

major_tick_line_color¶

property type: major_tick_line_color:ColorSpec(String, Dict(String, Either(String, Color)), Color)

The line color of the major ticks.

major_tick_line_dash¶

property type: major_tick_line_dash:DashPattern

The line dash of the major ticks.

major_tick_line_dash_offset¶

property type: major_tick_line_dash_offset:Int

The line dash offset of the major ticks.

major_tick_line_join¶

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

The line join of the major ticks.

major_tick_line_width¶

property type: major_tick_line_width:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line width of the major ticks.

major_tick_out¶

property type: major_tick_out:Int

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

minor_tick_in¶

property type: minor_tick_in:Int

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

minor_tick_line_alpha¶

property type: minor_tick_line_alpha:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line alpha of the minor ticks.

minor_tick_line_cap¶

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

The line cap of the minor ticks.

minor_tick_line_color¶

property type: minor_tick_line_color:ColorSpec(String, Dict(String, Either(String, Color)), Color)

The line color of the minor ticks.

minor_tick_line_dash¶

property type: minor_tick_line_dash:DashPattern

The line dash of the minor ticks.

minor_tick_line_dash_offset¶

property type: minor_tick_line_dash_offset:Int

The line dash offset of the minor ticks.

minor_tick_line_join¶

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

The line join of the minor ticks.

minor_tick_line_width¶

property type: minor_tick_line_width:NumberSpec(String, Dict(String, Either(String, Float)), Float)

The line width of the minor ticks.

minor_tick_out¶

property type: minor_tick_out:Int

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

ticker¶

property type: ticker:Instance(Ticker)

A Ticker to use for computing locations of axis components.

visible¶

property type: visible:Bool

Ability to hide the entire axis from the plot.

x_range_name¶

property type: x_range_name: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: y_range_name: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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "47ed18bf-708d-4dde-919f-7bcd85bbb935",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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)¶

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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "dcd3e1c8-28b2-4497-a343-aa7a6f8e6364",
    "type": "CategoricalTickFormatter"
  },
  "id": "21cda7d3-229c-4d2a-8ab2-e1f0634a0457",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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": "2ae7de92-970f-4722-a197-ad88855279de",
    "type": "CategoricalTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class ContinuousAxis(**kwargs)¶

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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "b70569de-4e54-4a2c-8c5c-1b7e22d39e03",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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)¶

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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "303977dc-603c-4292-93f2-c04bffadab13",
    "type": "DatetimeTickFormatter"
  },
  "id": "5d93230a-080b-4c49-800f-20b9369ff168",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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": "30220f85-6b6c-42fc-bca9-3f8c1f185aa6",
    "type": "DatetimeTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class LinearAxis(**kwargs)¶

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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "f622edaf-8441-4dfc-90d3-3b9782b81c51",
    "type": "BasicTickFormatter"
  },
  "id": "3ee32cd6-07aa-46dd-91c4-d360498feddc",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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": "9222fdbb-870e-4d74-bf28-a03c75a72b86",
    "type": "BasicTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class LogAxis(**kwargs)¶

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": "center",
  "axis_label_text_alpha": {
    "value": 1.0
  },
  "axis_label_text_baseline": "alphabetic",
  "axis_label_text_color": {
    "value": "#444444"
  },
  "axis_label_text_font": "helvetica",
  "axis_label_text_font_size": {
    "value": "16pt"
  },
  "axis_label_text_font_style": "normal",
  "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": "85e9836b-1f06-498f-81eb-362478e4e17b",
    "type": "LogTickFormatter"
  },
  "id": "58b5fc7a-0ea8-46bc-abcc-9bab01cc4faa",
  "level": "overlay",
  "location": "auto",
  "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": "10pt"
  },
  "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": "e3fcbe8c-36db-4c0e-a226-cf3fab7b9c20",
    "type": "LogTicker"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

bokeh.models.axes¶

`bokeh.models.axes`¶