bokeh.models.tickers¶

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

class AdaptiveTicker(**kwargs)[source]¶

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: Float

The multiplier to use for scaling mantissas.

mantissas¶

property type: Seq ( Float )

The acceptable list numbers to generate multiples of.

max_interval¶

property type: Float

The largest allowable interval between two adjacent ticks.

Note

To specify an unbounded interval, set to None.

min_interval¶

property type: Float

The smallest allowable interval between two adjacent ticks.

JSON Prototype

{
  "base": 10.0,
  "desired_num_ticks": 6,
  "id": "1f206fbf-2f92-4e7e-8cb6-cf39cd5548fd",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mantissas": [
    1,
    2,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class BasicTicker(**kwargs)[source]¶

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": "a2f6cf6a-adee-47bd-84bc-7382af290d2e",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mantissas": [
    1,
    2,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class CategoricalTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.Ticker

Generate ticks for categorical ranges.

JSON Prototype

{
  "id": "8756378f-b955-4d99-a17b-f18b29744fc3",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class CompositeTicker(**kwargs)[source]¶

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: 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": "a8e28423-f81b-4d8a-a37b-94b265482aae",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": [],
  "tickers": []
}

class ContinuousTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.Ticker

A base class for non-categorical ticker types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

desired_num_ticks¶

property type: Int

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

num_minor_ticks¶

property type: Int

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

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "96eb26be-acd5-43d8-97d8-f787f38996ad",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class DatetimeTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.CompositeTicker

Generate nice ticks across different date and time scales.

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "b7cb3aad-4688-4b80-99a3-116c1fb29096",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 0,
  "subscribed_events": [],
  "tags": [],
  "tickers": [
    {
      "id": "22f02bfe-5f07-4378-971b-712e4d28a6d6",
      "type": "AdaptiveTicker"
    },
    {
      "id": "658026ce-bd7d-42ce-9704-a368b1ad4c06",
      "type": "AdaptiveTicker"
    },
    {
      "id": "b0e8498d-4314-43f7-ae38-178a10f24a62",
      "type": "AdaptiveTicker"
    },
    {
      "id": "b952f648-81d0-4053-97f2-25f0263848bf",
      "type": "DaysTicker"
    },
    {
      "id": "39beb78b-21ac-4b18-bd6b-02605c4ba887",
      "type": "DaysTicker"
    },
    {
      "id": "e881cb8b-7722-4a15-929f-5bd8892d9fbf",
      "type": "DaysTicker"
    },
    {
      "id": "1f4361da-5856-4783-87e7-07ef5d4db0ef",
      "type": "DaysTicker"
    },
    {
      "id": "86cdc26f-e8cb-4b15-a9af-583475b27e32",
      "type": "MonthsTicker"
    },
    {
      "id": "ab531d4a-c67b-423e-93e4-5469a576876b",
      "type": "MonthsTicker"
    },
    {
      "id": "4fdc4b5b-433b-418d-bf46-8b8f79d96b42",
      "type": "MonthsTicker"
    },
    {
      "id": "4884dc32-ee61-45a4-a3ec-571bad03b925",
      "type": "MonthsTicker"
    },
    {
      "id": "8bfc723e-37c2-49aa-98af-ee162a2733eb",
      "type": "YearsTicker"
    }
  ]
}

class DaysTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.SingleIntervalTicker

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

days¶

property type: Seq ( Int )

The intervals of days to use.

JSON Prototype

{
  "days": [],
  "desired_num_ticks": 6,
  "id": "d42a6450-5c0e-4d8b-97de-7c4dedc11250",
  "interval": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 0,
  "subscribed_events": [],
  "tags": []
}

class FixedTicker(**kwargs)[source]¶

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: Seq ( Float )

List of tick locations.

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "88a2d852-46cf-484b-a5ff-3e7e43dd78e3",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": [],
  "ticks": []
}

class LogTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.AdaptiveTicker

Generate ticks on a log scale.

JSON Prototype

{
  "base": 10.0,
  "desired_num_ticks": 6,
  "id": "f0c900ac-5908-413f-9191-f15b2eda0ceb",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mantissas": [
    1,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class MercatorTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.BasicTicker

Generate nice lat/lon ticks form underlying WebMercator coordinates.

dimension¶

property type: Enum ( LatLon )

Specify whether to generate ticks for Latitude or Longitude.

Projected coordinates are not separable, computing Latitude and Longitude tick locations from Web Mercator requires considering coordinates from both dimensions together. Use this property to specify which result should be returned.

Typically, if the ticker is for an x-axis, then dimension should be "lon" and if the ticker is for a y-axis, then the dimension should be “lat”`.

In order to prevent hard to debug errors, there is no default value for dimension. Using an un-configured MercatorTicker will result in a validation error and a JavaScript console error.

JSON Prototype

{
  "base": 10.0,
  "desired_num_ticks": 6,
  "dimension": null,
  "id": "c27acdb3-53b8-4a55-ac47-1c1e2598f765",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mantissas": [
    1,
    2,
    5
  ],
  "max_interval": null,
  "min_interval": 0.0,
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class MonthsTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.SingleIntervalTicker

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

months¶

property type: Seq ( Int )

The intervals of months to use.

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "6a346c81-9ba0-4f3d-9786-10d52aefa78c",
  "interval": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "months": [],
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class SingleIntervalTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.ContinuousTicker

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

interval¶

property type: Float

The interval between adjacent ticks.

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "8477c3f3-f7c3-4d4a-8b4c-9b3a12f68ae1",
  "interval": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}

class Ticker(**kwargs)[source]¶

Bases: bokeh.model.Model

A base class for all ticker types.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

JSON Prototype

{
  "id": "e81ec4af-5b35-4aac-a942-7cdecfe0fd4c",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class YearsTicker(**kwargs)[source]¶

Bases: bokeh.models.tickers.SingleIntervalTicker

Generate ticks spaced apart even numbers of years.

JSON Prototype

{
  "desired_num_ticks": 6,
  "id": "306f19f1-5078-4f14-a5a4-92cfbc5c9e57",
  "interval": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_minor_ticks": 5,
  "subscribed_events": [],
  "tags": []
}