fiftyone.plugins¶

Hooks¶

useActivePlugins¶

fiftyone.plugins.useActivePlugins(type, ctx)¶

Arguments

type (PluginComponentType) –
ctx (any) –

Return type

Array< fiftyone.plugins.PluginComponentRegistration() < Any > >

A react hook that returns a list of active plugins.

Returns

A list of active plugins

usePlugin¶

fiftyone.plugins.usePlugin(type)¶

Arguments

type (PluginComponentType) –

Return type

Array< fiftyone.plugins.PluginComponentRegistration() >

usePluginSettings¶

fiftyone.plugins.usePluginSettings(pluginName, defaults)¶

Arguments

pluginName (string) –
defaults (Partial < T >) –

Return type

fiftyone.plugins.T()

usePlugins¶

fiftyone.plugins.usePlugins()¶

Return type: Object

A react hook for loading the plugin system.

Functions¶

getByType¶

fiftyone.plugins.getByType(type)¶

Arguments

type (PluginComponentType) –

Return type

Array< any >

Get a list of plugins match the given type.

Returns

A list of plugins

loadPlugins¶

fiftyone.plugins.loadPlugins()¶

Return type: Promise < void > < void >

registerComponent¶

fiftyone.plugins.registerComponent(registration)¶

Arguments

registration (PluginComponentRegistration < T >) –

Return type

void

Adds a plugin to the registry. This is called by the plugin itself.

unregisterComponent¶

fiftyone.plugins.unregisterComponent(name)¶

Arguments

name (string) –

Return type

void

Remove a plugin from the registry.

Types¶

PluginComponentRegistration¶

class fiftyone.plugins.PluginComponentRegistration()¶

A plugin registration.

Properties¶

Name	Type	Description
Icon	`ComponentType < >` `<` `Any` `>`
activator	`fiftyone.plugins.PluginActivator()`	A function that returns true if the plugin should be active
component	`FunctionComponent < PluginComponentProps >` `<` `fiftyone.plugins.PluginComponentProps()` `>`	The React component to render
label	`string`	The optional label of the plugin to display to the user
name	`string`	The name of the plugin
panelOptions	`fiftyone.plugins.PanelOptions()`
type	`fiftyone.plugins.PluginComponentType()`	The plugin type

Enums¶

PluginComponentType¶

The type of plugin component.

Panel - A panel that can be added to @fiftyone/spaces
Plot - deprecated - A plot that can be added as a panel
Visualizer - Visualizes sample data

Name	Value
Panel
Plot
Visualizer