fiftyone.operators.types<a class="headerlink" href="#module-fiftyone.operators.types" title="Link to this heading">#

Converts the object definition to JSON / python dict.

operator_uri: str#: The URI of the operator to use for the stage

always_run: bool = False#: Whether the stage should always run regardless of failures in previous stages of the pipeline

name: str | None = None#: The optional name of the stage

num_distributed_tasks: int | None = None#: The number of distributed tasks to split the stage into

params: Mapping[str, Any] | None = None#: Optional dict of parameters to pass to the operator

to_json()#

Converts the object definition to JSON / python dict.

Returns:: a JSON / python dict

fiftyone.operators.types.dedent(text)#

Remove any common leading whitespace from every line in text.

This can be used to make triple-quoted strings line up with the left edge of the display, while still presenting them in the source code in indented form.

Note that tabs and spaces are both treated as whitespace, but they are not equal: the lines “ hello” and “thello” are considered to have no common leading whitespace.

Entirely blank lines are normalized to a newline character.

class fiftyone.operators.types.BaseType#

Bases: object

Base class for all types.

Methods:

to_json()#

class fiftyone.operators.types.Void#

Bases: BaseType

Represents a void type.

Methods:

to_json()#

class fiftyone.operators.types.Object(root_view=None)#

Bases: BaseType

Represents a JSON object.

Parameters:: root_view (None) – the View used to display the object

Methods:

`add_property`(name, property)	Adds a property to the object.
`get_property`(name)	Gets a property by name.
`define_property`(name, type, **kwargs)	Defines a property on the object.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`int`(name[, min, max])	Defines a property on the object that is an integer.
`float`(name[, min, max])	Defines a property on the object that is a float.
`enum`(name, values, **kwargs)	Defines a property on the object that is an enum.
`list`(name, element_type[, min_items, max_items])	Defines a property on the object that is a list.
`obj`(name, **kwargs)	Defines a property on the object that is an object.
`file`(name, **kwargs)	Defines a property on the object that is a file.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`view`(name, view, **kwargs)	Defines a view-only property.
`btn`(name, label[, icon, variant, disabled, ...])	Defines a button or icon button to display to the user as a `Button`.
`img`(name[, href, on_click, prompt, params, ...])	Defines an image to display to the user as a `ImageView`.
`message`(name, label, **kwargs)	Defines a message to display to the user as a `Notice`.
`grid`(name, **kwargs)	Defines a grid view as a `View`.
`dashboard`(name, **kwargs)	Defines a dashboard view as a `View`.
`plot`(name, **kwargs)	Defines an object property displayed as a plot.
`h_stack`(name, **kwargs)	Defines a horizontal stack object.
`v_stack`(name, **kwargs)	Defines a vertical stack object.
`menu`(name, **kwargs)	Defined an `Object` property that is displayed as a menu.
`btn_group`(name, **kwargs)	Defines a button group object.
`md`(markdown[, name])	Defines a markdown object.
`media_player`(name, url, **kwargs)	Defines a media player object.
`arrow_nav`(name[, forward, backward, position])	Defines a floating navigation arrows as a `ArrowNavView`.
`map`(name, key_type, value_type, **kwargs)	Defines a map property on the object.
`oneof`(name, types, **kwargs)	Defines a one-of property on the object.
`tuple`(name, items, *kwargs)	Defines a tuple property on the object.
`tree`(name, **kwargs)	Defines a tree property on the object.
`clone`()	Clones the definition of the object.
`view_target`(ctx[, name, view_type, ...])	Defines a view target input property.
`target_view`(ctx[, name, view_type, ...])	Defines a view target input property.
`to_json`()	Converts the object definition to JSON.

add_property(name, property)#

Adds a property to the object.

Parameters:

name – the name of the property
property – the property to add

Returns:

the Property that was added

get_property(name)#

Gets a property by name.

Parameters:: name – the name of the property
Returns:: the Property, or None

define_property(name, type, **kwargs)#

Defines a property on the object.

Parameters:

name – the name of the property
type – the type of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

the Property that was added

str(name, allow_empty=False, **kwargs)#

Defines a property on the object that is a string.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

bool(name, **kwargs)#

Defines a property on the object that is a boolean.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

int(name, min=None, max=None, **kwargs)#

Defines a property on the object that is an integer.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

float(name, min=None, max=None, **kwargs)#

Defines a property on the object that is a float.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

enum(name, values, **kwargs)#

Defines a property on the object that is an enum.

Parameters:

name – the name of the property
values – a list of values that define the enum
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property, which must be a Choices or a subclass of it

Returns:

list(name, element_type, min_items=None, max_items=None, **kwargs)#

Defines a property on the object that is a list.

Parameters:

name – the name of the property
element_type – the type of the elements in the list
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

obj(name, **kwargs)#

Defines a property on the object that is an object.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

file(name, **kwargs)#

Defines a property on the object that is a file.

Parameters:

name – the name of the property
view (None) – the View of the property

uploaded_file(name, **kwargs)#

Defines a property on the object that is an uploaded file.

Parameters:

name – the name of the property
view (None) – the View of the property
lite (False) – whether to use the lite version of the file. When True, the content of the file in not included in resolve_input params, only the metadata is included.

view(name, view, **kwargs)#

Defines a view-only property.

Examples:

import fiftyone.operators.types as types

notice = types.Notice(label="a label", description="a description")
inputs = types.Object()
inputs.view("notice", notice)

Parameters:

name – the name of the property
view – the View to define

Returns:

btn(name, label, icon=None, variant=None, disabled=False, on_click=None, prompt=False, params=None, space=None, href=None, icon_position='left', **kwargs)#

Defines a button or icon button to display to the user as a Button.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.btn(
    "greet",
    label="Say Hi!",
    icon="waving_hand",
    variant="round",
    on_click="print_stdout",
    params={"msg": "Hi!"},
)

Parameters:

name – the name of the property
label – the label of the button
icon (None) – the name of the icon to display
icon_position ("left") – the position of the icon. Can be "left" or "right"
disabled (False) – whether the button is disabled
variant (None) – the variant of the button. Can be "contained", "outlined", "round" or "square"
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
space (None) – An int specifying how much vertical/horizontal space to allocate out of 12 depending on the orientation of the parent container
href (None) – the URL to navigate to when the button is clicked

img(name, href=None, on_click=None, prompt=False, params=None, point_on_hover=True, height=None, width=None, alt_text=None, **kwargs)#

Defines an image to display to the user as a ImageView.

Examples:

import fiftyone.operators.types as types
ctx.panel.state.my_img = "/path/to/my/image.jpg"

panel = types.Object()
panel.img(
    "my_img", # uses the value in ctx.panel.state.my_img
    href="https://path/to/navigate/to",
    on_click=self.do_something,
    prompt=False,
    params={"foo": "bar"},
    point_on_hover=True,
    height="100px",
    width="100px",
    alt_text="My image alt text"
)

Parameters:

name – the name of the state variable to use as the image source
href (None) – the url to navigate to when the image is clicked
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
point_on_hover (True) – whether to show a pointer when hovering over the image
height (None) – the height of the image
width (None) – the width of the image
alt_text (None) – the alt text of the image

message(name, label, **kwargs)#

Defines a message to display to the user as a Notice.

Parameters:

name – the name of the property
label – the label of the notice
description (None) – the description of the notice
view (None) – the View of the notice

Returns:

grid(name, **kwargs)#: Defines a grid view as a View.

dashboard(name, **kwargs)#

Defines a dashboard view as a View.

See DashboardView for more information.

Parameters:: name – the name of the property
Returns:: an Object

See DashboardView for more information.

plot(name, **kwargs)#

Defines an object property displayed as a plot.

Parameters:

name – the name of the property
config (None) – the chart config
layout (None) – the chart layout

See PlotlyView for more information.

h_stack(name, **kwargs)#

Defines a horizontal stack object.

Parameters:: name – the name of the property
Returns:: a Object

v_stack(name, **kwargs)#

Defines a vertical stack object.

Parameters:: name – the name of the property
Returns:: a Object

menu(name, **kwargs)#

Defined an Object property that is displayed as a menu.

Note

Can be used for an Button type with properties whose views are one of Button, Dropdown, DropdownView, and :class;`Choices`. The variant and color of the items can be set using the variant and color parameters.

Parameters:

name – the name of the property
variant (None) – the variant for the items of the menu. Can be "contained", "outlined", "round" or "square"
color (None) – the color for the items of the menu.
overlay (None) – whether to display the menu as an overlay. Can be "top-left",
"top-center"
"top-right"
"bottom-left"
"bottom-center"`
or
of ("bottom-right". Overlay is useful when you want to display a floating menu on top)
content (another)
icon (None) – when set, the icon will be displayed as the menu button instead of the label.
"SettingsIcon" (Can be)
"MoreVertIcon".

Returns:

btn_group(name, **kwargs)#

Defines a button group object.

Parameters:: name – the name of the property
Returns:: a Object

md(markdown, name='markdown', **kwargs)#

Defines a markdown object.

Parameters:

markdown – the markdown to display
name – the name of the property

media_player(name, url, **kwargs)#

Defines a media player object.

Parameters:

name – the name of the property
url – the URL of the media to display
on_start (None) – the operator to execute when the media starts
on_play (None) – the operator to execute when the media is played
on_pause (None) – the operator to execute when the media is paused
on_buffer (None) – the operator to execute when the media is buffering
on_buffer_end (None) – the operator to execute when the media stops buffering
on_ended (None) – the operator to execute when the media ends
on_error (None) – the operator to execute when the media errors
on_duration (None) – the operator to execute when the media duration is loaded
on_seek (None) – the operator to execute when the media is seeked
on_progress (None) – the operator to execute when the media progresses

Returns:

arrow_nav(name, forward=None, backward=None, position=None, **kwargs)#

Defines a floating navigation arrows as a ArrowNavView.

Parameters:

forward (True) – Whether to display the forward arrow
backward (True) – Whether to display the backward arrow
on_forward (None) – The operator to execute when the forward arrow is clicked
on_backward (None) – The operator to execute when the backward arrow is clicked
position ("center") – The position of the arrows. Can be either "top", center, "bottom", "left", middle` (center horizontally), or ``"right"

Returns:

map(name, key_type, value_type, **kwargs)#

Defines a map property on the object.

Parameters:

name – the name of the property
key_type – the type of the keys in the map
value_type – the type of the values in the map

Returns:

a Map

oneof(name, types, **kwargs)#

Defines a one-of property on the object.

Parameters:

name – the name of the property
types – list of types that are instances of BaseType

Returns:

a OneOf

tuple(name, *items, **kwargs)#

Defines a tuple property on the object.

Parameters:

name – the name of the property
*items – the types of the items in the tuple

Returns:

a Tuple

tree(name, **kwargs)#

Defines a tree property on the object.

Parameters:: name – the name of the property
Returns:: a Tree

clone()#

Clones the definition of the object.

Parameters:: name – the name of the property
Returns:: an Object

view_target(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

target_view(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

to_json()#

Converts the object definition to JSON.

Returns:: a JSON dict

class fiftyone.operators.types.Property(type, **kwargs)#

Bases: BaseType

Represents a property on an fiftyone.operators.Operator.

Properties are used to define the data that an operator can accept as input and return as output.

Properties may also define a View that can be used to customize how the property behaves in the FiftyOne App.

Examples:

import fiftyone.operators.types as types

my_object = types.Object()

# Define a string property
my_object.str("name", label="Name", description="a description")

# Define an enum property with a custom view
radio_group = types.RadioGroup()
radio_group.add_choice("car", "A brand new car")
radio_group.add_choice("truck", "A fancy truck")
my_object.enum("type", radio_group.values(), view=radio_group)

Parameters:

type – the type of the property
invalid (False) – whether the property is invalid
default (None) – the default value of the property
required (False) – whether the property is required
error_message ("Invalid") – the error message of the property
view (None) – the View of the property

Methods:

to_json()#

class fiftyone.operators.types.String(allow_empty=False)#

Bases: BaseType

Represents a string.

Parameters:: allow_empty (False) – allow an empty string value

Methods:

to_json()#

class fiftyone.operators.types.Boolean#

Bases: BaseType

Represents a boolean.

Methods:

to_json()#

class fiftyone.operators.types.Number(min=None, max=None, int=False, float=False)#

Bases: BaseType

Represents a number.

Parameters:

min (None) – the minimum value of the Number
max (None) – the maximum value of the Number
int (False) – whether the number is an integer
float (False) – whether the number is a float

Methods:

to_json()#

class fiftyone.operators.types.List(element_type, min_items=None, max_items=None)#

Bases: BaseType

Represents a list.

Parameters:

element_type – the type of the elements in the list
min_items (None) – the minimum number of items in the list
max_items (None) – the maximum number of items in the list

Methods:

to_json()#

class fiftyone.operators.types.SampleID#

Bases: String

Represents a fiftyone.core.samples.Sample ID.

Methods:

to_json()#

class fiftyone.operators.types.Enum(values)#

Bases: BaseType

Represents an enum.

Parameters:: values – the values of the enum

Methods:

to_json()#

class fiftyone.operators.types.OneOf(types)#

Bases: BaseType

Represents a one-of type.

Examples:

import fiftyone.operators.types as types

my_object = types.Object()
my_object.define_property(
    "my_property",
    types.OneOf([types.String(), types.Number()],
)

Parameters:: types – the possible types

Methods:

to_json()#

class fiftyone.operators.types.Tuple(*items)#

Bases: BaseType

Represents a tuple of types.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.define_property(
    "image", types.Tuple(types.String(), types.Number())
)

Parameters:: *items – the types

Methods:

to_json()#

class fiftyone.operators.types.Tree(*items)#

Bases: BaseType

Represents a tree selection type.

Examples:

import fiftyone.operators.types as types
inputs = types.Object()

Parameters:: *items – the tree structure of items

Methods:

to_json()#

class fiftyone.operators.types.Map(key_type, value_type)#

Bases: BaseType

Represents a map.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.define_property(
    "image", types.Map(types.String(), types.Number())
)

Parameters:

key_type – the type of the keys in the Map
value_type – the type of the values in the Map

Methods:

to_json()#

class fiftyone.operators.types.File(**kwargs)#

Bases: Object

Represents a file and related metadata for use with FileExplorerView.

Methods:

`add_property`(name, property)	Adds a property to the object.
`arrow_nav`(name[, forward, backward, position])	Defines a floating navigation arrows as a `ArrowNavView`.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`btn`(name, label[, icon, variant, disabled, ...])	Defines a button or icon button to display to the user as a `Button`.
`btn_group`(name, **kwargs)	Defines a button group object.
`clone`()	Clones the definition of the object.
`dashboard`(name, **kwargs)	Defines a dashboard view as a `View`.
`define_property`(name, type, **kwargs)	Defines a property on the object.
`enum`(name, values, **kwargs)	Defines a property on the object that is an enum.
`file`(name, **kwargs)	Defines a property on the object that is a file.
`float`(name[, min, max])	Defines a property on the object that is a float.
`get_property`(name)	Gets a property by name.
`grid`(name, **kwargs)	Defines a grid view as a `View`.
`h_stack`(name, **kwargs)	Defines a horizontal stack object.
`img`(name[, href, on_click, prompt, params, ...])	Defines an image to display to the user as a `ImageView`.
`int`(name[, min, max])	Defines a property on the object that is an integer.
`list`(name, element_type[, min_items, max_items])	Defines a property on the object that is a list.
`map`(name, key_type, value_type, **kwargs)	Defines a map property on the object.
`md`(markdown[, name])	Defines a markdown object.
`media_player`(name, url, **kwargs)	Defines a media player object.
`menu`(name, **kwargs)	Defined an `Object` property that is displayed as a menu.
`message`(name, label, **kwargs)	Defines a message to display to the user as a `Notice`.
`obj`(name, **kwargs)	Defines a property on the object that is an object.
`oneof`(name, types, **kwargs)	Defines a one-of property on the object.
`plot`(name, **kwargs)	Defines an object property displayed as a plot.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`target_view`(ctx[, name, view_type, ...])	Defines a view target input property.
`to_json`()	Converts the object definition to JSON.
`tree`(name, **kwargs)	Defines a tree property on the object.
`tuple`(name, items, *kwargs)	Defines a tuple property on the object.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`v_stack`(name, **kwargs)	Defines a vertical stack object.
`view`(name, view, **kwargs)	Defines a view-only property.
`view_target`(ctx[, name, view_type, ...])	Defines a view target input property.

add_property(name, property)#

Adds a property to the object.

Parameters:

name – the name of the property
property – the property to add

Returns:

the Property that was added

arrow_nav(name, forward=None, backward=None, position=None, **kwargs)#

Defines a floating navigation arrows as a ArrowNavView.

Parameters:

forward (True) – Whether to display the forward arrow
backward (True) – Whether to display the backward arrow
on_forward (None) – The operator to execute when the forward arrow is clicked
on_backward (None) – The operator to execute when the backward arrow is clicked
position ("center") – The position of the arrows. Can be either "top", center, "bottom", "left", middle` (center horizontally), or ``"right"

Returns:

bool(name, **kwargs)#

Defines a property on the object that is a boolean.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

btn(name, label, icon=None, variant=None, disabled=False, on_click=None, prompt=False, params=None, space=None, href=None, icon_position='left', **kwargs)#

Defines a button or icon button to display to the user as a Button.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.btn(
    "greet",
    label="Say Hi!",
    icon="waving_hand",
    variant="round",
    on_click="print_stdout",
    params={"msg": "Hi!"},
)

Parameters:

name – the name of the property
label – the label of the button
icon (None) – the name of the icon to display
icon_position ("left") – the position of the icon. Can be "left" or "right"
disabled (False) – whether the button is disabled
variant (None) – the variant of the button. Can be "contained", "outlined", "round" or "square"
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
space (None) – An int specifying how much vertical/horizontal space to allocate out of 12 depending on the orientation of the parent container
href (None) – the URL to navigate to when the button is clicked

btn_group(name, **kwargs)#

Defines a button group object.

Parameters:: name – the name of the property
Returns:: a Object

clone()#

Clones the definition of the object.

Parameters:: name – the name of the property
Returns:: an Object

dashboard(name, **kwargs)#

Defines a dashboard view as a View.

See DashboardView for more information.

Parameters:: name – the name of the property
Returns:: an Object

See DashboardView for more information.

define_property(name, type, **kwargs)#

Defines a property on the object.

Parameters:

name – the name of the property
type – the type of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

the Property that was added

enum(name, values, **kwargs)#

Defines a property on the object that is an enum.

Parameters:

name – the name of the property
values – a list of values that define the enum
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property, which must be a Choices or a subclass of it

Returns:

file(name, **kwargs)#

Defines a property on the object that is a file.

Parameters:

name – the name of the property
view (None) – the View of the property

float(name, min=None, max=None, **kwargs)#

Defines a property on the object that is a float.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

get_property(name)#

Gets a property by name.

Parameters:: name – the name of the property
Returns:: the Property, or None

grid(name, **kwargs)#: Defines a grid view as a View.

h_stack(name, **kwargs)#

Defines a horizontal stack object.

Parameters:: name – the name of the property
Returns:: a Object

img(name, href=None, on_click=None, prompt=False, params=None, point_on_hover=True, height=None, width=None, alt_text=None, **kwargs)#

Defines an image to display to the user as a ImageView.

Examples:

import fiftyone.operators.types as types
ctx.panel.state.my_img = "/path/to/my/image.jpg"

panel = types.Object()
panel.img(
    "my_img", # uses the value in ctx.panel.state.my_img
    href="https://path/to/navigate/to",
    on_click=self.do_something,
    prompt=False,
    params={"foo": "bar"},
    point_on_hover=True,
    height="100px",
    width="100px",
    alt_text="My image alt text"
)

Parameters:

name – the name of the state variable to use as the image source
href (None) – the url to navigate to when the image is clicked
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
point_on_hover (True) – whether to show a pointer when hovering over the image
height (None) – the height of the image
width (None) – the width of the image
alt_text (None) – the alt text of the image

int(name, min=None, max=None, **kwargs)#

Defines a property on the object that is an integer.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

list(name, element_type, min_items=None, max_items=None, **kwargs)#

Defines a property on the object that is a list.

Parameters:

name – the name of the property
element_type – the type of the elements in the list
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

map(name, key_type, value_type, **kwargs)#

Defines a map property on the object.

Parameters:

name – the name of the property
key_type – the type of the keys in the map
value_type – the type of the values in the map

Returns:

a Map

md(markdown, name='markdown', **kwargs)#

Defines a markdown object.

Parameters:

markdown – the markdown to display
name – the name of the property

media_player(name, url, **kwargs)#

Defines a media player object.

Parameters:

name – the name of the property
url – the URL of the media to display
on_start (None) – the operator to execute when the media starts
on_play (None) – the operator to execute when the media is played
on_pause (None) – the operator to execute when the media is paused
on_buffer (None) – the operator to execute when the media is buffering
on_buffer_end (None) – the operator to execute when the media stops buffering
on_ended (None) – the operator to execute when the media ends
on_error (None) – the operator to execute when the media errors
on_duration (None) – the operator to execute when the media duration is loaded
on_seek (None) – the operator to execute when the media is seeked
on_progress (None) – the operator to execute when the media progresses

Returns:

menu(name, **kwargs)#

Defined an Object property that is displayed as a menu.

Note

Can be used for an Button type with properties whose views are one of Button, Dropdown, DropdownView, and :class;`Choices`. The variant and color of the items can be set using the variant and color parameters.

Parameters:

name – the name of the property
variant (None) – the variant for the items of the menu. Can be "contained", "outlined", "round" or "square"
color (None) – the color for the items of the menu.
overlay (None) – whether to display the menu as an overlay. Can be "top-left",
"top-center"
"top-right"
"bottom-left"
"bottom-center"`
or
of ("bottom-right". Overlay is useful when you want to display a floating menu on top)
content (another)
icon (None) – when set, the icon will be displayed as the menu button instead of the label.
"SettingsIcon" (Can be)
"MoreVertIcon".

Returns:

message(name, label, **kwargs)#

Defines a message to display to the user as a Notice.

Parameters:

name – the name of the property
label – the label of the notice
description (None) – the description of the notice
view (None) – the View of the notice

Returns:

obj(name, **kwargs)#

Defines a property on the object that is an object.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

oneof(name, types, **kwargs)#

Defines a one-of property on the object.

Parameters:

name – the name of the property
types – list of types that are instances of BaseType

Returns:

a OneOf

plot(name, **kwargs)#

Defines an object property displayed as a plot.

Parameters:

name – the name of the property
config (None) – the chart config
layout (None) – the chart layout

See PlotlyView for more information.

str(name, allow_empty=False, **kwargs)#

Defines a property on the object that is a string.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

target_view(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

to_json()#

Converts the object definition to JSON.

Returns:: a JSON dict

tree(name, **kwargs)#

Defines a tree property on the object.

Parameters:: name – the name of the property
Returns:: a Tree

tuple(name, *items, **kwargs)#

Defines a tuple property on the object.

Parameters:

name – the name of the property
*items – the types of the items in the tuple

Returns:

a Tuple

uploaded_file(name, **kwargs)#

Defines a property on the object that is an uploaded file.

Parameters:

name – the name of the property
view (None) – the View of the property
lite (False) – whether to use the lite version of the file. When True, the content of the file in not included in resolve_input params, only the metadata is included.

v_stack(name, **kwargs)#

Defines a vertical stack object.

Parameters:: name – the name of the property
Returns:: a Object

view(name, view, **kwargs)#

Defines a view-only property.

Examples:

import fiftyone.operators.types as types

notice = types.Notice(label="a label", description="a description")
inputs = types.Object()
inputs.view("notice", notice)

Parameters:

name – the name of the property
view – the View to define

Returns:

view_target(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

class fiftyone.operators.types.UploadedFile(**kwargs)#

Bases: Object

Represents an object with uploaded file content and its metadata in properties.

Properties:: name: the name of the file type: the mime type of the file size: the size of the file in bytes content: the base64 encoded content of the file last_modified: the last modified time of the file in ms since epoch

Methods:

`add_property`(name, property)	Adds a property to the object.
`arrow_nav`(name[, forward, backward, position])	Defines a floating navigation arrows as a `ArrowNavView`.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`btn`(name, label[, icon, variant, disabled, ...])	Defines a button or icon button to display to the user as a `Button`.
`btn_group`(name, **kwargs)	Defines a button group object.
`clone`()	Clones the definition of the object.
`dashboard`(name, **kwargs)	Defines a dashboard view as a `View`.
`define_property`(name, type, **kwargs)	Defines a property on the object.
`enum`(name, values, **kwargs)	Defines a property on the object that is an enum.
`file`(name, **kwargs)	Defines a property on the object that is a file.
`float`(name[, min, max])	Defines a property on the object that is a float.
`get_property`(name)	Gets a property by name.
`grid`(name, **kwargs)	Defines a grid view as a `View`.
`h_stack`(name, **kwargs)	Defines a horizontal stack object.
`img`(name[, href, on_click, prompt, params, ...])	Defines an image to display to the user as a `ImageView`.
`int`(name[, min, max])	Defines a property on the object that is an integer.
`list`(name, element_type[, min_items, max_items])	Defines a property on the object that is a list.
`map`(name, key_type, value_type, **kwargs)	Defines a map property on the object.
`md`(markdown[, name])	Defines a markdown object.
`media_player`(name, url, **kwargs)	Defines a media player object.
`menu`(name, **kwargs)	Defined an `Object` property that is displayed as a menu.
`message`(name, label, **kwargs)	Defines a message to display to the user as a `Notice`.
`obj`(name, **kwargs)	Defines a property on the object that is an object.
`oneof`(name, types, **kwargs)	Defines a one-of property on the object.
`plot`(name, **kwargs)	Defines an object property displayed as a plot.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`target_view`(ctx[, name, view_type, ...])	Defines a view target input property.
`to_json`()	Converts the object definition to JSON.
`tree`(name, **kwargs)	Defines a tree property on the object.
`tuple`(name, items, *kwargs)	Defines a tuple property on the object.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`v_stack`(name, **kwargs)	Defines a vertical stack object.
`view`(name, view, **kwargs)	Defines a view-only property.
`view_target`(ctx[, name, view_type, ...])	Defines a view target input property.

add_property(name, property)#

Adds a property to the object.

Parameters:

name – the name of the property
property – the property to add

Returns:

the Property that was added

arrow_nav(name, forward=None, backward=None, position=None, **kwargs)#

Defines a floating navigation arrows as a ArrowNavView.

Parameters:

forward (True) – Whether to display the forward arrow
backward (True) – Whether to display the backward arrow
on_forward (None) – The operator to execute when the forward arrow is clicked
on_backward (None) – The operator to execute when the backward arrow is clicked
position ("center") – The position of the arrows. Can be either "top", center, "bottom", "left", middle` (center horizontally), or ``"right"

Returns:

bool(name, **kwargs)#

Defines a property on the object that is a boolean.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

btn(name, label, icon=None, variant=None, disabled=False, on_click=None, prompt=False, params=None, space=None, href=None, icon_position='left', **kwargs)#

Defines a button or icon button to display to the user as a Button.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.btn(
    "greet",
    label="Say Hi!",
    icon="waving_hand",
    variant="round",
    on_click="print_stdout",
    params={"msg": "Hi!"},
)

Parameters:

name – the name of the property
label – the label of the button
icon (None) – the name of the icon to display
icon_position ("left") – the position of the icon. Can be "left" or "right"
disabled (False) – whether the button is disabled
variant (None) – the variant of the button. Can be "contained", "outlined", "round" or "square"
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
space (None) – An int specifying how much vertical/horizontal space to allocate out of 12 depending on the orientation of the parent container
href (None) – the URL to navigate to when the button is clicked

btn_group(name, **kwargs)#

Defines a button group object.

Parameters:: name – the name of the property
Returns:: a Object

clone()#

Clones the definition of the object.

Parameters:: name – the name of the property
Returns:: an Object

dashboard(name, **kwargs)#

Defines a dashboard view as a View.

See DashboardView for more information.

Parameters:: name – the name of the property
Returns:: an Object

See DashboardView for more information.

define_property(name, type, **kwargs)#

Defines a property on the object.

Parameters:

name – the name of the property
type – the type of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

the Property that was added

enum(name, values, **kwargs)#

Defines a property on the object that is an enum.

Parameters:

name – the name of the property
values – a list of values that define the enum
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property, which must be a Choices or a subclass of it

Returns:

file(name, **kwargs)#

Defines a property on the object that is a file.

Parameters:

name – the name of the property
view (None) – the View of the property

float(name, min=None, max=None, **kwargs)#

Defines a property on the object that is a float.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

get_property(name)#

Gets a property by name.

Parameters:: name – the name of the property
Returns:: the Property, or None

grid(name, **kwargs)#: Defines a grid view as a View.

h_stack(name, **kwargs)#

Defines a horizontal stack object.

Parameters:: name – the name of the property
Returns:: a Object

img(name, href=None, on_click=None, prompt=False, params=None, point_on_hover=True, height=None, width=None, alt_text=None, **kwargs)#

Defines an image to display to the user as a ImageView.

Examples:

import fiftyone.operators.types as types
ctx.panel.state.my_img = "/path/to/my/image.jpg"

panel = types.Object()
panel.img(
    "my_img", # uses the value in ctx.panel.state.my_img
    href="https://path/to/navigate/to",
    on_click=self.do_something,
    prompt=False,
    params={"foo": "bar"},
    point_on_hover=True,
    height="100px",
    width="100px",
    alt_text="My image alt text"
)

Parameters:

name – the name of the state variable to use as the image source
href (None) – the url to navigate to when the image is clicked
on_click (None) – the name of the operator to execute when the button is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator
point_on_hover (True) – whether to show a pointer when hovering over the image
height (None) – the height of the image
width (None) – the width of the image
alt_text (None) – the alt text of the image

int(name, min=None, max=None, **kwargs)#

Defines a property on the object that is an integer.

Parameters:

name – the name of the property
min – minimum value of the property
max – maximum value of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

list(name, element_type, min_items=None, max_items=None, **kwargs)#

Defines a property on the object that is a list.

Parameters:

name – the name of the property
element_type – the type of the elements in the list
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

map(name, key_type, value_type, **kwargs)#

Defines a map property on the object.

Parameters:

name – the name of the property
key_type – the type of the keys in the map
value_type – the type of the values in the map

Returns:

a Map

md(markdown, name='markdown', **kwargs)#

Defines a markdown object.

Parameters:

markdown – the markdown to display
name – the name of the property

media_player(name, url, **kwargs)#

Defines a media player object.

Parameters:

name – the name of the property
url – the URL of the media to display
on_start (None) – the operator to execute when the media starts
on_play (None) – the operator to execute when the media is played
on_pause (None) – the operator to execute when the media is paused
on_buffer (None) – the operator to execute when the media is buffering
on_buffer_end (None) – the operator to execute when the media stops buffering
on_ended (None) – the operator to execute when the media ends
on_error (None) – the operator to execute when the media errors
on_duration (None) – the operator to execute when the media duration is loaded
on_seek (None) – the operator to execute when the media is seeked
on_progress (None) – the operator to execute when the media progresses

Returns:

menu(name, **kwargs)#

Defined an Object property that is displayed as a menu.

Note

Can be used for an Button type with properties whose views are one of Button, Dropdown, DropdownView, and :class;`Choices`. The variant and color of the items can be set using the variant and color parameters.

Parameters:

name – the name of the property
variant (None) – the variant for the items of the menu. Can be "contained", "outlined", "round" or "square"
color (None) – the color for the items of the menu.
overlay (None) – whether to display the menu as an overlay. Can be "top-left",
"top-center"
"top-right"
"bottom-left"
"bottom-center"`
or
of ("bottom-right". Overlay is useful when you want to display a floating menu on top)
content (another)
icon (None) – when set, the icon will be displayed as the menu button instead of the label.
"SettingsIcon" (Can be)
"MoreVertIcon".

Returns:

message(name, label, **kwargs)#

Defines a message to display to the user as a Notice.

Parameters:

name – the name of the property
label – the label of the notice
description (None) – the description of the notice
view (None) – the View of the notice

Returns:

obj(name, **kwargs)#

Defines a property on the object that is an object.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

oneof(name, types, **kwargs)#

Defines a one-of property on the object.

Parameters:

name – the name of the property
types – list of types that are instances of BaseType

Returns:

a OneOf

plot(name, **kwargs)#

Defines an object property displayed as a plot.

Parameters:

name – the name of the property
config (None) – the chart config
layout (None) – the chart layout

See PlotlyView for more information.

str(name, allow_empty=False, **kwargs)#

Defines a property on the object that is a string.

Parameters:

name – the name of the property
label (None) – the label of the property
description (None) – the description of the property
view (None) – the View of the property

Returns:

target_view(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

to_json()#

Converts the object definition to JSON.

Returns:: a JSON dict

tree(name, **kwargs)#

Defines a tree property on the object.

Parameters:: name – the name of the property
Returns:: a Tree

tuple(name, *items, **kwargs)#

Defines a tuple property on the object.

Parameters:

name – the name of the property
*items – the types of the items in the tuple

Returns:

a Tuple

uploaded_file(name, **kwargs)#

Defines a property on the object that is an uploaded file.

Parameters:

name – the name of the property
view (None) – the View of the property
lite (False) – whether to use the lite version of the file. When True, the content of the file in not included in resolve_input params, only the metadata is included.

v_stack(name, **kwargs)#

Defines a vertical stack object.

Parameters:: name – the name of the property
Returns:: a Object

view(name, view, **kwargs)#

Defines a view-only property.

Examples:

import fiftyone.operators.types as types

notice = types.Notice(label="a label", description="a description")
inputs = types.Object()
inputs.view("notice", notice)

Parameters:

name – the name of the property
view – the View to define

Returns:

view_target(ctx, name='view_target', view_type=None, action_description='Process', default_target=None, allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_label='Entire dataset', dataset_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Defines a view target input property.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

Args:
    ctx: the operator's :class:`fiftyone.operators.ExecutionContext`
    name(view_target): the name of the view target property
    view_type (RadioGroup): the view type to use (RadioGroup, Dropdown,
        etc.)
    default_target (None): the default target view to select if
        multiple choices are available. If ``None`` or
        ``default_target`` is not an available choice, the most
        targeted / selective available choice is chosen.
    action_description (Process): a short description of the action
        being performed, used to generate default descriptions for the
        various target views
    allow_selected_samples (True): whether to allow the "selected
        samples" target view
    allow_selected_labels (False): whether to allow the "selected
        labels" target view
    allow_dataset_view (False): whether to allow the "dataset view"
        target view
    base_view_label (Base view): the label for the "base view" target
        view
    base_view_description (None): the description for the "base view"
        target view. If ``None``, a default description is generated
    current_view_label (Current view): the label for the "current
        view" target view
    current_view_description (None): the description for the "current
        view" target view. If ``None``, a default description is
        generated
    dataset_label (Entire dataset): the label for the "entire dataset"
        target view
    dataset_description (None): the description for the "entire
        dataset" target view. If ``None``, a default description is
        generated
    dataset_view_label (Dataset): the label for the "dataset view"
        target view
    dataset_view_description (None): the description for the "dataset
        view" target view. If ``None``, a default description is
        generated
    selected_samples_label (Selected samples): the label for the
        "selected samples" target view
    selected_samples_description (None): the description for the
        "selected samples" target view. If ``None``, a default
        description is generated
    selected_labels_label (Selected labels): the label for the
        "selected labels" target view
    selected_labels_description (None): the description for the
        "selected labels" target view. If ``None``, a default
        description is generated

Returns:
    a :class:`ViewTargetProperty`

class fiftyone.operators.types.View(container=None, **kwargs)#

Bases: object

Represents a view of a Property.

Views are used to define how properties are displayed in the FiftyOne App.

Parameters:

label (None) – a label for the view
description (None) – a description for the view
caption (None) – a caption for the view
space (12) – An int specifying how much vertical/horizontal space to allocate out of 12 depending on the orientation of the parent container
placeholder (None) – string to display placeholder text
read_only (False) – whether the view is read-only
component (None) – specifying custom component to use as the view
componentsProps (None) – dict for providing props to components rendered by a view
container (None) – the container (instance of BaseType) of the view

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.InferredView(**kwargs)#

Bases: View

Represents a view of a Property that is inferred from the data.

Note

You can only use inferred views for input properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Form(live=False, submit_button_label='Execute', cancel_button_label='Close', **kwargs)#

Bases: View

A form view.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ReadOnlyView(**kwargs)#

Bases: View

A read-only View.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Choice(value, include=True, **kwargs)#

Bases: View

Represents a choice in a Choices view.

Parameters:

value – the value of the choice
label (None) – a label for the Choice
description (None) – a description for the Choice
caption (None) – a caption for the Choice

Methods:

`clone`()	Clones the `Choice`.
`to_json`()
`kwargs_to_json`()

clone()#

Clones the Choice.

Returns:: a Choice

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.Choices(**kwargs)#

Bases: View

Represents a set of choices in a View.

Use this view to define a set of choices for a Property that can be selected by the user and require labels and optional descriptions.

Examples:

import fiftyone.operators.types as types

choices = types.Choices()
choices.add_choice("cat", label="Cat", description="A cat")
choices.add_choice("dog", label="Dog", description="A dog")

inputs = types.Object()
inputs.enum("animal", choices.values(), view=choices)

Parameters:: choices (None) – a list of Choice instances

Attributes:

Methods:

`values`()	Returns the choice values for this instance.
`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`to_json`()
`kwargs_to_json`()

property choices#

values()#

Returns the choice values for this instance.

Returns:: a list of values

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

clone()#

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.RadioGroup(**kwargs)#

Bases: Choices

Represents a set of choices in a View that are displayed as a radio group.

Examples:

import fiftyone.operators.types as types

choices = types.RadioGroup()
choices.add_choice("cat", label="Cat", description="A cat")
choices.add_choice("dog", label="Dog", description="A dog")

inputs = types.Object()
inputs.enum("animal", choices.values(), view=choices)

Parameters:

orientation ("horizontal") – the orientation of the radio group Can be "horizontal" or "vertical"
label (None) – a label for the radio group
description (None) – a description for the radio group
caption (None) – a caption for the radio group

Methods:

`to_json`()
`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

to_json()#

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.Dropdown(**kwargs)#

Bases: Choices

Represents a set of choices in a View that are displayed as a dropdown.

Examples:

import fiftyone.operators.types as types

choices = types.Dropdown()
choices.add_choice("cat", label="Cat", description="A cat")
choices.add_choice("dog", label="Dog", description="A dog")

inputs = types.Object()
inputs.enum("animal", choices.values(), view=choices)

Parameters:

label (None) – a label for the dropdown
description (None) – a description for the dropdown
caption (None) – a caption for the dropdown

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.Notice(**kwargs)#

Bases: View

Represents a notice in a View.

You can use this view to display notices to the user.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.notice("This is a notice")

Parameters:

label (None) – a label for the notice
description (None) – a description for the notice
caption (None) – a caption for the notice

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Header(**kwargs)#

Bases: View

Represents a header in a View.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Warning(**kwargs)#

Bases: View

Represents a warning in a View.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Error(**kwargs)#

Bases: View

Represents an error in a View.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Button(**kwargs)#

Bases: View

Represents a button in a View.

Examples:

import fiftyone.operators.types as types

button = types.Button(
    label="Click me",
    operator="print_stdout",
    params={"msg": "Hello World"},
)

inputs = types.Object()
inputs.view("btn", button)

Parameters:

label (None) – a label for the button
description (None) – a description for the button
caption (None) – a caption for the button
operator (None) – the name of the operator to execute when the button is clicked
params (None) – the parameters to pass to the operator
href (None) – the URL to navigate to when the button is clicked

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.OperatorExecutionButtonView(**kwargs)#

Bases: Button

Represents an operator execution button in a View.

Examples:

import fiftyone.operators.types as types

exec_button = types.OperatorExecutionButtonView(
    label="Execute Simple Op",
    variant="contained",
    operator="@voxel51/panel-examples/simple_op",
    on_success=self.on_success,
    on_error=self.on_error,
    on_option_selected=self.on_select,
    params={"msg": "Hello World!"},
)

inputs = types.Object()
inputs.view("operator_btn", view=exec_button)

Parameters:

icon – an icon for the button. Defaults to “expand_more” if not provided.
label – a label for the button.
variant – the variant of the button. Can be “contained” or “outlined”.
description – a description for the button.
title – a tooltip title for the button.
operator – the URI of the operator to execute when the button is clicked.
on_success – the URI of the operator to execute when the operator execution is successful.
on_error – the URI of the operator to execute when the operator execution fails.
on_option_selected – the URI of the operator to execute when an option is selected.
params – the parameters dict to pass to the operator.
disabled – whether the button is disabled.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.OneOfView(**kwargs)#

Bases: View

Displays one of the given View instances.

Examples:

import fiftyone.operators.types as types

choices = types.RadioGroup()
choices.add_choice("cat", label="Cat", description="A cat")
choices.add_choice("dog", label="Dog", description="A dog")
view = types.OneOfView(
    oneof=[types.Enum(choices.values()), types.String()]
)

inputs = types.Object()
inputs.define_property(types.OneOfView(oneof=[choices]), view=view)

Parameters:: oneof (None) – a list of View instances

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ListView(**kwargs)#

Bases: View

Displays a list of View instances.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.TupleView(*itemsView, **options)#

Bases: View

Displays a tuple of View instances.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.TreeSelectionView(**options)#

Bases: View

Displays a tree selection checkbox groups.

Examples:

import fiftyone.operators.types as types

structure = [
    ["group_id_1", ["sample_id_1", "sample_id_2"]],
    ["group_id_2", ["sample_id_3", "sample_id_4", "sample_id_5"], ["group_id_8", ["sample_id_6"]]],
]

tree_view = types.TreeSelectionView(
    data=structure # this data represents the basic group structure;
)

panel.view('exact_duplicate_selections', view=tree_view, on_change=self.toggle_select)

def toggle_select(self, ctx):
    selected = ctx.params['value']
    print('selected samples:', selected)

Parameters:

data (None) – a list of lists representing the tree structure of groups and its children
on_change (None) – the operator to execute when the tree selection changes

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.CodeView(**kwargs)#

Bases: View

Displays a code editor.

Examples:

import fiftyone.operators.types as types

inputs = types.Object()
inputs.str("src", types.CodeView(language="python"))

Parameters:: language (None) – the language to use for syntax highlighting

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ColorView(**kwargs)#

Bases: View

Displays a color picker.

Parameters:

compact (None) – whether to display the color picker in compact mode
variant (None) – the variant of the color picker. See https://casesandberg.github.io/react-color

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.TabsView(**kwargs)#

Bases: Choices

Displays a tabbed view.

Parameters:: variant (None) – the variant of the tabs. See https://material-ui.com/components/tabs

Methods:

`to_json`()
`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

to_json()#

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.JSONView(**kwargs)#

Bases: View

Displays a JSON viewer.

Examples:

# Show an object/dictionary in a JSON viewer
outputs.obj("my_property", label="My Object", view=types.JSONView())

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.AutocompleteView(**kwargs)#

Bases: Choices

Displays an autocomplete input.

Note

This view can be used in place of Choices.

Parameters:

choices (None) – a list of Choice instances
read_only (False) – whether the view is read-only
allow_user_input (True) – when True the user can input a value that is not in the choices
allow_duplicates (True) – when True the user can select the same choice multiple times

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.FileView(**kwargs)#

Bases: View

Displays a file input.

Note

This view can be used on String or UploadedFile properties. If used on a String property, the value will be the base64-encoded contents. If used on a UploadedFile, the value will be a UploadedFile object.

Parameters:

max_size (None) – a maximum allowed size of the file, in bytes
max_size_error_message (None) – an error message to display if the file exceeds the max size
types (None) – a string containing the comma-separated file types to accept
lite (False) – whether to use the lite version of the file. When True, the content of the file in not included, only the metadata is included in resolve_input params. Must be used in conjunction with a property of type UploadedFile .

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.LinkView(**kwargs)#

Bases: View

Displays a hyperlink.

Parameters:: href (None) – the URL to link to. Defaults to the property value.href

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.HiddenView(**kwargs)#

Bases: View

Allows properties to be hidden from the user.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.LoadingView(**kwargs)#

Bases: ReadOnlyView

Displays a loading indicator.

Parameters:

text ("Loading") – a label for the loading indicator
variant ("spinner") – the variant of the loading indicator
color ("primary") – the color of the loading indicator
size ("medium") – the size of the loading indicator

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.PillBadgeView(**kwargs)#

Bases: View

Displays a pill shaped badge.

Parameters:

text ("Reviewed" | ["Reviewed", "Not Reviewed"] | [["Not Started", "primary"], ["Reviewed", "success"], ["In Review", "warning"]) – a label or set of label options with or without a color for the pill badge
color ("primary") – the color of the pill
variant ("outlined") – the variant of the pill
show_icon (False | True) – whether to display indicator icon

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.PlotlyView(**kwargs)#

Bases: View

Displays a Plotly chart.

Note

See plotly/react-plotly.js for documentation.

All event handlers have the following default params:

id: the corresponding data.ids[idx]
path: the path of the property
relative_path: the relative path of the property
schema: the schema of the property
view: the value of the PlotlyView
event: the event name (eg. onClick, onSelected, onDoubleClick)
value: the value of the clicked point (only pie chart-like plots)
label: the label of the clicked point (only pie chart-like plots)
shift_pressed: whether the shift key was pressed

Examples:

def render(self, ctx):
    panel.plot("my_plot", on_click=self.on_click, on_selected=self.on_selected)

def print_params(self, ctx, params):
    for key, value in params.items():
        ctx.print(f"{key}: {value}")

def on_click(self, ctx):
    # available params
    self.print_prams(ctx, {
        "id": "id", # the corresponding data.ids[idx]
        "idx": 1, # the index of the clicked point
        "label": "label", # label (eg. on pie charts)
        "shift_pressed": false, # whether the shift key was pressed
        "trace": "my_trace", # data[trace_idx].name
        "trace_idx": 0,
        "value": "my_value", # data[trace_idx].values[idx] (eg. on a pie chart)
        "x": 2, # data[trace_idx].x[idx] (the x value on most plot types)
        "y": 3, # data[trace_idx].y[idx] (the y value on most plot types)
        "z": 4, # data[trace_idx].z[idx] (the z value on 3d plots eg. heatmap)
    })

def on_selected(self, ctx):
    prin(ctx.params['data'])
    # [
    #     {
    #       "trace": "trace 0", # data[trace_idx].name
    #       "trace_idx": 0, # the index of the trace
    #       "idx": 1, # the index of the selected point
    #       "id": "one", # the corresponding data.ids[idx]
    #       "x": 2, # the x value of the selected point
    #       "y": 15, # the y value of the selected point
    #       "z": 22 # the z value of the selected point
    #     }
    # ]

Parameters:

data (None) – the chart data
config (None) – the chart config
layout (None) – the chart layout
on_click (None) – event handler for click events
on_selected (None) – event handler for selected events
on_double_click (None) – event handler for double click events

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.Placement(place, view=None)#

Bases: object

Represents the placement of an operator in the FiftyOne App.

Parameters:

place – the Places value
view (None) – a View to render

Methods:

to_json()#

class fiftyone.operators.types.Places(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

The places available to operators in the FiftyOne App.

Attributes:

`SAMPLES_GRID_ACTIONS`
`SAMPLES_GRID_SECONDARY_ACTIONS`
`SAMPLES_VIEWER_ACTIONS`
`EMBEDDINGS_ACTIONS`
`HISTOGRAM_ACTIONS`
`MAP_ACTIONS`
`MAP_SECONDARY_ACTIONS`
`DISPLAY_OPTIONS`

Methods:

SAMPLES_GRID_ACTIONS = 'samples-grid-actions'#

SAMPLES_GRID_SECONDARY_ACTIONS = 'samples-grid-secondary-actions'#

SAMPLES_VIEWER_ACTIONS = 'samples-viewer-actions'#

EMBEDDINGS_ACTIONS = 'embeddings-actions'#

HISTOGRAM_ACTIONS = 'histograms-actions'#

MAP_ACTIONS = 'map-actions'#

MAP_SECONDARY_ACTIONS = 'map-secondary-actions'#

DISPLAY_OPTIONS = 'display-options'#

to_json()#

class fiftyone.operators.types.KeyValueView(**kwargs)#

Bases: View

Displays a key-value editor.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Column(key, **kwargs)#

Bases: View

A column in a TableView.

Parameters:: key – the name of the property to use for data

Methods:

`clone`()
`to_json`()
`kwargs_to_json`()

clone()#

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.Action(name, **kwargs)#

Bases: View

An action (currently supported only in a TableView).

Parameters:

name – the name of the action
label (None) – the label of the action
icon (None) – the icon of the action
tooltip (None) – the tooltip of the action
on_click – the operator to execute when the action is clicked

Methods:

`clone`()
`to_json`()
`kwargs_to_json`()

clone()#

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.Tooltip(row, column, **kwargs)#

Bases: View

A tooltip (currently supported only in a TableView).

Parameters:

value – the value of the tooltip
row – the row of the tooltip
column – the column of the tooltip

Methods:

`clone`()
`to_json`()
`kwargs_to_json`()

clone()#

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.TableView(**kwargs)#

Bases: View

Displays a table.

Parameters:

columns (None) – a list of Column objects to display
row_actions (None) – a list of Action objects to display

Methods:

`keys`()
`add_column`(key, **kwargs)
`add_row_action`(name, on_click[, label, ...])
`add_tooltip`(row, column, value, **kwargs)
`clone`()
`to_json`()
`kwargs_to_json`()

keys()#

add_column(key, **kwargs)#

add_row_action(name, on_click, label=None, icon=None, tooltip=None, **kwargs)#

add_tooltip(row, column, value, **kwargs)#

clone()#

to_json()#

kwargs_to_json()#

class fiftyone.operators.types.MapView(**kwargs)#

Bases: View

Displays a key-value mapping.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ProgressView(**kwargs)#

Bases: View

Displays a progress bar.

Examples:

import fiftyone.operators as foo
import fiftyone.operators.types as types

class ExampleProgress(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="example_progress",
            label="Examples: Progress",
            execute_as_generator=True,
        )

    async def execute(self, ctx):
        outputs = types.Object()
        schema = types.Property(outputs)
        n = 100
        for i in range(n):
            label = f"Loading {i} of {n}"
            progress_view = types.ProgressView(label=label)
            loading_schema = types.Object()
            loading_schema.int("percent_complete", view=progress_view)
            show_output_params = {
                "outputs": types.Property(loading_schema).to_json(),
                "results": {"percent_complete": i / n}
            }
            yield ctx.trigger("show_output", show_output_params)

            # Simulate computation
            await asyncio.sleep(0.5)

Parameters:

label (None) – the label to display under the progress bar
variant (None) – bar variant. Supported values are "linear" and "circular"

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ImageView(**kwargs)#

Bases: View

Displays an image.

Examples:

def execute():
    return {"image": "https://voxel51.com/your/image.png"}

def resolve_output(self, ctx):
    schema = {
        "height": "100px",
        "width": "100px",
        "alt": "My image alt text",
        "href": "https://voxel51.com",
        "operator": "@my/plugin/my_operator" | self.my_operator (in Python Panels),
        "prompt": False,
        "params": {"foo": "bar"},
    }
    outputs = types.Object()
    outputs.define_property(
        "image",
        types.String(),
        label="Image",
        view=types.ImageView(),
    )
    return types.Property(outputs)

Parameters:

height (None) – the height of the image
width (None) – the width of the image
alt (None) – the alt text of the image
href (None) – the url to navigate to when the image is clicked
operator (None) – the name of the callable operator to execute when the image is clicked
prompt (False) – whether to prompt the user before executing the operator
params (None) – the parameters to pass to the operator

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.AlertView(**kwargs)#

Bases: View

Displays an alert.

Parameters:

severity (None) – the severity of the alert displayed, one of ("info", "success", "warning", "error")
componentsProps (None) –
an optional dict with the following keys:
- 'label' (None): props to pass to the label subcomponents
- 'description' (None): props to pass to the description subcomponents
- 'caption' (None): props to pass to the caption subcomponents

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ToastView(**kwargs)#

Bases: View

Displays a snackbar style toast element.

Examples:

schema = {: “message”: “Test”, “duration”: 30000, “layout”: {

“vertical”: “top”, “horizontal”: “center”, “top”: “200px”

},

} snackbar = types.ToastView(**schema) panel.obj(“toast”, view=snackbar)

Parameters:

message – the message to display
duration (None) – the duration to stay on screen in milliseconds
layout (None) – the layout of the toast

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.CheckboxView(**kwargs)#

Bases: View

Displays a checkbox.

Examples:

inputs.bool(
    "my_property_name",
    default=True,
    label="My Checkbox",
    description="A checkbox description.",
    view=types.CheckboxView(),
)

Note

Must be used with Boolean properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.ErrorView(**kwargs)#

Bases: View

Displays an error.

Parameters:

detailed (False) – whether to display a detailed error message
popout (None) – if provided, displays a popout button with the given dictionary of props
left (False) – whether to display on the left side of the popout button

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.HeaderView(**kwargs)#

Bases: View

Displays a header component.

Headers can have a label, description, and caption, each of which are displayed in a separate line.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.ObjectView(**kwargs)#

Bases: View

Displays an object component.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.RadioView(**kwargs)#

Bases: RadioGroup

Displays a radio component for the given RadioGroup instance.

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.SwitchView(**kwargs)#

Bases: View

Displays a toggle switch.

Note

Must be used with Boolean properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.TextView(**kwargs)#

Bases: View

Displays a text. .. note:

Must be used with :class:`String` properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.TextFieldView(**kwargs)#

Bases: View

Displays a text input.

Note

Must be used with String or Number properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.FieldView(**kwargs)#

Bases: View

Displays a text input.

Note

Must be used with String or Number properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.LazyFieldView(**kwargs)#

Bases: View

Displays a lazy text input which only apply input field changes on blur or when user clicks the save button within the field.

Note

Must be used with String or Number properties.

Parameters:: save_on_blur (True) – when set to False, changes in input field will not be automatically applied when user moves mouse out of the changed field. To apply changes, user must click the save button.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.DropdownView(**kwargs)#

Bases: Dropdown

Displays a dropdown selector input.

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`append`(choice)	Appends a `Choice` to the list of choices.
`clone`()
`kwargs_to_json`()
`to_json`()
`values`()	Returns the choice values for this instance.

Attributes:

add_choice(value, **kwargs)#

Adds a choice value to this instance.

Parameters:: value – a choice value
Returns:: the Choice that was added

append(choice)#

Appends a Choice to the list of choices.

Parameters:: choice – a Choice instance

property choices#

clone()#

kwargs_to_json()#

to_json()#

values()#

Returns the choice values for this instance.

Returns:: a list of values

class fiftyone.operators.types.LabelValueView(**kwargs)#

Bases: View

Displays a label-value component. Used for displaying a label and a corresponding value.

Note

Must be used with String, Number, or Boolean properties, or lists of such properties. Also this view is not supported for input properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.PrimitiveView(**kwargs)#

Bases: View

Displays a primitive value component.

Note

Must be used with String, Number, or Boolean properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.SliderView(**kwargs)#

Bases: View

Displays a slider component.

Note

This view must be used with Number properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.TagsView(**kwargs)#

Bases: View

Displays a list of tags component.

Note

Must be used with List properties whose items are String, Number:, or :class:`Boolean instances

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.Success(**kwargs)#

Bases: View

Represents a success in a View.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.ButtonView(**kwargs)#

Bases: Button

Represents a button in a Button.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.MarkdownView(**kwargs)#

Bases: View

Renders a markdown string as HTML.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.StatusButtonView(**kwargs)#

Bases: View

Renders a status button.

Parameters:

severity (None) – the severity of the alert displayed, one of ("info", "success", "warning", "error", "enabled", "disabled")
on_click (None) – an operator to execute when the button is clicked
params (None) – the parameters to pass to the operator
disabled – whether the button is disabled
title – tooltip title for the button

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.MediaPlayerView(**kwargs)#

Bases: View

Renders a media player for audio and video files.

Parameters:

name – the name of the property
url – the URL of the media to display
on_start (None) – the operator to execute when the media starts
on_play (None) – the operator to execute when the media is played
on_pause (None) – the operator to execute when the media is paused
on_buffer (None) – the operator to execute when the media is buffering
on_buffer_end (None) – the operator to execute when the media stops buffering
on_ended (None) – the operator to execute when the media ends
on_error (None) – the operator to execute when the media errors
on_duration (None) – the operator to execute when the media duration is loaded
on_seek (None) – the operator to execute when the media is seeked
on_progress (None) – the operator to execute when the media progresses

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.FileExplorerView(**kwargs)#

Bases: View

Displays a file explorer for interacting with files.

Examples:

import os
import fiftyone.operators.types as types

inputs = types.Object()

# Create an explorer that allows the user to choose a directory
file_explorer = types.FileExplorerView(
    choose_dir=True,
    button_label="Choose a directory...",
    choose_button_label="Accept"
)

# Define a types.File property
file_prop = inputs.file(
    "directory",
    required=True,
    label="Directory",
    description="Choose a directory",
    view=file_explorer,
)

directory = ctx.params.get("directory", {}).get("absolute_path", None)

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.PromptView(**kwargs)#

Bases: View

Customizes how a prompt is rendered.

Examples:

import fiftyone.operators.types as types

# in resolve_input
prompt = types.PromptView(
    label="This is the title",
    submit_button_label="Click me",
    cancel_button_label="Abort"
)
inputs = types.Object()
inputs.md("Hello world!")
return types.Property(inputs, view=prompt)

Parameters:

label (None) – the title for the prompt
submit_button_label (None) – the label for the submit button
cancel_button_label (None) – the label for the cancel button

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.ViewTargetOptions(choices_view, action_description='Process', include_base_view=False, include_current_view=False, include_dataset=True, include_dataset_view=False, include_selected_labels=False, include_selected_samples=False, dataset_label='Entire dataset', dataset_description=None, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **_)#

Bases: object

Represents the options for a ViewTargetProperty.

choices_view#: a Choices for the view target choices

Methods:

values()

values()#

class fiftyone.operators.types.ViewTargetProperty(ctx, view_type=<class 'fiftyone.operators._types.types.RadioGroup'>, action_description='Process', allow_selected_samples=True, allow_selected_labels=False, allow_dataset_view=False, default_target=None, dataset_label='Entire dataset', dataset_description=None, base_view_label='Base view', base_view_description=None, current_view_label='Current view', current_view_description=None, dataset_view_label='Dataset', dataset_view_description=None, selected_samples_label='Selected samples', selected_samples_description=None, selected_labels_label='Selected labels', selected_labels_description=None, **kwargs)#

Bases: Property

Property that displays a view target selector.

This property has an enum input that allows the user to select which view to process. The available choices depend on the current context and the provided flags.

The choices include:

Entire dataset (if the current view is not a generated view)
Base view (if the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), which is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")
Dataset view (if allow_dataset_view is True)
Current view (if the current view is different from the dataset view)
Selected samples (if allow_selected_samples is True and there are selected samples)
Selected labels (if allow_selected_labels is True and there are selected labels)

If there’s no view or selected items, the only option is entire dataset, so the view target selector is hidden and “DATASET” will be returned.

The resolved target view can be accessed in the operator’s execute() method via ctx.target_view().

The target view descriptions are generated based on the provided action_description and the various description parameters. If a description parameter is not None, it will be used as the description for the corresponding target view choice. Otherwise, a default description will be generated such as f"{action_description} the entire dataset".

Examples:

import fiftyone.operators as foo

class MyTargetViewOperator(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="target_view_operator",
            label="Testing Target View Operator",
            dynamic=True,
        )

    def resolve_input(self, ctx):
        inputs = types.Object()

        view_target_prop = inputs.view_target(ctx)

        return types.Property(
            inputs, view=types.View(label="Target View Operator")
        )

    def execute(self, ctx):
        target_view = ctx.target_view()
        # Do something with the target view
        print("Sample collection size", len(target_view))

options#: a ViewTargetOptions instance

Attributes:

options

Methods:

property options#

to_json()#

class fiftyone.operators.types.GridView(**kwargs)#

Bases: View

Displays properties of an object as a grid of components in horizontal or vertical orientation.

Note

Must be used with Object properties.

Parameters:

orientation ("2d") – the orientation of the stack. Can be either "2d", "horizontal" or "vertical"
gap (1) – the gap between the components
align_x ("left") – the alignment of the components. Can be either "left", "center", or "right"
align_y ("top") – the alignment of the components. Can be either "top", "center", or "bottom"
variant (None) – the variant of the grid. Can be either "paper" or "outline"
elevation (None) – the elevation of the grid. Only applicable when variant="paper"

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.DashboardView(**kwargs)#

Bases: View

Defines a Dashboard view.

Parameters:

layout (None) – the layout of the dashboard.
on_save_layout (None) – event triggered when the layout changes
on_add_item (None) – event triggered when an item is added
on_remove_item (None) – event triggered when an item is closed
on_edit_item (None) – event triggered when an item is edited
allow_addition (True) – whether to allow adding items
allow_deletion (True) – whether to allow deleting items
allow_edit (True) – whether to allow editing items
cta_title (None) – the title of the call to action
cta_body (None) – the body of the call to action
cta_button_label (None) – the label of the call to action button
rows (None) – the number of rows in the dashboard
cols (None) – the number of columns in the dashboard
items (None) – the custom layout of the dashboard
auto_layout (True) – whether to automatically layout the dashboard

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.DrawerView(**kwargs)#

Bases: View

Renders an operator prompt as a left or right side drawer.

Examples:

import fiftyone.operators.types as types

# in resolve_input
inputs = types.Object()
inputs.str("message", label="Message")
prompt = types.DrawerView(placement="left")
return types.Property(inputs, view=prompt)

Parameters:

placement (None) –

the placement of the drawer. Can be one of the following

'left': display to the left of the main or expanded view
'right': display to the right of the main or expanded view

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.IconButtonView(**kwargs)#

Bases: Button

Represents a button in a View.

Examples:

import fiftyone.operators.types as types

iconButtonView = types.IconButtonView(
    icon="waving_hand",
    operator="print_stdout",
    params={"msg": "Hi!"},
)

inputs = types.Object()
inputs.view("icon_btn", iconButtonView)

Parameters:

icon (None) – a icon for the button. See https://marella.me/material-icons/demo/
variant (None) – the optional variant of the icon button. Can be "round", "square", "outlined", or "contained".
label (None) – a label for the button
description (None) – a description for the button
caption (None) – a caption for the button
operator (None) – the name of the operator to execute when the button is clicked
params (None) – the parameters to pass to the operator
href (None) – the URL to navigate to when the button is clicked

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.ModalView(**kwargs)#

Bases: Button

Represents a button in a View that opens up an interactive modal.

Examples:

import fiftyone.operators.types as types

schema = {
    "modal": {"icon": "local_offer", "iconVariant": "outlined", "title": "Modal Title", "subtitle": "Modal Subtitle", "body": "Modal Body", textAlign: {title: "center", subtitle: "left", body: "right"}},
    "primaryButton": {"primaryText": "This is the primary button", "primaryColor": "primary", "params": {"foo": "bar", "multiple": True}},
    "secondaryButton": {"secondaryText": "This is the secondary button", "secondaryColor": "secondary"},
    "primaryCallback": self.do_something(),
    "secondaryCallback": self.do_nothing(),
    "functionality": "tagging",
}
modal = types.ModalView(**schema, label="This is a modal", variant="outlined", icon="local_offer")

.. note::
    The primary callback is called when the primary button is clicked and the secondary callback is called when the secondary button is clicked.
    Secondary callback defaults to a closure of the modal unless defined.
    Buttons of ModalView inherit all functionality of ButtonView.

inputs = types.Object()
inputs.view("modal_btn", modal)

Parameters:

modal – the textual content of the modal
primaryButton (None) – the properties of the primary button
secondaryButton (None) – the properties of the secondary button
primaryCallback (None) – the function to execute when the primary button is clicked
secondaryCallback (None) – the function to execute when the secondary button is clicked
functionality (None) – the name of the functionality to execute when the primary button is clicked. Available options are ‘tagging’

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.HStackView(orientation='horizontal', **kwargs)#

Bases: GridView

Displays properties of an object as a horizontal stack of components.

Note

Must be used with Object properties.

Methods:

`clone`()
`kwargs_to_json`()
`to_json`()

clone()#

kwargs_to_json()#

to_json()#

class fiftyone.operators.types.VStackView(orientation='vertical', **kwargs)#

Bases: GridView

Displays properties of an object as a vertical stack of components.

Note

Must be used with Object properties.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.ButtonGroupView(orientation='horizontal', **kwargs)#

Bases: GridView

Displays a group of buttons in a horizontal stack.

Note

Must be used with Button properties.

Methods:

`to_json`()
`clone`()
`kwargs_to_json`()

to_json()#

clone()#

kwargs_to_json()#

class fiftyone.operators.types.MenuView(orientation='horizontal', **kwargs)#

Bases: GridView

Displays a menu of options in a vertical stack.

Note

Can be used for an Button type with properties whose views are one of Button, Dropdown, DropdownView, and :class;`Choices`. The variant and color of the items can be set using the variant and color parameters.

Parameters:

name – the name of the property
variant (None) – the variant for the items of the menu. Can be "contained", "outlined", "round" or "square"
color (None) – the color for the items of the menu.
overlay (None) – whether to display the menu as an overlay. Can be "top-left",
"top-center"
"top-right"
"bottom-left"
"bottom-center"`
or
of ("bottom-right". Overlay is useful when you want to display a floating menu on top)
content (another)
icon (None) – when set, the icon button will be displayed as the menu trigger,
"MoreVertIcon" (instead of the selected value. Can be "SettingsIcon" or)

Returns: