<!-- # hard line break macro for HTML -->

# fiftyone.core.session.events

Session events.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Classes:**

| [`Event`](#fiftyone.core.session.events.Event)()                                                     | Base server event                                       |
|------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| [`LabelData`](#fiftyone.core.session.events.LabelData)(label_id, field, sample_id[, ...])            |                                                         |
| [`Screenshot`](#fiftyone.core.session.events.Screenshot)(bytes, max_width)                           |                                                         |
| [`CaptureNotebookCell`](#fiftyone.core.session.events.CaptureNotebookCell)(subscription, src, width) | Capture notebook cell screenshot event                  |
| [`CloseSession`](#fiftyone.core.session.events.CloseSession)()                                       | Close session event                                     |
| [`DeactivateNotebookCell`](#fiftyone.core.session.events.DeactivateNotebookCell)()                   | Deactivate notebook cell event                          |
| [`Ping`](#fiftyone.core.session.events.Ping)()                                                       | Ping (builtin) event                                    |
| [`ReactivateNotebookCell`](#fiftyone.core.session.events.ReactivateNotebookCell)(subscription)       | Reactivate notebook cell event                          |
| [`Refresh`](#fiftyone.core.session.events.Refresh)(state)                                            | Refresh event                                           |
| [`SelectLabels`](#fiftyone.core.session.events.SelectLabels)(labels)                                 | Select labels event                                     |
| [`SelectSamples`](#fiftyone.core.session.events.SelectSamples)(samples)                              | Select samples event                                    |
| [`SetSampleSelectionStyle`](#fiftyone.core.session.events.SetSampleSelectionStyle)(style)            | Set the sample selection icon style.                    |
| [`SetLabelSelectionStyle`](#fiftyone.core.session.events.SetLabelSelectionStyle)(style)              | Set the label selection visual style.                   |
| [`ValueColor`](#fiftyone.core.session.events.ValueColor)(color, value)                               |                                                         |
| [`MaskColor`](#fiftyone.core.session.events.MaskColor)(color, intTarget)                             |                                                         |
| [`CustomizeColor`](#fiftyone.core.session.events.CustomizeColor)(path[, fieldColor, ...])            |                                                         |
| [`ColorscaleList`](#fiftyone.core.session.events.ColorscaleList)(value, color)                       |                                                         |
| [`Colorscale`](#fiftyone.core.session.events.Colorscale)(path[, name, list])                         |                                                         |
| [`DefaultColorscale`](#fiftyone.core.session.events.DefaultColorscale)([name, list])                 |                                                         |
| [`LabelTagsColors`](#fiftyone.core.session.events.LabelTagsColors)([fieldColor, valueColors])        |                                                         |
| [`ColorScheme`](#fiftyone.core.session.events.ColorScheme)([color_pool, color_by, ...])              |                                                         |
| [`SetColorScheme`](#fiftyone.core.session.events.SetColorScheme)(color_scheme)                       | Set color scheme event                                  |
| [`SetDatasetColorScheme`](#fiftyone.core.session.events.SetDatasetColorScheme)()                     | Set dataset color scheme event                          |
| [`SetSample`](#fiftyone.core.session.events.SetSample)([group_id, sample_id])                        | Set sample event                                        |
| [`SetSpaces`](#fiftyone.core.session.events.SetSpaces)(spaces)                                       | Set spaces event                                        |
| [`SetGroupSlice`](#fiftyone.core.session.events.SetGroupSlice)(slice)                                | Set group slice eventt                                  |
| [`SetFieldVisibilityStage`](#fiftyone.core.session.events.SetFieldVisibilityStage)([stage])          |                                                         |
| [`StateUpdate`](#fiftyone.core.session.events.StateUpdate)(state)                                    | State update event                                      |
| [`AppInitializer`](#fiftyone.core.session.events.AppInitializer)([dataset, group_id, ...])           |                                                         |
| [`ListenPayload`](#fiftyone.core.session.events.ListenPayload)(initializer, events, subscription)    | An initialization payload for an event listener request |

**Functions:**

| [`add_screenshot`](#fiftyone.core.session.events.add_screenshot)(event)               |    |
|---------------------------------------------------------------------------------------|----|
| [`dict_factory`](#fiftyone.core.session.events.dict_factory)(data)                    |    |
| [`get_screenshot`](#fiftyone.core.session.events.get_screenshot)(subscription[, pop]) |    |

### *class* fiftyone.core.session.events.Event

Bases: `object`

Base server event

**Methods:**

| [`get_event_name`](#fiftyone.core.session.events.Event.get_event_name)()                   |    |
|--------------------------------------------------------------------------------------------|----|
| [`from_data`](#fiftyone.core.session.events.Event.from_data)(event_name, data)             |    |
| [`from_data_async`](#fiftyone.core.session.events.Event.from_data_async)(event_name, data) |    |
| [`serialize`](#fiftyone.core.session.events.Event.serialize)()                             |    |

#### *classmethod* get_event_name() → str

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### serialize()

### *class* fiftyone.core.session.events.LabelData(label_id: str, field: str, sample_id: str, frame_number: int | None = None, instance_id: str | None = None, type: str = 'default')

Bases: `object`

**Attributes:**

| [`label_id`](#fiftyone.core.session.events.LabelData.label_id)         |    |
|------------------------------------------------------------------------|----|
| [`field`](#fiftyone.core.session.events.LabelData.field)               |    |
| [`sample_id`](#fiftyone.core.session.events.LabelData.sample_id)       |    |
| [`frame_number`](#fiftyone.core.session.events.LabelData.frame_number) |    |
| [`instance_id`](#fiftyone.core.session.events.LabelData.instance_id)   |    |
| [`type`](#fiftyone.core.session.events.LabelData.type)                 |    |

#### label_id *: str*

#### field *: str*

#### sample_id *: str*

#### frame_number *: int | None* *= None*

#### instance_id *: str | None* *= None*

#### type *: str* *= 'default'*

### *class* fiftyone.core.session.events.Screenshot(bytes: [bytes](#fiftyone.core.session.events.Screenshot.bytes), max_width: int)

Bases: `object`

**Attributes:**

| [`bytes`](#fiftyone.core.session.events.Screenshot.bytes)         |    |
|-------------------------------------------------------------------|----|
| [`max_width`](#fiftyone.core.session.events.Screenshot.max_width) |    |

#### bytes *: [bytes](#fiftyone.core.session.events.Screenshot.bytes)*

#### max_width *: int*

### *class* fiftyone.core.session.events.CaptureNotebookCell(subscription: str, src: str, width: int)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Capture notebook cell screenshot event

**Attributes:**

| [`subscription`](#fiftyone.core.session.events.CaptureNotebookCell.subscription)   |    |
|------------------------------------------------------------------------------------|----|
| [`src`](#fiftyone.core.session.events.CaptureNotebookCell.src)                     |    |
| [`width`](#fiftyone.core.session.events.CaptureNotebookCell.width)                 |    |

**Methods:**

| [`from_data`](#fiftyone.core.session.events.CaptureNotebookCell.from_data)(event_name, data)             |    |
|----------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.CaptureNotebookCell.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.CaptureNotebookCell.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.CaptureNotebookCell.serialize)()                             |    |

#### subscription *: str*

#### src *: str*

#### width *: int*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.CloseSession

Bases: [`Event`](#fiftyone.core.session.events.Event)

Close session event

**Methods:**

| [`from_data`](#fiftyone.core.session.events.CloseSession.from_data)(event_name, data)             |    |
|---------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.CloseSession.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.CloseSession.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.CloseSession.serialize)()                             |    |

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.DeactivateNotebookCell

Bases: [`Event`](#fiftyone.core.session.events.Event)

Deactivate notebook cell event

**Methods:**

| [`from_data`](#fiftyone.core.session.events.DeactivateNotebookCell.from_data)(event_name, data)             |    |
|-------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.DeactivateNotebookCell.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.DeactivateNotebookCell.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.DeactivateNotebookCell.serialize)()                             |    |

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.Ping

Bases: [`Event`](#fiftyone.core.session.events.Event)

Ping (builtin) event

**Methods:**

| [`from_data`](#fiftyone.core.session.events.Ping.from_data)(event_name, data)             |    |
|-------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.Ping.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.Ping.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.Ping.serialize)()                             |    |

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.ReactivateNotebookCell(subscription: str)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Reactivate notebook cell event

**Attributes:**

| [`subscription`](#fiftyone.core.session.events.ReactivateNotebookCell.subscription)   |    |
|---------------------------------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.ReactivateNotebookCell.from_data)(event_name, data)             |    |
|-------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.ReactivateNotebookCell.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.ReactivateNotebookCell.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.ReactivateNotebookCell.serialize)()                             |    |

#### subscription *: str*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.Refresh(state: [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription))

Bases: [`Event`](#fiftyone.core.session.events.Event)

Refresh event

**Attributes:**

| [`state`](#fiftyone.core.session.events.Refresh.state)   |    |
|----------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.Refresh.from_data)(event_name, data)             |    |
|----------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.Refresh.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.Refresh.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.Refresh.serialize)()                             |    |

#### state *: [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription)*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SelectLabels(labels: List[[LabelData](#fiftyone.core.session.events.LabelData)])

Bases: [`Event`](#fiftyone.core.session.events.Event)

Select labels event

**Attributes:**

| [`labels`](#fiftyone.core.session.events.SelectLabels.labels)   |    |
|-----------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SelectLabels.from_data)(event_name, data)             |    |
|---------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SelectLabels.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SelectLabels.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SelectLabels.serialize)()                             |    |

#### labels *: List[[LabelData](#fiftyone.core.session.events.LabelData)]*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SelectSamples(samples: List[Dict])

Bases: [`Event`](#fiftyone.core.session.events.Event)

Select samples event

**Attributes:**

| [`samples`](#fiftyone.core.session.events.SelectSamples.samples)   |    |
|--------------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SelectSamples.from_data)(event_name, data)             |    |
|----------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SelectSamples.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SelectSamples.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SelectSamples.serialize)()                             |    |

#### samples *: List[Dict]*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetSampleSelectionStyle(style: Dict)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set the sample selection icon style.

#### style

a dict with `"default"` and `"alt"` keys mapping to icon
style names (e.g. `"checkmark"`, `"thumbsup"`, etc.)

* **Type:**
  Dict

**Attributes:**

| [`style`](#id0)   |    |
|-------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetSampleSelectionStyle.from_data)(event_name, data)             |    |
|--------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetSampleSelectionStyle.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetSampleSelectionStyle.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetSampleSelectionStyle.serialize)()                             |    |

#### style *: Dict*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetLabelSelectionStyle(style: Dict)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set the label selection visual style.

#### style

a dict with `"default"` and `"alt"` keys mapping to label
selection style names (e.g. `"dashed"`, `"dashed-red"`, etc.)

* **Type:**
  Dict

**Attributes:**

| [`style`](#id1)   |    |
|-------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetLabelSelectionStyle.from_data)(event_name, data)             |    |
|-------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetLabelSelectionStyle.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetLabelSelectionStyle.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetLabelSelectionStyle.serialize)()                             |    |

#### style *: Dict*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.ValueColor(color: str, value: str)

Bases: `object`

**Attributes:**

| [`color`](#fiftyone.core.session.events.ValueColor.color)   |    |
|-------------------------------------------------------------|----|
| [`value`](#fiftyone.core.session.events.ValueColor.value)   |    |

#### color *: str*

#### value *: str*

### *class* fiftyone.core.session.events.MaskColor(color: str, intTarget: int | None)

Bases: `object`

**Attributes:**

| [`color`](#fiftyone.core.session.events.MaskColor.color)         |    |
|------------------------------------------------------------------|----|
| [`intTarget`](#fiftyone.core.session.events.MaskColor.intTarget) |    |

#### color *: str*

#### intTarget *: int | None*

### *class* fiftyone.core.session.events.CustomizeColor(path: str, fieldColor: str | None = None, colorByAttribute: str | None = None, valueColors: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.ValueColor](#fiftyone.core.session.events.ValueColor)] | None = None, maskTargetsColors: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.MaskColor](#fiftyone.core.session.events.MaskColor)] | None = None)

Bases: `object`

**Attributes:**

| [`path`](#fiftyone.core.session.events.CustomizeColor.path)                           |    |
|---------------------------------------------------------------------------------------|----|
| [`fieldColor`](#fiftyone.core.session.events.CustomizeColor.fieldColor)               |    |
| [`colorByAttribute`](#fiftyone.core.session.events.CustomizeColor.colorByAttribute)   |    |
| [`valueColors`](#fiftyone.core.session.events.CustomizeColor.valueColors)             |    |
| [`maskTargetsColors`](#fiftyone.core.session.events.CustomizeColor.maskTargetsColors) |    |

#### path *: str*

#### fieldColor *: str | None* *= None*

#### colorByAttribute *: str | None* *= None*

#### valueColors *: List[[ValueColor](#fiftyone.core.session.events.ValueColor)] | None* *= None*

#### maskTargetsColors *: List[[MaskColor](#fiftyone.core.session.events.MaskColor)] | None* *= None*

### *class* fiftyone.core.session.events.ColorscaleList(value: float, color: str)

Bases: `object`

**Attributes:**

| [`value`](#fiftyone.core.session.events.ColorscaleList.value)   |    |
|-----------------------------------------------------------------|----|
| [`color`](#fiftyone.core.session.events.ColorscaleList.color)   |    |

#### value *: float*

#### color *: str*

### *class* fiftyone.core.session.events.Colorscale(path: str, name: str | None = None, list: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.ColorscaleList](#fiftyone.core.session.events.ColorscaleList)] | None = None)

Bases: `object`

**Attributes:**

| [`path`](#fiftyone.core.session.events.Colorscale.path)   |    |
|-----------------------------------------------------------|----|
| [`name`](#fiftyone.core.session.events.Colorscale.name)   |    |
| [`list`](#fiftyone.core.session.events.Colorscale.list)   |    |

**Methods:**

| [`serialize`](#fiftyone.core.session.events.Colorscale.serialize)()   |    |
|-----------------------------------------------------------------------|----|

#### path *: str*

#### name *: str | None* *= None*

#### list *: List[[ColorscaleList](#fiftyone.core.session.events.ColorscaleList)] | None* *= None*

#### serialize()

### *class* fiftyone.core.session.events.DefaultColorscale(name: str | None = None, list: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.ColorscaleList](#fiftyone.core.session.events.ColorscaleList)] | None = None)

Bases: `object`

**Attributes:**

| [`name`](#fiftyone.core.session.events.DefaultColorscale.name)   |    |
|------------------------------------------------------------------|----|
| [`list`](#fiftyone.core.session.events.DefaultColorscale.list)   |    |

**Methods:**

| [`serialize`](#fiftyone.core.session.events.DefaultColorscale.serialize)()   |    |
|------------------------------------------------------------------------------|----|

#### name *: str | None* *= None*

#### list *: List[[ColorscaleList](#fiftyone.core.session.events.ColorscaleList)] | None* *= None*

#### serialize()

### *class* fiftyone.core.session.events.LabelTagsColors(fieldColor: str | None = None, valueColors: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.ValueColor](#fiftyone.core.session.events.ValueColor)] | None = None)

Bases: `object`

**Attributes:**

| [`fieldColor`](#fiftyone.core.session.events.LabelTagsColors.fieldColor)   |    |
|----------------------------------------------------------------------------|----|
| [`valueColors`](#fiftyone.core.session.events.LabelTagsColors.valueColors) |    |

#### fieldColor *: str | None* *= None*

#### valueColors *: List[[ValueColor](#fiftyone.core.session.events.ValueColor)] | None* *= None*

### *class* fiftyone.core.session.events.ColorScheme(color_pool: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[str] | None = None, color_by: str | None = None, multicolor_keypoints: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None = None, opacity: float | None = None, show_skeletons: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None = None, fields: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.CustomizeColor](#fiftyone.core.session.events.CustomizeColor)] | None = None, default_mask_targets_colors: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.MaskColor](#fiftyone.core.session.events.MaskColor)] | None = None, colorscales: [List](fiftyone.operators.types.md#fiftyone.operators.types.List)[[fiftyone.core.session.events.Colorscale](#fiftyone.core.session.events.Colorscale)] | None = None, default_colorscale: [fiftyone.core.session.events.DefaultColorscale](#fiftyone.core.session.events.DefaultColorscale) | None = None, label_tags: [fiftyone.core.session.events.LabelTagsColors](#fiftyone.core.session.events.LabelTagsColors) | None = None)

Bases: `object`

**Attributes:**

| [`color_pool`](#fiftyone.core.session.events.ColorScheme.color_pool)                                   |    |
|--------------------------------------------------------------------------------------------------------|----|
| [`color_by`](#fiftyone.core.session.events.ColorScheme.color_by)                                       |    |
| [`multicolor_keypoints`](#fiftyone.core.session.events.ColorScheme.multicolor_keypoints)               |    |
| [`opacity`](#fiftyone.core.session.events.ColorScheme.opacity)                                         |    |
| [`show_skeletons`](#fiftyone.core.session.events.ColorScheme.show_skeletons)                           |    |
| [`fields`](#fiftyone.core.session.events.ColorScheme.fields)                                           |    |
| [`default_mask_targets_colors`](#fiftyone.core.session.events.ColorScheme.default_mask_targets_colors) |    |
| [`colorscales`](#fiftyone.core.session.events.ColorScheme.colorscales)                                 |    |
| [`default_colorscale`](#fiftyone.core.session.events.ColorScheme.default_colorscale)                   |    |
| [`label_tags`](#fiftyone.core.session.events.ColorScheme.label_tags)                                   |    |

**Methods:**

| [`serialize`](#fiftyone.core.session.events.ColorScheme.serialize)()   |    |
|------------------------------------------------------------------------|----|

#### color_pool *: List[str] | None* *= None*

#### color_by *: str | None* *= None*

#### multicolor_keypoints *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None* *= None*

#### opacity *: float | None* *= None*

#### show_skeletons *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None* *= None*

#### fields *: List[[CustomizeColor](#fiftyone.core.session.events.CustomizeColor)] | None* *= None*

#### default_mask_targets_colors *: List[[MaskColor](#fiftyone.core.session.events.MaskColor)] | None* *= None*

#### colorscales *: List[[Colorscale](#fiftyone.core.session.events.Colorscale)] | None* *= None*

#### default_colorscale *: [DefaultColorscale](#fiftyone.core.session.events.DefaultColorscale) | None* *= None*

#### label_tags *: [LabelTagsColors](#fiftyone.core.session.events.LabelTagsColors) | None* *= None*

#### serialize()

### *class* fiftyone.core.session.events.SetColorScheme(color_scheme: [ColorScheme](#fiftyone.core.session.events.ColorScheme))

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set color scheme event

**Attributes:**

| [`color_scheme`](#fiftyone.core.session.events.SetColorScheme.color_scheme)   |    |
|-------------------------------------------------------------------------------|----|

**Methods:**

| [`from_odm`](#fiftyone.core.session.events.SetColorScheme.from_odm)(color_scheme)                   |    |
|-----------------------------------------------------------------------------------------------------|----|
| [`to_odm`](#fiftyone.core.session.events.SetColorScheme.to_odm)()                                   |    |
| [`from_data`](#fiftyone.core.session.events.SetColorScheme.from_data)(event_name, data)             |    |
| [`from_data_async`](#fiftyone.core.session.events.SetColorScheme.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetColorScheme.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetColorScheme.serialize)()                             |    |

#### color_scheme *: [ColorScheme](#fiftyone.core.session.events.ColorScheme)*

#### *classmethod* from_odm(color_scheme: [ColorScheme](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme))

#### to_odm()

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetDatasetColorScheme

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set dataset color scheme event

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetDatasetColorScheme.from_data)(event_name, data)             |    |
|------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetDatasetColorScheme.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetDatasetColorScheme.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetDatasetColorScheme.serialize)()                             |    |

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetSample(group_id: str | None = None, sample_id: str | None = None)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set sample event

**Attributes:**

| [`group_id`](#fiftyone.core.session.events.SetSample.group_id)   |    |
|------------------------------------------------------------------|----|
| [`sample_id`](#fiftyone.core.session.events.SetSample.sample_id) |    |

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetSample.from_data)(event_name, data)             |    |
|------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetSample.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetSample.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetSample.serialize)()                             |    |

#### group_id *: str | None* *= None*

#### sample_id *: str | None* *= None*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetSpaces(spaces: Dict)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set spaces event

**Attributes:**

| [`spaces`](#fiftyone.core.session.events.SetSpaces.spaces)   |    |
|--------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetSpaces.from_data)(event_name, data)             |    |
|------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetSpaces.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetSpaces.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetSpaces.serialize)()                             |    |

#### spaces *: Dict*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetGroupSlice(slice: str)

Bases: [`Event`](#fiftyone.core.session.events.Event)

Set group slice eventt

**Attributes:**

| [`slice`](#fiftyone.core.session.events.SetGroupSlice.slice)   |    |
|----------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetGroupSlice.from_data)(event_name, data)             |    |
|----------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetGroupSlice.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetGroupSlice.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetGroupSlice.serialize)()                             |    |

#### slice *: str*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.SetFieldVisibilityStage(stage: Dict | None = None)

Bases: [`Event`](#fiftyone.core.session.events.Event)

**Attributes:**

| [`stage`](#fiftyone.core.session.events.SetFieldVisibilityStage.stage)   |    |
|--------------------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.SetFieldVisibilityStage.from_data)(event_name, data)             |    |
|--------------------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.SetFieldVisibilityStage.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.SetFieldVisibilityStage.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.SetFieldVisibilityStage.serialize)()                             |    |

#### stage *: Dict | None* *= None*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.StateUpdate(state: [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription))

Bases: [`Event`](#fiftyone.core.session.events.Event)

State update event

**Attributes:**

| [`state`](#fiftyone.core.session.events.StateUpdate.state)   |    |
|--------------------------------------------------------------|----|

**Methods:**

| [`from_data`](#fiftyone.core.session.events.StateUpdate.from_data)(event_name, data)             |    |
|--------------------------------------------------------------------------------------------------|----|
| [`from_data_async`](#fiftyone.core.session.events.StateUpdate.from_data_async)(event_name, data) |    |
| [`get_event_name`](#fiftyone.core.session.events.StateUpdate.get_event_name)()                   |    |
| [`serialize`](#fiftyone.core.session.events.StateUpdate.serialize)()                             |    |

#### state *: [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription)*

#### *static* from_data(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *async static* from_data_async(event_name: str, data: str | dict) → [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell) | [CloseSession](#fiftyone.core.session.events.CloseSession) | [DeactivateNotebookCell](#fiftyone.core.session.events.DeactivateNotebookCell) | [ReactivateNotebookCell](#fiftyone.core.session.events.ReactivateNotebookCell) | [SelectSamples](#fiftyone.core.session.events.SelectSamples) | [SelectLabels](#fiftyone.core.session.events.SelectLabels) | [SetColorScheme](#fiftyone.core.session.events.SetColorScheme) | [SetGroupSlice](#fiftyone.core.session.events.SetGroupSlice) | [SetSample](#fiftyone.core.session.events.SetSample) | [SetLabelSelectionStyle](#fiftyone.core.session.events.SetLabelSelectionStyle) | [SetSampleSelectionStyle](#fiftyone.core.session.events.SetSampleSelectionStyle) | [SetSpaces](#fiftyone.core.session.events.SetSpaces) | [StateUpdate](#fiftyone.core.session.events.StateUpdate) | [SetFieldVisibilityStage](#fiftyone.core.session.events.SetFieldVisibilityStage)

#### *classmethod* get_event_name() → str

#### serialize()

### *class* fiftyone.core.session.events.AppInitializer(dataset: str | None = None, group_id: str | None = None, group_slice: str | None = None, sample_id: str | None = None, view: str | None = None, workspace: str | None = None)

Bases: `object`

**Attributes:**

| [`dataset`](#fiftyone.core.session.events.AppInitializer.dataset)         |    |
|---------------------------------------------------------------------------|----|
| [`group_id`](#fiftyone.core.session.events.AppInitializer.group_id)       |    |
| [`group_slice`](#fiftyone.core.session.events.AppInitializer.group_slice) |    |
| [`sample_id`](#fiftyone.core.session.events.AppInitializer.sample_id)     |    |
| [`view`](#fiftyone.core.session.events.AppInitializer.view)               |    |
| [`workspace`](#fiftyone.core.session.events.AppInitializer.workspace)     |    |

#### dataset *: str | None* *= None*

#### group_id *: str | None* *= None*

#### group_slice *: str | None* *= None*

#### sample_id *: str | None* *= None*

#### view *: str | None* *= None*

#### workspace *: str | None* *= None*

### *class* fiftyone.core.session.events.ListenPayload(initializer: [AppInitializer](#fiftyone.core.session.events.AppInitializer) | None | [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription), events: List[str], subscription: str, polling: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None = False)

Bases: `object`

An initialization payload for an event listener request

**Attributes:**

| [`initializer`](#fiftyone.core.session.events.ListenPayload.initializer)   |    |
|----------------------------------------------------------------------------|----|
| [`events`](#fiftyone.core.session.events.ListenPayload.events)             |    |
| [`subscription`](#fiftyone.core.session.events.ListenPayload.subscription) |    |
| [`polling`](#fiftyone.core.session.events.ListenPayload.polling)           |    |

**Methods:**

| [`from_dict`](#fiftyone.core.session.events.ListenPayload.from_dict)(d)   |    |
|---------------------------------------------------------------------------|----|

#### initializer *: [AppInitializer](#fiftyone.core.session.events.AppInitializer) | None | [StateDescription](fiftyone.core.state.md#fiftyone.core.state.StateDescription)*

#### events *: List[str]*

#### subscription *: str*

#### polling *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None* *= False*

#### *async classmethod* from_dict(d: dict) → [ListenPayload](#fiftyone.core.session.events.ListenPayload)

### fiftyone.core.session.events.add_screenshot(event: [CaptureNotebookCell](#fiftyone.core.session.events.CaptureNotebookCell)) → None

### fiftyone.core.session.events.dict_factory(data: List[Tuple[str, Any]]) → Dict[str, Any]

### fiftyone.core.session.events.get_screenshot(subscription: str, pop=False) → [Screenshot](#fiftyone.core.session.events.Screenshot)
