DiscreteLocator

class DiscreteLocator(locs, **kwargs)

Bases: Locator

A tick locator suitable for discretized colorbars. Adds ticks to some subset of the location list depending on the available space determined from get_tick_space. Zero will be used if it appears in the location list, and step sizes along the location list are restricted to “nice” intervals by default.

Parameters:

• locs (array-like) – The tick location list.

• nbins (int, optional) – Maximum number of ticks to select. By default this is automatically determined based on the the axis length and tick label font size.

• minor (bool, default: False) – Whether this is for “minor” ticks. Setting to True will select more ticks with an index step that divides the index step used for “major” ticks.

• steps (array-like of int, default: [1 2 3 4 5 6 8]) – Valid integer index steps when selecting from the tick list. Must fall between 1 and 9. Powers of 10 of these step sizes will also be permitted.

• min_n_ticks (int, default: 1) – The minimum number of ticks to select. See also nbins.

Attributes Summary

default_params

Methods Summary

__call__()	Return the locations of the ticks.
set_params([steps, nbins, minor, min_n_ticks])	Set the parameters for this locator.
tick_values(vmin, vmax)	Return the locations of the ticks.

Attributes Documentation

default_params = {'min_n_ticks': 2, 'minor': False, 'nbins': None, 'steps': array([ 1,  2,  3,  4,  5,  6,  8, 10])}

Methods Documentation

__call__()

Return the locations of the ticks.

set_params(steps=None, nbins=None, minor=None, min_n_ticks=None)

Set the parameters for this locator. See DiscreteLocator for details.

tick_values(vmin, vmax)

Return the locations of the ticks.