**selector**
=====================================

.. py:module:: optimeed.visualize.selector


.. toctree::
   :titlesonly:
   :maxdepth: 1

   onselectInterface/index.rst
   onselect_highlight/index.rst
   onselect_newTrace/index.rst
   onselect_setcolor/index.rst
   onselect_splitTrace/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   optimeed.visualize.selector.OnselectInterface
   optimeed.visualize.selector.Onselect_highlight
   optimeed.visualize.selector.Onselect_setcolor
   optimeed.visualize.selector.Onselect_newTrace
   optimeed.visualize.selector.Onselect_splitTrace




.. py:class:: OnselectInterface


   .. py:method:: get_name()
      :abstractmethod:

      Get the name of the action

      :return: string


   .. py:method:: selector_updated(selection_name, the_collection, selected_indices, not_selected_indices)
      :abstractmethod:

      Action to perform once the data have been selected
      :param selection_name: name of the selection (deprecated ?)
      :param the_collection: the collection
      :param selected_indices: indices of selected data
      :param not_selected_indices: indices of data NOT selected
      :return: identifier that can later be used with cancel_selector


   .. py:method:: cancel_selector(selection_identifier)
      :abstractmethod:

      Action to perform when data stopped being selected
      :param selection_identifier: identifier that was returned by selector_updated
      :return:



.. py:class:: Onselect_highlight(theLinkDataGraphs, theWgPlot)


   Bases: :py:obj:`optimeed.visualize.selector.onselectInterface.OnselectInterface`

   .. py:method:: selector_updated(selection_name, the_collection, selected_data, not_selected_data)

      Action to perform once the data have been selected

      :param selection_name: name of the selection (deprecated ?)
      :param the_collection: the collection
      :param selected_data: indices of the data selected
      :param not_selected_data: indices of the data not selected
      :return:


   .. py:method:: cancel_selector(selection_identifier)

      Action to perform when data stopped being selected
      :param selection_identifier: identifier that was returned by selector_updated
      :return:


   .. py:method:: get_name()

      Get the name of the action

      :return: string



.. py:class:: Onselect_setcolor(theLinkDataGraphs, theWgPlot, color=(255, 0, 0))


   Bases: :py:obj:`optimeed.visualize.selector.onselectInterface.OnselectInterface`

   .. py:method:: selector_updated(selection_name, the_collection, selected_data, not_selected_data)

      Action to perform once the data have been selected

      :param selection_name: name of the selection (deprecated ?)
      :param the_collection: the collection
      :param selected_data: indices of the data selected
      :param not_selected_data: indices of the data not selected
      :return:


   .. py:method:: cancel_selector(selection_identifier)

      Action to perform when data stopped being selected
      :param selection_identifier: identifier that was returned by selector_updated
      :return:


   .. py:method:: get_name()

      Get the name of the action

      :return: string



.. py:class:: Onselect_newTrace(theLinkDataGraphs)


   Bases: :py:obj:`optimeed.visualize.selector.onselectInterface.OnselectInterface`

   .. py:method:: selector_updated(selection_name, the_collection, selected_data, not_selected_data)

      Action to perform once the data have been selected

      :param selection_name: name of the selection (deprecated ?)
      :param the_collection: the collection
      :param selected_data: indices of the data selected
      :param not_selected_data: indices of the data not selected
      :return: identifier that can later be used with cancel_selector


   .. py:method:: cancel_selector(selection_identifier)

      Action to perform when data stopped being selected
      :param selection_identifier: identifier that was returned by selector_updated
      :return:


   .. py:method:: get_name()

      Get the name of the action

      :return: string



.. py:class:: Onselect_splitTrace(theLinkDataGraphs)


   Bases: :py:obj:`optimeed.visualize.selector.onselectInterface.OnselectInterface`

   .. py:method:: selector_updated(selection_name, the_collection, selected_data, not_selected_data)

      Action to perform once the data have been selected

      :param selection_name: name of the selection (deprecated ?)
      :param the_collection: the collection
      :param selected_data: indices of the data selected
      :param not_selected_data: indices of the data not selected
      :return: identifier that can later be used with cancel_selector


   .. py:method:: cancel_selector(selection_identifiers)

      Action to perform when data stopped being selected
      :param selection_identifier: identifier that was returned by selector_updated
      :return:


   .. py:method:: get_name()

      Get the name of the action

      :return: string