class_docstr: Base class for plots that support selection of their points.
  
  Whenever a selection is made in an :class:`InteractivePlot`, the plot will
  invoke any selection callback(s) registered on it, reporting to its
  listeners the IDs of its selected points.
  
  Conversely, the state of an :class:`InteractivePlot` can be updated by
  external parties by calling its :meth:`select_ids` method.
  
  Args:
      link_type ("samples"): whether this plot is linked to ``"samples"``,
          ``"frames"``, or ``"labels"``
      init_view (None): a :class:`fiftyone.core.collections.SampleCollection`
          defining an initial view from which to derive selection views when
          points are selected in the plot. This view will also be shown when
          the plot is in its default state (no selection)
      label_fields (None): a label field or list of label fields to which
          points in this plot correspond. Only applicable when
          ``link_type == "labels"``
      selection_mode (None): the initial selection mode to use when updating
          connected sessions in response to selections in this plot. See
          :meth:`selection_mode` for details
      init_fcn (None): a function that can be called with ``init_view`` as
          its argument that returns a
          :class:`fiftyone.core.collections.SampleCollection` defining an
          initial view from which to derive certain types of selection views.
          See :meth:`selection_mode` for details
class_docstr_tok: ["Base","class","for","plots","that","support","selection","of","their","points",".","Whenever","a","selection","is","made","in","an",":","class",":","`","InteractivePlot","`",",","the","plot","will","invoke","any","selection","callback","(","s",")","registered","on","it",",","reporting","to","its","listeners","the","IDs","of","its","selected","points",".","Conversely",",","the","state","of","an",":","class",":","`","InteractivePlot","`","can","be","updated","by","external","parties","by","calling","its",":","meth",":","`","select_ids","`","method",".","Args",":","link_type","(","``","samples","''",")",":","whether","this","plot","is","linked","to","``","``","samples","''","``",",","``","``","frames","''","``",",","or","``","``","labels","''","``","init_view","(","None",")",":","a",":","class",":","`","fiftyone.core.collections.SampleCollection","`","defining","an","initial","view","from","which","to","derive","selection","views","when","points","are","selected","in","the","plot",".","This","view","will","also","be","shown","when","the","plot","is","in","its","default","state","(","no","selection",")","label_fields","(","None",")",":","a","label","field","or","list","of","label","fields","to","which","points","in","this","plot","correspond",".","Only","applicable","when","``","link_type","==","``","labels","''","``","selection_mode","(","None",")",":","the","initial","selection","mode","to","use","when","updating","connected","sessions","in","response","to","selections","in","this","plot",".","See",":","meth",":","`","selection_mode","`","for","details","init_fcn","(","None",")",":","a","function","that","can","be","called","with","``","init_view","``","as","its","argument","that","returns","a",":","class",":","`","fiftyone.core.collections.SampleCollection","`","defining","an","initial","view","from","which","to","derive","certain","types","of","selection","views",".","See",":","meth",":","`","selection_mode","`","for","details"]
docstr: The current selection mode of the plot.
  
  This property controls how the current view is updated in response to
  updates from :class:`InteractivePlot` instances that are linked to
  labels or frames.
  
  When ``link_type`` is ``"frames"``, the supported values are:
  
  -   ``"select"``: show video samples with labels only for the selected
      frames
  -   ``"match"``: show unfiltered video samples containing at least one
      selected frame
  -   ``"frames"``: show only the selected frames in a frames view
  
  When ``link_type`` is ``"labels"``, the supported values are:
  
  -   ``"select"``: show only the selected labels
  -   ``"match"``: show unfiltered samples containing at least one
      selected label
  -   ``"patches"``: show the selected labels in a patches view
  
  .. note::
  
      In order to use ``"patches"`` selection mode, you must have
      provided an ``init_fcn`` when constructing this plot that defines
      how to create the base patches view. This usually involves
      :meth:`to_patches() <fiftyone.core.collections.SampleCollection.to_patches>`
      or
      :meth:`to_evaluation_patches() <fiftyone.core.collections.SampleCollection.to_evaluation_patches>`
  
  .. note::
  
      In order to use ``"frames"`` selection mode, you must have
      provided an ``init_fcn`` when constructing this plot that defines
      how to create the base frames view. This usually involves
      :meth:`to_frames() <fiftyone.core.collections.SampleCollection.to_frames>`
docstr_tok: ["The","current","selection","mode","of","the","plot",".","This","property","controls","how","the","current","view","is","updated","in","response","to","updates","from",":","class",":","`","InteractivePlot","`","instances","that","are","linked","to","labels","or","frames",".","When","``","link_type","``","is","``","``","frames","''","``",",","the","supported","values","are",":","-","``","``","select","''","``",":","show","video","samples","with","labels","only","for","the","selected","frames","-","``","``","match","''","``",":","show","unfiltered","video","samples","containing","at","least","one","selected","frame","-","``","``","frames","''","``",":","show","only","the","selected","frames","in","a","frames","view","When","``","link_type","``","is","``","``","labels","''","``",",","the","supported","values","are",":","-","``","``","select","''","``",":","show","only","the","selected","labels","-","``","``","match","''","``",":","show","unfiltered","samples","containing","at","least","one","selected","label","-","``","``","patches","''","``",":","show","the","selected","labels","in","a","patches","view","..","note",":",":","In","order","to","use","``","``","patches","''","``","selection","mode",",","you","must","have","provided","an","``","init_fcn","``","when","constructing","this","plot","that","defines","how","to","create","the","base","patches","view",".","This","usually","involves",":","meth",":","`","to_patches","(",")","<","fiftyone.core.collections.SampleCollection.to_patches",">","`","or",":","meth",":","`","to_evaluation_patches","(",")","<","fiftyone.core.collections.SampleCollection.to_evaluation_patches",">","`","..","note",":",":","In","order","to","use","``","``","frames","''","``","selection","mode",",","you","must","have","provided","an","``","init_fcn","``","when","constructing","this","plot","that","defines","how","to","create","the","base","frames","view",".","This","usually","involves",":","meth",":","`","to_frames","(",")","<","fiftyone.core.collections.SampleCollection.to_frames",">","`"]
code: def selection_mode(self):
      """The current selection mode of the plot.
  
      This property controls how the current view is updated in response to
      updates from :class:`InteractivePlot` instances that are linked to
      labels or frames.
  
      When ``link_type`` is ``"frames"``, the supported values are:
  
      -   ``"select"``: show video samples with labels only for the selected
          frames
      -   ``"match"``: show unfiltered video samples containing at least one
          selected frame
      -   ``"frames"``: show only the selected frames in a frames view
  
      When ``link_type`` is ``"labels"``, the supported values are:
  
      -   ``"select"``: show only the selected labels
      -   ``"match"``: show unfiltered samples containing at least one
          selected label
      -   ``"patches"``: show the selected labels in a patches view
  
      .. note::
  
          In order to use ``"patches"`` selection mode, you must have
          provided an ``init_fcn`` when constructing this plot that defines
          how to create the base patches view. This usually involves
          :meth:`to_patches() <fiftyone.core.collections.SampleCollection.to_patches>`
          or
          :meth:`to_evaluation_patches() <fiftyone.core.collections.SampleCollection.to_evaluation_patches>`
  
      .. note::
  
          In order to use ``"frames"`` selection mode, you must have
          provided an ``init_fcn`` when constructing this plot that defines
          how to create the base frames view. This usually involves
          :meth:`to_frames() <fiftyone.core.collections.SampleCollection.to_frames>`
      """
      return self._selection_mode
  
imports: import logging
  import fiftyone.core.context
  import fiftyone.core.labels
  import fiftyone.core.patches
  import fiftyone.core.video
label_desc: Use image node_id 2 for calling the InteractivePlot obj's underlying member method code with example usage: obj.selection_mode() and returns: self