mpl.axis.Tick¶
-
class
mpl.axis.Tick(axes, loc, label, size=None, width=None, color=None, tickdir=None, pad=None, labelsize=None, labelcolor=None, zorder=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True)[source]¶ Abstract base class for the axis ticks, grid lines and labels
1 refers to the bottom of the plot for xticks and the left for yticks 2 refers to the top of the plot for xticks and the right for yticks
Publicly accessible attributes:
tick1line- a Line2D instance
tick2line- a Line2D instance
gridline- a Line2D instance
label1- a Text instance
label2- a Text instance
gridOn- a boolean which determines whether to draw the tickline
tick1On- a boolean which determines whether to draw the 1st tickline
tick2On- a boolean which determines whether to draw the 2nd tickline
label1On- a boolean which determines whether to draw tick label
label2On- a boolean which determines whether to draw tick label
-
__init__(axes, loc, label, size=None, width=None, color=None, tickdir=None, pad=None, labelsize=None, labelcolor=None, zorder=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True)[source]¶ bbox is the Bound2D bounding box in display coords of the Axes loc is the tick location in data coords size is the tick size in points
Methods¶
__init__(axes, loc, label[, size, width, ...]) |
bbox is the Bound2D bounding box in display coords of the Axes |
add_callback(func) |
Adds a callback function that will be called whenever one of the Artist‘s properties changes. |
apply_tickdir(tickdir) |
Calculate self._pad and self._tickmarkers |
contains(mouseevent) |
Test whether the mouse event occurred in the Tick marks. |
convert_xunits(x) |
For artists in an axes, if the xaxis has units support, |
convert_yunits(y) |
For artists in an axes, if the yaxis has units support, |
draw(artist, renderer, *args, **kwargs) |
|
findobj([match, include_self]) |
Find artist objects. |
format_cursor_data(data) |
Return cursor data string formatted. |
get_agg_filter() |
return filter function to be used for agg filter |
get_alpha() |
Return the alpha value used for blending - not supported on all |
get_animated() |
Return the artist’s animated state |
get_axes() |
Return the Axes instance the artist resides in, or None. |
get_children() |
|
get_clip_box() |
Return artist clipbox |
get_clip_on() |
Return whether artist uses clipping |
get_clip_path() |
Return artist clip path |
get_contains() |
Return the _contains test used by the artist, or None for default. |
get_cursor_data(event) |
Get the cursor data for a given event. |
get_figure() |
Return the Figure instance the artist belongs to. |
get_gid() |
Returns the group id |
get_label() |
Get the label used for this artist in the legend. |
get_loc() |
Return the tick location (data coords) as a scalar |
get_pad() |
Get the value of the tick label pad in points |
get_pad_pixels() |
|
get_path_effects() |
|
get_picker() |
Return the picker object used by this artist |
get_rasterized() |
return True if the artist is to be rasterized |
get_sketch_params() |
Returns the sketch parameters for the artist. |
get_snap() |
Returns the snap setting which may be: |
get_transform() |
Return the Transform instance used by this artist. |
get_transformed_clip_path_and_affine() |
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation. |
get_url() |
Returns the url |
get_view_interval() |
return the view Interval instance for the axis this tick is ticking |
get_visible() |
Return the artist’s visiblity |
get_window_extent(renderer) |
Get the axes bounding box in display space. |
get_zorder() |
Return the Artist‘s zorder. |
have_units() |
Return True if units are set on the x or y axes |
hitlist(event) |
List the children of the artist which contain the mouse event event. |
is_figure_set() |
Returns True if the artist is assigned to a Figure. |
is_transform_set() |
Returns True if Artist has a transform explicitly set. |
pchanged() |
Fire an event when property changed, calling all of the registered callbacks. |
pick(mouseevent) |
call signature: |
pickable() |
Return True if Artist is pickable. |
properties() |
return a dictionary mapping property name -> value for all Artist props |
remove() |
Remove the artist from the figure if possible. |
remove_callback(oid) |
Remove a callback based on its id. |
set(**kwargs) |
A property batch setter. |
set_agg_filter(filter_func) |
set agg_filter fuction. |
set_alpha(alpha) |
Set the alpha value used for blending - not supported on all backends. |
set_animated(b) |
Set the artist’s animation state. |
set_axes(axes) |
Set the Axes instance in which the artist resides, if any. |
set_clip_box(clipbox) |
Set the artist’s clip Bbox. |
set_clip_on(b) |
Set whether artist uses clipping. |
set_clip_path(clippath[, transform]) |
Set the artist’s clip path, which may be: |
set_contains(picker) |
Replace the contains test used by this artist. |
set_figure(fig) |
Set the Figure instance the artist belongs to. |
set_gid(gid) |
Sets the (group) id for the artist |
set_label(s) |
Set the text of ticklabel |
set_label1(s) |
Set the text of ticklabel |
set_label2(s) |
Set the text of ticklabel2 |
set_pad(val) |
Set the tick label pad in points |
set_path_effects(path_effects) |
set path_effects, which should be a list of instances of |
set_picker(picker) |
Set the epsilon for picking used by this artist |
set_rasterized(rasterized) |
Force rasterized (bitmap) drawing in vector backend output. |
set_sketch_params([scale, length, randomness]) |
Sets the sketch parameters. |
set_snap(snap) |
Sets the snap setting which may be: |
set_transform(t) |
Set the Transform instance used by this artist. |
set_url(url) |
Sets the url for the artist |
set_visible(b) |
Set the artist’s visiblity. |
set_zorder(level) |
Set the zorder for the artist. |
update(props) |
Update the properties of this Artist from the dictionary prop. |
update_from(other) |
Copy properties from other to self. |