====
Keys
====

.. automodule:: anyplotlib.keys
   :no-members:
   :no-undoc-members:

.. currentmodule:: anyplotlib.keys

.. rubric:: Classes

.. autosummary::
   :nosignatures:

   KeyOverlay

.. rubric:: Full Reference

.. autoclass:: anyplotlib.keys.KeyOverlay
   :members:
   :show-inheritance:
   :member-order: bysource

.. rubric:: Creating a key

Keys are created from a panel, not constructed directly:

.. automethod:: anyplotlib._base_plot._BasePlot.add_key
   :no-index:

.. automethod:: anyplotlib._base_plot._BasePlot.get_key
   :no-index:

.. automethod:: anyplotlib._base_plot._BasePlot.remove_key
   :no-index:

.. automethod:: anyplotlib._base_plot._BasePlot.list_keys
   :no-index:

.. automethod:: anyplotlib._base_plot._BasePlot.clear_keys
   :no-index: