fiftyone.core.plots.base.ViewPlot

class documentation

class ViewPlot(ResponsivePlot): (source)

Known subclasses: fiftyone.core.plots.views.PlotlyViewPlot

Constructor: ViewPlot(init_view)

View In Hierarchy

Base class for plots that can be automatically populated given a fiftyone.core.collections.SampleCollection instance.

The state of ViewPlot instances can also be updated by external parties by calling its update_view method.

Parameters
init_viewan initial fiftyone.core.collections.SampleCollection to load
Method __init__ Undocumented
Method reset Resets the plot to its default state.
Method update_view Updates the plot based on the provided view.
Instance Variable init_view Undocumented
Property supports_session_updates Whether this plot supports automatic updates in response to session changes.
Method _get_aggregations Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.
Method _update_view Undocumented

Inherited from ResponsivePlot:

Method connect Connects this plot, if necessary.
Method disconnect Disconnects the plot, if necessary.
Method freeze Freezes the plot, replacing it with a static image.
Method show Shows the plot.
Property is_connected Whether this plot is currently connected.
Property is_disconnected Whether this plot is currently disconnected.
Property is_frozen Whether this plot is currently frozen.
Property link_type The link type between this plot and a connected session.
Method _connect Undocumented
Method _disconnect Undocumented
Method _freeze Undocumented
Method _reopen Undocumented
Method _show Undocumented
Instance Variable _connected Undocumented
Instance Variable _disconnected Undocumented
Instance Variable _frozen Undocumented
Instance Variable _link_type Undocumented

Inherited from Plot (via ResponsivePlot):

Method save Saves the plot.
Method _repr_pretty_ Undocumented
def __init__(self, init_view=None): (source)
overrides fiftyone.core.plots.base.ResponsivePlot.__init__
overridden in fiftyone.core.plots.views.PlotlyViewPlot

Undocumented

def reset(self): (source)
overrides fiftyone.core.plots.base.ResponsivePlot.reset

Resets the plot to its default state.

def update_view(self, view, agg_results=None): (source)

Updates the plot based on the provided view.

Parameters
viewa fiftyone.core.collections.SampleCollection
agg_results:Nonea list of pre-computed aggregation results
init_view: None = (source)
overridden in fiftyone.core.plots.views.PlotlyViewPlot

Undocumented

@property
supports_session_updates = (source)
overrides fiftyone.core.plots.base.ResponsivePlot.supports_session_updates

Whether this plot supports automatic updates in response to session changes.

def _get_aggregations(self): (source)
overridden in fiftyone.core.plots.views.CategoricalHistogram, fiftyone.core.plots.views.NumericalHistogram, fiftyone.core.plots.views.ViewGrid

Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.

Subclasses are not required to implement this method if they do not leverage aggregations.

Returns
a list fiftyone.core.aggregations.Aggregation instances, or None
def _update_view(self, view, agg_results=None): (source)
overridden in fiftyone.core.plots.views.PlotlyViewPlot

Undocumented