fiftyone.operators.panel.PanelConfig

class documentation

class PanelConfig(OperatorConfig): (source)

Constructor: PanelConfig(name, label, help_markdown, beta, ...)

View In Hierarchy

Configuration for a panel.

Parameters
namethe name of the panel
labelthe display name for the panel
iconthe icon to show in the panel's tab
light_iconthe icon to show in the panel's tab when the App is in light mode
dark_iconthe icon to show in the panel's tab when the App is in dark mode
allow_multiplewhether to allow multiple instances of the panel to be opened
surfacesthe surfaces on which the panel can be displayed
help_markdowna markdown string to display in the panel's help tooltip
categorythe category id of the panel
prioritythe priority of the panel for sorting in the UI
Method __init__ Undocumented
Method to_json Undocumented
Instance Variable allow_multiple Undocumented
Instance Variable beta Undocumented
Instance Variable category Undocumented
Instance Variable dark_icon Undocumented
Instance Variable help_markdown Undocumented
Instance Variable icon Undocumented
Instance Variable is_new Undocumented
Instance Variable kwargs Undocumented
Instance Variable label Undocumented
Instance Variable light_icon Undocumented
Instance Variable name Undocumented
Instance Variable on_startup Undocumented
Instance Variable priority Undocumented
Instance Variable surfaces Undocumented
Instance Variable unlisted Undocumented

Inherited from OperatorConfig:

Instance Variable allow_delegated_execution Undocumented
Instance Variable allow_immediate_execution Undocumented
Instance Variable default_choice_to_delegated Undocumented
Instance Variable delegation_target Undocumented
Instance Variable description Undocumented
Instance Variable disable_schema_validation Undocumented
Instance Variable dynamic Undocumented
Instance Variable execute_as_generator Undocumented
Instance Variable on_dataset_open Undocumented
Instance Variable resolve_execution_options_on_change Undocumented
def __init__(self, name, label, help_markdown=None, beta=False, is_new=False, category=None, icon=None, light_icon=None, dark_icon=None, allow_multiple=False, surfaces: PANEL_SURFACE = 'grid', priority=None, **kwargs): (source)
overrides fiftyone.operators.operator.OperatorConfig.__init__

Undocumented

def to_json(self): (source)
overrides fiftyone.operators.operator.OperatorConfig.to_json

Undocumented

allow_multiple: False = (source)

Undocumented

beta = (source)

Undocumented

category: Category = (source)

Undocumented

dark_icon: None = (source)
overrides fiftyone.operators.operator.OperatorConfig.dark_icon

Undocumented

help_markdown: None = (source)

Undocumented

icon: None = (source)
overrides fiftyone.operators.operator.OperatorConfig.icon

Undocumented

is_new = (source)

Undocumented

kwargs = (source)
overrides fiftyone.operators.operator.OperatorConfig.kwargs

Undocumented

label = (source)
overrides fiftyone.operators.operator.OperatorConfig.label

Undocumented

light_icon: None = (source)
overrides fiftyone.operators.operator.OperatorConfig.light_icon

Undocumented

name = (source)
overrides fiftyone.operators.operator.OperatorConfig.name

Undocumented

on_startup: bool = (source)
overrides fiftyone.operators.operator.OperatorConfig.on_startup

Undocumented

priority: None = (source)

Undocumented

surfaces: "grid" = (source)

Undocumented

unlisted: bool = (source)
overrides fiftyone.operators.operator.OperatorConfig.unlisted

Undocumented