Skip to content

selectors_api.md

Latest commit

 

History

History
290 lines (170 loc) · 5.2 KB

selectors_api.md

File metadata and controls

290 lines (170 loc) · 5.2 KB

Selectors

.. currentmodule:: biaplotter.selectors

.. autoclass:: Selector
   :show-inheritance:  

   .. rubric:: Properties Summary

   .. autosummary::

      ~Selector.data

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Selector.ax

   .. rubric:: Methods Summary

   .. autosummary::

      ~Selector.create_selector
      ~Selector.on_select
      ~Selector.remove

   .. rubric:: Properties Documentation

   .. autoattribute:: data

   .. rubric:: Attributes Documentation

   .. autoattribute:: ax

   .. rubric:: Methods Documentation

   .. automethod:: create_selector
   .. automethod:: on_select
   .. automethod:: remove

.. autoclass:: BaseRectangleSelector
   :show-inheritance:  

   .. rubric:: Properties Summary

   .. autosummary::

      ~BaseRectangleSelector.data

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Selector.ax
      ~BaseRectangleSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~BaseRectangleSelector.create_selector
      ~BaseRectangleSelector.on_select
      ~Selector.remove

   .. rubric:: Properties Documentation

   .. autoattribute:: data

   .. rubric:: Attributes Documentation

   .. autoattribute:: ax
   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: create_selector
   .. automethod:: on_select
   .. automethod:: remove

.. autoclass:: BaseEllipseSelector
   :show-inheritance:  

   .. rubric:: Properties Summary

   .. autosummary::

      ~BaseEllipseSelector.data

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Selector.ax
      ~BaseEllipseSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~BaseEllipseSelector.create_selector
      ~BaseEllipseSelector.on_select
      ~Selector.remove

   .. rubric:: Properties Documentation

   .. autoattribute:: data

   .. rubric:: Attributes Documentation

   .. autoattribute:: ax
   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: create_selector
   .. automethod:: on_select
   .. automethod:: remove

.. autoclass:: BaseLassoSelector
   :show-inheritance:  

   .. rubric:: Properties Summary

   .. autosummary::

      ~BaseLassoSelector.data

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Selector.ax
      ~BaseLassoSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~BaseLassoSelector.create_selector
      ~BaseLassoSelector.on_select
      ~Selector.remove

   .. rubric:: Properties Documentation

   .. autoattribute:: data

   .. rubric:: Attributes Documentation

   .. autoattribute:: ax
   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: create_selector
   .. automethod:: on_select
   .. automethod:: remove

.. autoclass:: Interactive
   :show-inheritance:  

   .. rubric:: Properties Summary

   .. autosummary::

      ~Interactive.active_artist
      ~Interactive.class_value
      ~Selector.data
      ~Interactive.selected_indices

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Interactive.canvas_widget

   .. rubric:: Methods Summary

   .. autosummary::

      ~Interactive.apply_selection
      ~Interactive.create_selector
      ~Interactive.on_button_press
      ~Interactive.remove

   .. rubric:: Slots Methods Summary

   .. autosummary::

      ~Interactive.update_active_artist
      ~Interactive.update_class_value
      ~Interactive.update_data

   .. rubric:: Properties Documentation

   .. autoattribute:: active_artist
   .. autoattribute:: class_value
   .. autoattribute:: data
   .. autoattribute:: selected_indices

   .. rubric:: Attributes Documentation

   .. autoattribute:: canvas_widget

   .. rubric:: Methods Documentation

   .. automethod:: apply_selection
   .. automethod:: create_selector
   .. automethod:: on_button_press
   .. automethod:: remove

   .. rubric:: Signals Documentation

   .. autoattribute:: selection_applied_signal

   .. rubric:: Slots Methods Documentation

   .. automethod:: update_active_artist
   .. automethod:: update_class_value
   .. automethod:: update_data

.. autoclass:: InteractiveRectangleSelector
   :show-inheritance:  

   .. rubric:: Attributes Summary

   .. autosummary::

      ~InteractiveRectangleSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~InteractiveRectangleSelector.on_select

   .. rubric:: Attributes Documentation

   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: on_select

.. autoclass:: InteractiveEllipseSelector
   :show-inheritance:  

   .. rubric:: Attributes Summary

   .. autosummary::

      ~InteractiveEllipseSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~InteractiveEllipseSelector.on_select

   .. rubric:: Attributes Documentation

   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: on_select

.. autoclass:: InteractiveLassoSelector
   :show-inheritance:  

   .. rubric:: Attributes Summary

   .. autosummary::

      ~InteractiveLassoSelector.name

   .. rubric:: Methods Summary

   .. autosummary::

      ~InteractiveLassoSelector.on_select

   .. rubric:: Attributes Documentation

   .. autoattribute:: name

   .. rubric:: Methods Documentation

   .. automethod:: on_select