Bokeh Menu

bokeh.models.tickers

Models for computing good tick locations on different kinds of plots.

class AdaptiveTicker(**kwargs)

Bases: bokeh.models.tickers.ContinuousTicker

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, ...
base

property type: base:Float

The multiplier to use for scaling mantissas.

mantissas

property type: mantissas:Seq(Float)

The acceptable list numbers to generate multiples of.

max_interval

property type: max_interval:Float

The largest allowable interval between two adjacent ticks.

Note

To specify an unbounded interval, set to None.

min_interval

property type: min_interval:Float

The smallest allowable interval between two adjacent ticks.

JSON Prototype 
{
  "base": 10.0,
  "desired_num_ticks": 6,
  "id": "34b7528a-0abf-4420-910a-c7766c3f96fd",
  "mantissas": [
    1,
    2,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class BasicTicker(**kwargs)

Bases: bokeh.models.tickers.AdaptiveTicker

Generate ticks on a linear scale.

Note

This class may be renamed to LinearTicker in the future.

JSON Prototype 
{
  "base": 10.0,
  "desired_num_ticks": 6,
  "id": "a8b91209-f235-479d-ad60-b184d1559064",
  "mantissas": [
    1,
    2,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class CategoricalTicker(**kwargs)

Bases: bokeh.models.tickers.Ticker

Generate ticks for categorical ranges.

JSON Prototype 
{
  "id": "902c8c40-4146-433f-97ff-41e7faf98ef8",
  "name": null,
  "tags": []
}
class CompositeTicker(**kwargs)

Bases: bokeh.models.tickers.ContinuousTicker

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.

tickers

property type: tickers:Seq(Instance(Ticker))

A list of Ticker objects to combine at different scales in order to generate tick values. The supplied tickers should be in order. Specifically, if S comes before T, then it should be the case that:

S.get_max_interval() < T.get_min_interval()
JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "0a2c7761-0466-4839-9203-27973d7d0f2d",
  "name": null,
  "num_minor_ticks": 5,
  "tags": [],
  "tickers": []
}
class ContinuousTicker(**kwargs)

Bases: bokeh.models.tickers.Ticker

A base class for non-categorical ticker types. ContinuousTicker is not generally useful to instantiate on its own.

desired_num_ticks

property type: desired_num_ticks:Int

A desired target number of major tick positions to generate across the plot range.

num_minor_ticks

property type: num_minor_ticks:Int

The number of minor tick positions to generate between adjacent major tick values.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "713cb2f9-ded7-49af-9fc4-17a2dd167a90",
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class DatetimeTicker(**kwargs)

Bases: bokeh.models.tickers.CompositeTicker

Generate nice ticks across different date and time scales.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "22d76084-e24c-4fe2-a058-a3b983a163ce",
  "name": null,
  "num_minor_ticks": 0,
  "tags": [],
  "tickers": [
    {
      "id": "7efa032d-0cb1-4cf7-80cc-0c7067afec83",
      "type": "AdaptiveTicker"
    },
    {
      "id": "93daa9ee-0fa4-4abb-a016-6e9b81dc78b7",
      "type": "AdaptiveTicker"
    },
    {
      "id": "19eeeadd-5607-499b-a5a6-eafad17e860c",
      "type": "AdaptiveTicker"
    },
    {
      "id": "81bc76f0-a13e-41c3-8e09-d246992b109e",
      "type": "DaysTicker"
    },
    {
      "id": "e37c1812-9518-4af9-aaca-4e63077919e5",
      "type": "DaysTicker"
    },
    {
      "id": "c3f7080c-dbe5-4d01-9353-d2802321ad7a",
      "type": "DaysTicker"
    },
    {
      "id": "cf628e7c-1d88-41d1-9b7f-7a2cec77fb24",
      "type": "DaysTicker"
    },
    {
      "id": "61f8643e-b623-4f02-b757-d6a899c35ed1",
      "type": "MonthsTicker"
    },
    {
      "id": "086d5c58-760a-410f-bf26-e32d8e42a338",
      "type": "MonthsTicker"
    },
    {
      "id": "5705db74-df31-42fd-a72f-c5bbaa575950",
      "type": "MonthsTicker"
    },
    {
      "id": "c427cff6-0b03-4290-a057-0b9b4d2c3077",
      "type": "MonthsTicker"
    },
    {
      "id": "c0c6b81f-d1b7-42d6-80b8-4987201c90a4",
      "type": "YearsTicker"
    }
  ]
}
class DaysTicker(**kwargs)

Bases: bokeh.models.tickers.SingleIntervalTicker

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

days

property type: days:Seq(Int)

The intervals of days to use.

JSON Prototype 
{
  "days": [],
  "desired_num_ticks": 6,
  "id": "010fc9ae-dc60-4791-9528-f580f5e4a0cb",
  "interval": null,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class FixedTicker(**kwargs)

Bases: bokeh.models.tickers.ContinuousTicker

Generate ticks at fixed, explicitly supplied locations.

Note

The desired_num_ticks property is ignored by this Ticker.

ticks

property type: ticks:Seq(Float)

List of tick locations.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "de6feb9d-b877-4c43-9368-22201cbec1a1",
  "name": null,
  "num_minor_ticks": 5,
  "tags": [],
  "ticks": []
}
class LogTicker(**kwargs)

Bases: bokeh.models.tickers.AdaptiveTicker

Generate ticks on a log scale.

JSON Prototype 
{
  "base": 10.0,
  "desired_num_ticks": 6,
  "id": "9d9baced-dcfb-4f6b-9ffb-2787b3adf74f",
  "mantissas": [
    1,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class MonthsTicker(**kwargs)

Bases: bokeh.models.tickers.SingleIntervalTicker

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

months

property type: months:Seq(Int)

The intervals of months to use.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "56fb05d7-b8c9-4229-afee-5c7980c92f9a",
  "interval": null,
  "months": [],
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class SingleIntervalTicker(**kwargs)

Bases: bokeh.models.tickers.ContinuousTicker

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

interval

property type: interval:Float

The interval between adjacent ticks.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "4ca812db-ef23-49c7-997b-8dc688f2fcb7",
  "interval": null,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}
class Ticker(**kwargs)

Bases: bokeh.model.Model

A base class for all ticker types. Ticker is not generally useful to instantiate on its own.

JSON Prototype 
{
  "id": "61f1c48e-397b-422c-97c8-205547a8f68b",
  "name": null,
  "tags": []
}
class YearsTicker(**kwargs)

Bases: bokeh.models.tickers.SingleIntervalTicker

Generate ticks spaced apart even numbers of years.

JSON Prototype 
{
  "desired_num_ticks": 6,
  "id": "e8550660-8d69-4575-9795-6b07ce1ab4a3",
  "interval": null,
  "name": null,
  "num_minor_ticks": 5,
  "tags": []
}