fiftyone.operators.types¶

to_json()¶

class fiftyone.operators.types.Void¶

Represents a void type.

Methods:

to_json()¶

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

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.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`clone`()	Clones the definition of the object.
`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.
`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.
`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.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`to_json`()	Converts the object definition to JSON.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`view`(name, view, **kwargs)	Defines a view-only 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

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

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

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

clone()¶

Clones the definition of the object.

Returns: an Object

to_json()¶

Converts the object definition to JSON.

Returns: a JSON dict

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

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)¶

Represents a string.

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

Methods:

to_json()¶

class fiftyone.operators.types.Boolean¶

Represents a boolean.

Methods:

to_json()¶

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

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)¶

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: fiftyone.operators.types.String

Represents a fiftyone.core.samples.Sample ID.

Methods:

to_json()¶

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

Represents an enum.

Parameters: values – the values of the enum

Methods:

to_json()¶

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

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)¶

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.Map(key_type, value_type)¶

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: fiftyone.operators.types.Object

Represents a file and related metadata for use with FileExplorerView.

Methods:

`add_property`(name, property)	Adds a property to the object.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`clone`()	Clones the definition of the object.
`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.
`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.
`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.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`to_json`()	Converts the object definition to JSON.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`view`(name, view, **kwargs)	Defines a view-only 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

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

clone()¶

Clones the definition of the object.

Returns: an Object

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

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

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

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

to_json()¶

Converts the object definition to JSON.

Returns: a JSON dict

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

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

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

Bases: fiftyone.operators.types.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.
`bool`(name, **kwargs)	Defines a property on the object that is a boolean.
`clone`()	Clones the definition of the object.
`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.
`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.
`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.
`str`(name[, allow_empty])	Defines a property on the object that is a string.
`to_json`()	Converts the object definition to JSON.
`uploaded_file`(name, **kwargs)	Defines a property on the object that is an uploaded file.
`view`(name, view, **kwargs)	Defines a view-only 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

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

clone()¶

Clones the definition of the object.

Returns: an Object

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

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

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

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

to_json()¶

Converts the object definition to JSON.

Returns: a JSON dict

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

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

class fiftyone.operators.types.View(**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 space to allocate out of 12
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

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

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

Note

You can only use inferred views for input properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

A form view.

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

A read-only View.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

class fiftyone.operators.types.Choice(value, **kwargs)¶

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`()

clone()¶

Clones the Choice.

Returns: a Choice

to_json()¶

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

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

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

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

clone()¶

to_json()¶

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

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:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

to_json()¶

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

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.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

to_json()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

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`()
`to_json`()

clone()¶

to_json()¶

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

Represents a header in a View.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Represents a warning in a View.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Represents an error in a View.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Represents a button in a View.

Examples:

import fiftyone.operators.types as types

button = types.Button(
    label="Click me",
    operator="print_stdout",
    params={"message": "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

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

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:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Displays a list of View instances.

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Displays a tuple of View instances.

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

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:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

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:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Displays a tabbed view.

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

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

to_json()¶

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

Displays a JSON viewer.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays an autocomplete input.

Note

This view can be used in place of Choices.

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

to_json()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

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 value will be the file base64 encoded contents. If used on a UploadedFile, the value will be a UploadedFile object.

Parameters

max_size – the maximum size of the file in bytes
max_size_error_message – the error message to display if the file larger than the given max_size

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a hyperlink.

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

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Allows properties to be hidden from the user.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Bases: fiftyone.operators.types.ReadOnlyView

Displays a loading indicator.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a Plotly chart.

Note

See https://github.com/plotly/react-plotly.js/#basic-props for documentation.

Parameters

data (None) – the chart data
config (None) – the chart config
layout (None) – the chart layout

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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¶

Bases: enum.Enum

The places available to operators in the FiftyOne App.

Attributes:

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

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)¶

Displays a key-value editor.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

A column in a TableView.

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

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a table.

Parameters: columns (None) – a list of Column objects to display

Methods:

`add_column`(key, **kwargs)
`clone`()
`keys`()
`to_json`()

keys()¶

add_column(key, **kwargs)¶

clone()¶

to_json()¶

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

Displays a key-value mapping.

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

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:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Displays an image.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays an alert.

Parameters

severity (None) – the severity of the alert displayed, one of
`` (info", "success", "warning", "error") –

Methods:

`clone`()
`to_json`()

to_json()¶

clone()¶

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

Displays a checkbox.

Note

Must be used with Boolean properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays an error.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a header component.

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

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays an object component.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Bases: fiftyone.operators.types.RadioGroup

Displays a radio component for the given RadioGroup instance.

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

to_json()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

Displays a toggle switch.

Note

Must be used with Boolean properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a text input.

Note

Must be used with String or Number properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a text input.

Note

Must be used with String or Number properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Bases: fiftyone.operators.types.Dropdown

Displays a dropdown selector input.

Methods:

`add_choice`(value, **kwargs)	Adds a choice value to this instance.
`clone`()
`to_json`()
`values`()	Returns the choice values for this instance.

add_choice(value, **kwargs)¶

Adds a choice value to this instance.

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

clone()¶

to_json()¶

values()¶

Returns the choice values for this instance.

Returns: a list of values

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

Displays a label-value component.

Note

Must be used with String, Number, or Boolean properties, or lists of such properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a primitive value component.

Note

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

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a slider component.

Note

This view must be used with Number properties.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Displays a list of tags component.

Note

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

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Represents a success in a View.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Bases: fiftyone.operators.types.Button

Represents a button in a Button.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

Renders a markdown string as HTML.

Methods:

`clone`()
`to_json`()

clone()¶

to_json()¶

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

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`()
`to_json`()

clone()¶

to_json()¶

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