.. _api.Ruler:

Ruler
*****

=====
Ruler
=====
.. currentmodule:: fastplotlib.axes

Constructor
~~~~~~~~~~~
.. autosummary::
    :toctree: Ruler_api

    Ruler

Properties
~~~~~~~~~~
.. autosummary::
    :toctree: Ruler_api

    Ruler.cast_shadow
    Ruler.children
    Ruler.color
    Ruler.end_pos
    Ruler.end_value
    Ruler.geometry
    Ruler.id
    Ruler.label
    Ruler.line
    Ruler.line_width
    Ruler.material
    Ruler.min_tick_distance
    Ruler.nonlinear_transform
    Ruler.parent
    Ruler.points
    Ruler.receive_shadow
    Ruler.render_mask
    Ruler.render_order
    Ruler.start_pos
    Ruler.start_value
    Ruler.text
    Ruler.tick_format
    Ruler.tick_marker
    Ruler.tick_side
    Ruler.tick_size
    Ruler.ticks
    Ruler.ticks_at_end_points
    Ruler.up
    Ruler.visible

Methods
~~~~~~~
.. autosummary::
    :toctree: Ruler_api

    Ruler.add
    Ruler.add_event_handler
    Ruler.clear
    Ruler.get_bounding_box
    Ruler.get_bounding_sphere
    Ruler.get_geometry_bounding_box
    Ruler.get_world_bounding_box
    Ruler.get_world_bounding_sphere
    Ruler.handle_event
    Ruler.iter
    Ruler.look_at
    Ruler.release_pointer_capture
    Ruler.remove
    Ruler.remove_event_handler
    Ruler.set_pointer_capture
    Ruler.traverse
    Ruler.update