Locator¶

Locator(locator, *args, **kwargs)[source]¶

Return a Locator instance. This function is used to interpret the xlocator, xlocator_kw, ylocator, ylocator_kw, xminorlocator, xminorlocator_kw, yminorlocator, and yminorlocator_kw arguments when passed to format, and the locator, locator_kw, minorlocator, and minorlocator_kw arguments when passed to colorbar methods wrapped by colorbar_extras.

Parameters

locator (Locator, str, float, or list of float) – The axis locator specification, interpreted as follows:

If a Locator instance already, the input argument is simply returned.
If a list of numbers, these points are ticked. Returns a FixedLocator.
If number, this specifies the step size between tick locations. Returns a MultipleLocator.

Otherwise, locator should be a string corresponding to one of the “registered” locators (see below table). If locator is a list or tuple and the first element is a “registered” locator name, subsequent elements are passed to the locator class as positional arguments.

Key	Class	Description
`'null'`, `'none'`	`NullLocator`	No ticks
`'auto'`	`AutoLocator`	Major ticks at sensible locations
`'minor'`	`AutoMinorLocator`	Minor ticks at sensible locations
`'date'`	`AutoDateLocator`	Default tick locations for datetime axes
`'fixed'`	`FixedLocator`	Ticks at these exact locations
`'index'`	`IndexLocator`	Ticks on the non-negative integers
`'linear'`	`LinearLocator`	Exactly `N` ticks encompassing axis limits, spaced as `numpy.linspace(lo, hi, N)`
`'log'`	`LogLocator`	For log-scale axes
`'logminor'`	`LogLocator`	For log-scale axes on the 1st through 9th multiples of each power of the base
`'logit'`	`LogitLocator`	For logit-scale axes
`'logitminor'`	`LogitLocator`	For logit-scale axes with `minor=True` passed to `LogitLocator`
`'maxn'`	`MaxNLocator`	No more than `N` ticks at sensible locations
`'multiple'`	`MultipleLocator`	Ticks every `N` step away from zero
`'symlog'`	`SymmetricalLogLocator`	For symlog-scale axes
`'symlogminor'`	`SymmetricalLogLocator`	For symlog-scale axes on the 1st through 9th multiples of each power of the base
`'theta'`	`ThetaLocator`	Like the base locator but default locations are every `numpy.pi`/8 radians
`'year'`	`YearLocator`	Ticks every `N` years
`'month'`	`MonthLocator`	Ticks every `N` months
`'weekday'`	`WeekdayLocator`	Ticks every `N` weekdays
`'day'`	`DayLocator`	Ticks every `N` days
`'hour'`	`HourLocator`	Ticks every `N` hours
`'minute'`	`MinuteLocator`	Ticks every `N` minutes
`'second'`	`SecondLocator`	Ticks every `N` seconds
`'microsecond'`	`MicrosecondLocator`	Ticks every `N` microseconds
`'lon'`, `'deglon'`	`LongitudeLocator`	Longitude gridlines at sensible decimal locations
`'lat'`, `'deglat'`	`LatitudeLocator`	Latitude gridlines at sensible decimal locations
`'dms'`	`_DegreeLocator`	Gridlines on nice minute and second intervals
`'dmslon'`	`LongitudeLocator`	Longitude gridlines on nice minute and second intervals
`'dmslat'`	`LatitudeLocator`	Latitude gridlines on nice minute and second intervals

Other Parameters

*args, **kwargs – Passed to the Locator class.

Returns

Locator – A Locator instance.