@fiftyone/utilities#

Hooks#

useItemsWithOrderPersistence#

@fiftyone/utilities.useItemsWithOrderPersistence(items, key)#
Arguments:

  • items (Array)

  • key (string)

Return type:

Object

Functions#

applyAlpha#

@fiftyone/utilities.applyAlpha(color, alpha)#
Arguments:

  • color (string)

  • alpha (number)

Return type:

string

applyDeltas#

@fiftyone/utilities.applyDeltas(document, deltas)#
Arguments:
Return type:

plugins.fiftyone.utilities.T

Apply JSON-Patch deltas to a document and return the resulting document.

The single seam over the patch library: re-baselining a local store after a save folds the SAME deltas the server applied, so going through one shared primitive keeps client and server interpretations identical (and lets the implementation be swapped without touching callers). Pure — the input document is deep-cloned, never mutated.

buildSimilarityRunName#

@fiftyone/utilities.buildSimilarityRunName(__namedParameters)#
Arguments:

  • __namedParameters (Object)

  • __namedParameters.hasUploadedImage (boolean)

  • __namedParameters.isImageSearch (boolean)

  • __namedParameters.isUpload (boolean)

  • __namedParameters.negativeQueryIds (Array)

  • __namedParameters.patchesField (string)

  • __namedParameters.queryIds (Union)

  • __namedParameters.textQuery (string)

Return type:

string

Build a default display name for a similarity search run.

  • Text queries: return the raw query string

  • Upload queries: “1 image” / “0 images”

  • Image queries: “N samples” / “N patches” with optional negative counts

canPerformAction#

@fiftyone/utilities.canPerformAction(allowed, readOnly, action)#
Arguments:

  • allowed (boolean)

  • readOnly (boolean)

  • action (string)

Return type:

plugins.fiftyone.utilities.CanPerformActionReturnType

clearFetchCache#

@fiftyone/utilities.clearFetchCache()#
Return type:

void

Clears cached fetch responses.

clone#

@fiftyone/utilities.clone(data)#
Arguments:

  • data (T)

Return type:

plugins.fiftyone.utilities.Mutable < plugins.fiftyone.utilities.T >

createColorGenerator#

@fiftyone/utilities.createColorGenerator(colorPool, seed)#
Arguments:

  • colorPool (readonly)

  • seed ()

createResourceGroup#

@fiftyone/utilities.createResourceGroup()#
@fiftyone/utilities.createResourceGroup()#
Arguments:

  • key (string)

  • loader (( ))

Return type:

plugins.fiftyone.utilities.Resource < plugins.fiftyone.utilities.T >

dateFromDateString#

@fiftyone/utilities.dateFromDateString(v)#
Arguments:

  • v (string)

Return type:

number

dateFromDateTimeString#

@fiftyone/utilities.dateFromDateTimeString(timeZone, v)#
Arguments:

  • timeZone (string)

  • v (string)

Return type:

number

determinePathType#

@fiftyone/utilities.determinePathType(path)#
Arguments:

  • path (string)

Return type:

plugins.fiftyone.utilities.PathType

doesSchemaContainEmbeddedDocType#

@fiftyone/utilities.doesSchemaContainEmbeddedDocType(schema, embeddedDocType)#
Arguments:

  • schema (Schema)

  • embeddedDocType (string)

Return type:

boolean

env#

@fiftyone/utilities.env()#
Return type:

ImportMetaEnv

equalsNormalized#

@fiftyone/utilities.equalsNormalized(a, b)#
Arguments:

  • a (unknown)

  • b (unknown)

Return type:

boolean

Deep-equality check that first normalizes both sides via normalizeForCompare.

formatDate#

@fiftyone/utilities.formatDate(timeStamp)#
Arguments:

  • timeStamp (number)

Return type:

string

formatDatePicker#

@fiftyone/utilities.formatDatePicker(v)#
Arguments:

  • v (number)

Return type:

string

formatDateTime#

@fiftyone/utilities.formatDateTime(timeStamp, timeZone)#
Arguments:

  • timeStamp (number)

  • timeZone (string)

Return type:

string

formatDateTimePicker#

@fiftyone/utilities.formatDateTimePicker(timeZone, v)#
Arguments:

  • timeZone (string)

  • v (number)

Return type:

string

formatLongDateTime#

@fiftyone/utilities.formatLongDateTime(timeStamp, timeZone)#
Arguments:

  • timeStamp (number)

  • timeZone (string)

Return type:

string

formatPrimitive#

@fiftyone/utilities.formatPrimitive(__namedParameters)#
Arguments:

  • __namedParameters (Object)

  • __namedParameters.ftype (string)

  • __namedParameters.timeZone (string)

  • __namedParameters.value (Primitive)

Return type:

Union< string , URL >

formatValueAsNumber#

@fiftyone/utilities.formatValueAsNumber(value, fractionDigits)#
Arguments:

  • value (Union)

  • fractionDigits (number)

Return type:

Union< string , number >

get32BitColor#

@fiftyone/utilities.get32BitColor(color, alpha)#
Arguments:

  • color (Union)

  • alpha (number)

Return type:

number

getAPI#

@fiftyone/utilities.getAPI()#
Return type:

any

getBasename#

@fiftyone/utilities.getBasename(path)#
Arguments:

  • path (string)

Return type:

any

getClickModifiers#

@fiftyone/utilities.getClickModifiers(event)#
Arguments:

  • event (PointerEvent)

Return type:

plugins.fiftyone.utilities.ClickEventModifiers

Extract the ClickEventModifiers from a PointerEvent.

getCls#

@fiftyone/utilities.getCls(fieldPath, schema)#
Arguments:

  • fieldPath (string)

  • schema (Schema)

Return type:

Union< string , undefined >

getColor#

@fiftyone/utilities.getColor(pool, seed, fieldOrValue)#
Arguments:

  • pool (readonly)

  • seed (number)

  • fieldOrValue (Union)

Return type:

string

getColorscaleArray#

@fiftyone/utilities.getColorscaleArray(colorscale, alpha)#
Arguments:

  • colorscale (Array)

  • alpha (number)

Return type:

Readonly < Uint32Array > < Uint32Array >

getDenseLabelNames#

@fiftyone/utilities.getDenseLabelNames(schema)#
Arguments:
Return type:

Array< string >

getEventSource#

@fiftyone/utilities.getEventSource(path, events, signal, body)#
Arguments:

  • path (string)

  • events (Object)

  • events.onclose (( ))

  • events.onerror (( error : Error ))

  • events.onmessage (( event : EventSourceMessage ))

  • events.onopen (( ))

  • signal (AbortSignal)

  • body (Any)

Return type:

void

getFetchFunction#

@fiftyone/utilities.getFetchFunction(options)#
Arguments:
Return type:

plugins.fiftyone.utilities.FetchFunction

Returns the configured fetch function singleton.

getFetchFunctionExtended#

@fiftyone/utilities.getFetchFunctionExtended()#

Wrapper for getFetchFunction which provides response headers and configuration via FetchFunctionConfig.

@fiftyone/utilities.getFetchFunctionExtended()#
Arguments:

  • config (FetchFunctionConfig)

Return type:

Promise < FetchFunctionResult > < plugins.fiftyone.utilities.FetchFunctionResult >

getFetchHeaders#

@fiftyone/utilities.getFetchHeaders()#
Return type:

HeadersInit

getFetchOrigin#

@fiftyone/utilities.getFetchOrigin()#
Return type:

any

getFetchParameters#

@fiftyone/utilities.getFetchParameters()#
Return type:

Object

getFetchPathPrefix#

@fiftyone/utilities.getFetchPathPrefix()#
Return type:

string

getFieldInfo#

@fiftyone/utilities.getFieldInfo(fieldPath, schema)#
Arguments:

  • fieldPath (string)

  • schema (Schema)

Return type:

Union< plugins.fiftyone.utilities.Field , undefined >

getFieldsWithEmbeddedDocType#

@fiftyone/utilities.getFieldsWithEmbeddedDocType(schema, embeddedDocType, shouldRecurse)#
Arguments:

  • schema (Schema)

  • embeddedDocType (Union)

  • shouldRecurse (boolean)

Return type:

Array< plugins.fiftyone.utilities.Field >

getMimeType#

@fiftyone/utilities.getMimeType(sample)#
Arguments:

  • sample (Sample)

Return type:

string

getProtocol#

@fiftyone/utilities.getProtocol(path)#
Arguments:

  • path (string)

Return type:

string

getRGB#

@fiftyone/utilities.getRGB(color)#
Arguments:

  • color (string)

Return type:

plugins.fiftyone.utilities.RGB

getRGBA#

@fiftyone/utilities.getRGBA(value)#
Arguments:

  • value (number)

Return type:

plugins.fiftyone.utilities.RGBA

getRGBAColor#

@fiftyone/utilities.getRGBAColor(__namedParameters)#
Arguments:

  • __namedParameters (RGBA)

Return type:

string

getRootOrProtocol#

@fiftyone/utilities.getRootOrProtocol(path)#
Arguments:

  • path (string)

Return type:

any

getSamplePathExtension#

@fiftyone/utilities.getSamplePathExtension(path)#
Arguments:

  • path (string)

Return type:

string

Returns the normalized file extension for a sample path or media URL.

Supports raw filepaths as well as direct asset URLs

getSeparator#

@fiftyone/utilities.getSeparator(pathType)#
Arguments:

  • pathType (PathType)

Return type:

string

hasNonMongoFields#

@fiftyone/utilities.hasNonMongoFields(_mediaType)#
Arguments:

  • _mediaType (string)

Return type:

boolean

Returns true if the dataset has fields outside the Mongo sample collection — i.e. fields the standard lightning resolver can’t see. Always false in OSS; overridden in Enterprise where multimodal datasets carry parquet-backed fields alongside their Mongo doc.

Callers use this to disable Query Performance for affected datasets so the sidebar falls back to the standard aggregations path.

hasValidBounds#

@fiftyone/utilities.hasValidBounds(boundingBox)#
Arguments:

  • boundingBox ([ number , number , number , number ])

Return type:

boolean

Checks whether a bounding box has finite bounds with a positive width and height.

hexToRgb#

@fiftyone/utilities.hexToRgb(hex)#
Arguments:

  • hex (string)

Return type:

plugins.fiftyone.utilities.RGB

humanReadableBytes#

@fiftyone/utilities.humanReadableBytes(bytes)#
Arguments:

  • bytes (number)

Return type:

string

idAlignedListDelta#

@fiftyone/utilities.idAlignedListDelta(current, baseline, containerPath, listChild, spec)#
Arguments:

  • current (readonly)

  • baseline (readonly)

  • containerPath (string)

  • listChild (string)

  • spec (IdAlignedDeltaSpec)

Return type:

plugins.fiftyone.utilities.JSONDeltas

Build a JSON-Patch delta for one label list, aligning edited current items to the server baseline by id rather than by array position. Emits, under <containerPath>/<listChild>/...: an add (/-) for current items with no baseline match, in-place diffMatched ops for items on both sides (at their baseline index), and `remove`s for removed ids in DESCENDING index order so an earlier remove never shifts an index a later one references.

Index-aligned diffing floods unappliable replaces when a list shifts (a deleted slot slides every later slot down); id-alignment avoids that and stays safe against baseline entries the client never saw. This is the shared shape behind the per-frame video-label diff and the temporal-detection diff — generalized over the list child so it serves any list-label field.

interpolateColorsHex#

@fiftyone/utilities.interpolateColorsHex(color1, color2, factor)#
Arguments:

  • color1 (string)

  • color2 (string)

  • factor (number)

Return type:

string

interpolateColorsRgb#

@fiftyone/utilities.interpolateColorsRgb(rgb1, rgb2, factor)#
Arguments:

  • rgb1 (RGB)

  • rgb2 (RGB)

  • factor (number)

Return type:

plugins.fiftyone.utilities.RGB

is3d#

@fiftyone/utilities.is3d(mediaType)#
Arguments:

  • mediaType (string)

Return type:

boolean

Returns true if the provided media type is FO3D or point cloud.

isAnnotationSupported#

@fiftyone/utilities.isAnnotationSupported(mediaType)#
Arguments:

  • mediaType (string)

Return type:

boolean

Returns true if annotation is supported for the provided media type.

isDirect3dSamplePath#

@fiftyone/utilities.isDirect3dSamplePath(path)#
Arguments:

  • path (string)

Return type:

boolean

Returns true when the provided sample path points to a supported direct 3D asset.

isFo3d#

@fiftyone/utilities.isFo3d(mediaType)#
Arguments:

  • mediaType (string)

Return type:

boolean

Returns true if the provided media type is associated with FO3D.

isFo3dSamplePath#

@fiftyone/utilities.isFo3dSamplePath(path)#
Arguments:

  • path (string)

Return type:

boolean

Returns true when the provided sample path points to a real FO3D scene file.

isFrameInSupport#

@fiftyone/utilities.isFrameInSupport(support, frame)#
Arguments:

  • support (unknown)

  • frame (number)

Return type:

Whether frame falls within support’s inclusive [first, last] range.

Distinct from isValidSupport: this is a frame-containment gate with no finiteness / ordering check — it answers “should this TD render at this frame”, not “is this support well-formed”.

isFunctionalComponent#

@fiftyone/utilities.isFunctionalComponent(value)#
Arguments:

  • value (unknown)

Return type:

isHex#

@fiftyone/utilities.isHex(value)#
Arguments:

  • value (string)

Return type:

boolean

isListLabelType#

@fiftyone/utilities.isListLabelType(type)#
Arguments:

  • type (LabelType)

Return type:

boolean

True if the given label type is a list label (e.g. Detections).

isMultimodal#

@fiftyone/utilities.isMultimodal(mediaType)#
Arguments:

  • mediaType (string)

Return type:

boolean

Returns true if the provided media type is multimodal.

isNativeMediaType#

@fiftyone/utilities.isNativeMediaType(mediaType)#
Arguments:

  • mediaType (string)

Return type:

Returns true if the provided media type is handled by FiftyOne’s built-in renderers.

isNotebook#

@fiftyone/utilities.isNotebook()#
Return type:

boolean

isNullish#

@fiftyone/utilities.isNullish(value)#
Arguments:

  • value (any)

Return type:

boolean

isObject#

@fiftyone/utilities.isObject(data)#
Arguments:

  • data (unknown)

Return type:

Return true if the provided data is an object.

isObjectIdString#

@fiftyone/utilities.isObjectIdString(value, strict)#
Arguments:

  • value (string)

  • strict (boolean)

Return type:

boolean

isPointCloud#

@fiftyone/utilities.isPointCloud(mediaType)#
Arguments:

  • mediaType (string)

Return type:

boolean

Returns true if the provided media type is associated with point clouds.

isPrimitiveString#

@fiftyone/utilities.isPrimitiveString(value)#
Arguments:

  • value (unknown)

Return type:

boolean

isPrimitiveType#

@fiftyone/utilities.isPrimitiveType(type)#
Arguments:

  • type (string)

Return type:

boolean

isTemporalDetectionsField#

@fiftyone/utilities.isTemporalDetectionsField(value)#
Arguments:

  • value (unknown)

Return type:

Type guard for a TemporalDetections wrapper field.

isValidSupport#

@fiftyone/utilities.isValidSupport(support)#
Arguments:

  • support (unknown)

Return type:

A valid TD support is a 2-tuple [first, last] of finite frame numbers with last >= first. Use when validating a support before building a track.

isWrappableDirect3dSamplePath#

@fiftyone/utilities.isWrappableDirect3dSamplePath(path)#
Arguments:

  • path (string)

Return type:

boolean

Returns true when the provided sample path points to a direct 3D asset that can be wrapped into a synthetic FO3D scene.

joinPaths#

@fiftyone/utilities.joinPaths(paths)#
Arguments:

  • paths (Array)

Return type:

string

makePseudoField#

@fiftyone/utilities.makePseudoField(path)#
Arguments:

  • path (string)

Return type:

plugins.fiftyone.utilities.Field

meetsFieldType#

@fiftyone/utilities.meetsFieldType(field, __namedParameters)#
Arguments:

  • field (Field)

  • __namedParameters (Object)

  • __namedParameters.acceptLists (boolean)

  • __namedParameters.embeddedDocType (Union)

  • __namedParameters.ftype (Union)

Return type:

boolean

mergeHeaders#

@fiftyone/utilities.mergeHeaders(headers)#
Arguments:

  • headers (Array)

Return type:

Record < string , string > < string , string >

move#

@fiftyone/utilities.move(array, moveIndex, toIndex)#
Arguments:

  • array (Array)

  • moveIndex (number)

  • toIndex (number)

Return type:

Array< plugins.fiftyone.utilities.T >

objectId#

@fiftyone/utilities.objectId()#
Return type:

string

Utility to generate mongo-like ObjectId

pluralize#

@fiftyone/utilities.pluralize(number, singular, plural)#
Arguments:

  • number (number)

  • singular (Union)

  • plural (Union)

Return type:

Union< string , Element >

pluralizeUnit#

@fiftyone/utilities.pluralizeUnit(count, unit)#
Arguments:

  • count (number)

  • unit (string)

Return type:

string

Pluralize a unit string: adds “s” for most words, “es” for “patch”.

prettify#

@fiftyone/utilities.prettify(v)#
Arguments:

  • v (Union)

Return type:

Union< string , URL >

removeKeys#

@fiftyone/utilities.removeKeys(obj, keys, startsWith)#
Arguments:

  • obj (KeyValue)

  • keys (Iterable)

  • startsWith (boolean)

Return type:

plugins.fiftyone.utilities.KeyValue < plugins.fiftyone.utilities.T >

resolveAncestors#

@fiftyone/utilities.resolveAncestors(path)#
Arguments:

  • path (string)

Return type:

Array< string >

resolveParent#

@fiftyone/utilities.resolveParent(path)#
Arguments:

  • path (string)

Return type:

string

rgbStringToHex#

@fiftyone/utilities.rgbStringToHex(rgb)#
Arguments:

  • rgb (string)

Return type:

string

Convert RGB string to hex

Returns

hex string (e.g. “#ffffff”)

Throws

if the RGB string is invalid

rgbToHexCached#

@fiftyone/utilities.rgbToHexCached(color)#
Arguments:
Return type:

any

sendEvent#

@fiftyone/utilities.sendEvent(data)#
Arguments:

  • data (Any)

Return type:

Promise < unknown > < unknown >

setContains3d#

@fiftyone/utilities.setContains3d(mediaTypes)#
Arguments:

  • mediaTypes (Set)

Return type:

boolean

Returns true if the provided set contains any media types which are associated with FO3D or point clouds.

setContainsFo3d#

@fiftyone/utilities.setContainsFo3d(mediaTypes)#
Arguments:

  • mediaTypes (Set)

Return type:

boolean

Returns true if the provided set contains any media types which are associated with FO3D.

setContainsPointCloud#

@fiftyone/utilities.setContainsPointCloud(mediaTypes)#
Arguments:

  • mediaTypes (Set)

Return type:

boolean

Returns true if the provided set contains any media types which are associated with point clouds.

setFetchFunction#

@fiftyone/utilities.setFetchFunction(origin, defaultHeaders, pathPrefix)#
Arguments:

  • origin (string)

  • defaultHeaders (HeadersInit)

  • pathPrefix (string)

Return type:

void

setFetchParameters#

@fiftyone/utilities.setFetchParameters(origin, headers, pathPrefix)#
Arguments:

  • origin (string)

  • headers (HeadersInit)

  • pathPrefix (string)

Return type:

void

sizeBytesEstimate#

@fiftyone/utilities.sizeBytesEstimate(object)#
Arguments:

  • object (SizeTypes)

Return type:

number

toCamelCase#

@fiftyone/utilities.toCamelCase(obj)#
Arguments:

  • obj (O)

Return type:

plugins.fiftyone.utilities.O

toSlug#

@fiftyone/utilities.toSlug(name)#
Arguments:

  • name (string)

Return type:

string

toSnakeCase#

@fiftyone/utilities.toSnakeCase(obj)#
Arguments:

  • obj (O)

Return type:

plugins.fiftyone.utilities.O

withPath#

@fiftyone/utilities.withPath(path, types)#
Arguments:

  • path (string)

  • types (string)

Return type:

string

@fiftyone/utilities.withPath(path, types)#
Arguments:

  • path (string)

  • types (Array)

Return type:

Array< string >

Types#

APP_MODE#

Name

Type

Description

'fiftyone'

ARRAY_FIELD#

Name

Type

Description

'fiftyone.core.fields.ArrayField'

BOOLEAN_FIELD#

Name

Type

Description

'fiftyone.core.fields.BooleanField'

CLASSIFICATIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Classifications'

CLASSIFICATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Classification'

DATE_FIELD#

Name

Type

Description

'fiftyone.core.fields.DateField'

DATE_TIME_FIELD#

Name

Type

Description

'fiftyone.core.fields.DateTimeField'

DETECTIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Detections'

DETECTION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Detection'

DETECTION_FILED#

Name

Type

Description

'fiftyone.core.labels.Detection'

DICT_FIELD#

Name

Type

Description

'fiftyone.core.fields.DictField'

DYNAMIC_EMBEDDED_DOCUMENT_FIELD#

Name

Type

Description

'fiftyone.core.fields.DynamicEmbeddedDocumentField'

DYNAMIC_EMBEDDED_DOCUMENT_PATH#

Name

Type

Description

'fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument'

EMBEDDED_DOCUMENT_FIELD#

Name

Type

Description

'fiftyone.core.fields.EmbeddedDocumentField'

FLOAT_FIELD#

Name

Type

Description

'fiftyone.core.fields.FloatField'

FRAME_NUMBER_FIELD#

Name

Type

Description

'fiftyone.core.fields.FrameNumberField'

FRAME_SUPPORT_FIELD#

Name

Type

Description

'fiftyone.core.fields.FrameSupportField'

GEO_LOCATIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.GeoLocations'

GEO_LOCATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.GeoLocation'

GROUP#

Name

Type

Description

'fiftyone.core.groups.Group'

HEATMAP_FIELD#

Name

Type

Description

'fiftyone.core.labels.Heatmap'

INT_FIELD#

Name

Type

Description

'fiftyone.core.fields.IntField'

IS_APP_MODE_FIFTYONE#

Name

Type

Description

boolean

JUST_FIELD#

Name

Type

Description

'fiftyone.core.fields.Field'

KEYPOINTS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Keypoints'

KEYPOINTS_POINTS_FIELD#

Name

Type

Description

'fiftyone.core.fields.KeypointsField'

KEYPOINT_FIELD#

Name

Type

Description

'fiftyone.core.labels.Keypoint'

LIST_FIELD#

Name

Type

Description

'fiftyone.core.fields.ListField'

OBJECT_ID_FIELD#

Name

Type

Description

'fiftyone.core.fields.ObjectIdField'

POLYLINES_FIELD#

Name

Type

Description

'fiftyone.core.labels.Polylines'

POLYLINE_FIELD#

Name

Type

Description

'fiftyone.core.labels.Polyline'

REGRESSION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Regression'

SEGMENTATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Segmentation'

STRING_FIELD#

Name

Type

Description

'fiftyone.core.fields.StringField'

TEMPORAL_DETECTIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.TemporalDetections'

TEMPORAL_DETECTION_FIELD#

Name

Type

Description

'fiftyone.core.labels.TemporalDetection'

UUID_FIELD#

Name

Type

Description

'fiftyone.core.fields.UUIDField'

VECTOR_FIELD#

Name

Type

Description

'fiftyone.core.fields.VectorField'

scrollbarStyles#

Name

Type

Description

'\n--scrollbar-color: var(--fo-palette-text-tertiary);\n\n@-moz-document url-prefix() {\n  & {\n    scrollbar-color: var(--scrollbar-color) transparent;\n    scrollbar-width: thin;\n  }\n}\n\n&::-webkit-scrollbar {\n  height: 14px;\n  width: 14px;\n}\n\n&::-webkit-scrollbar-corner {\n  background: transparent;\n}\n\n&::-webkit-scrollbar-track {\n  box-shadow: inset 0 0 14px 14px transparent;\n  height: 14px;\n  width: 14px;\n}\n\n&::-webkit-scrollbar-thumb {\n  border: solid 3px transparent;\n  border-radius: 0;\n  box-shadow: inset 0 0 8px 8px var(--scrollbar-color);\n}\n'

DateTimeInput#

@fiftyone/utilities.DateTimeInput(props)#
Arguments:

  • props (PolymorphicComponentProps)

Return type:

Element

@fiftyone/utilities.DateTimeInput(props)#
Arguments:

  • props (FastOmit)

Return type:

ReactElement < any ,  > < any , Union< string , JSXElementConstructor > >

NOTE: Exotic components are not callable.

DateTimeInputContainer#

@fiftyone/utilities.DateTimeInputContainer(props)#
Arguments:

  • props (PolymorphicComponentProps)

Return type:

Element

@fiftyone/utilities.DateTimeInputContainer(props)#
Arguments:

  • props (FastOmit)

Return type:

ReactElement < any ,  > < any , Union< string , JSXElementConstructor > >

NOTE: Exotic components are not callable.

FetchFunction#

class @fiftyone/utilities.FetchFunction()#

FetchFunctionExtended#

class @fiftyone/utilities.FetchFunctionExtended()#

Field#

class @fiftyone/utilities.Field()#

Properties#

Name

Type

Description

dbField

string

description

string

embeddedDocType

string

fields

plugins.fiftyone.utilities.Schema

ftype

string

info

object

name

string

path

string

pathWithDbField

string

readOnly

boolean

subfield

string

FrameLabelSnapshot#

class @fiftyone/utilities.FrameLabelSnapshot()#

Properties#

Name

Type

Description

detections

Array< plugins.fiftyone.utilities.SyntheticBox >

frameNumber

number

GQLError#

class @fiftyone/utilities.GQLError()#

Properties#

Name

Type

Description

extensions

Object

message

string

paths

Array< string >

IdAlignedDeltaSpec#

class @fiftyone/utilities.IdAlignedDeltaSpec()#

Injected specifics for idAlignedListDelta. All optional — the defaults cover the common label-list case (id = _id, structural diff of a matched item, normalized whole-item add). Override per shape: temporal detections key on a different id and remove via an explicit tombstone set.

Properties#

(set-diff); supply explicitly when absence doesn’t imply deletion.”

“serializeAdd”,”( current : plugins.fiftyone.utilities.TCurrent )”

LocalDetection#

class @fiftyone/utilities.LocalDetection()#

Shape callers pass to VideoFrameLabelsStream.updateLabel. Lines up with the Detection wire format — bounding_box is required since a Detection with no bbox is meaningless for a video overlay.

Properties#

drag, resize) should pass keyframe: true so an interpolated label is promoted to a keyframe on touch. Omit to preserve the existing value through updateLabel’s shallow merge.”

“label”,”string” “propagation”,”plugins.fiftyone.utilities.PropagationBlob”,”Propagation provenance. User edits clear this (null); leave

undefined to preserve the existing value through the shallow merge.”

PropagationBlob#

class @fiftyone/utilities.PropagationBlob()#

Provenance written on labels created by a propagation run.

Properties#

or SAM2 between two keyframes); one for a SAM2 forward run that tracks from a single seed keyframe to the end of the clip.”

“run_id”,”string”

RawDetection#

class @fiftyone/utilities.RawDetection()#

Properties#

Name

Type

Description

bounding_box

[ number , number , number , number ]

id

string

index

number

instance

Object

keyframe

boolean

label

string

mask

unknown

mask_path

string

propagation

plugins.fiftyone.utilities.PropagationBlob

RawDetectionsField#

class @fiftyone/utilities.RawDetectionsField()#

Properties#

Name

Type

Description

detections

Array< plugins.fiftyone.utilities.RawDetection >

RawPolyline#

class @fiftyone/utilities.RawPolyline()#

Properties#

Name

Type

Description

closed

boolean

filled

boolean

id

string

index

number

instance

Object

keyframe

boolean

label

string

points

Array< Array< [ number , number ] > >

propagation

plugins.fiftyone.utilities.PropagationBlob

RawPolylinesField#

class @fiftyone/utilities.RawPolylinesField()#

Properties#

Name

Type

Description

polylines

Array< plugins.fiftyone.utilities.RawPolyline >

RawTemporalDetection#

class @fiftyone/utilities.RawTemporalDetection()#

Shape of a single TemporalDetection as it arrives on the modal sample dict. Only the fields consumers read are modeled; everything else (dynamic attrs, etc.) is preserved via the index signature for downstream consumers.

Properties#

Name

Type

Description

[key]

string

confidence

number

id

string

label

string

support

[ number , number ]

1-indexed inclusive frame range [first, last].

RawTemporalDetectionsField#

class @fiftyone/utilities.RawTemporalDetectionsField()#

Shape of a TemporalDetections wrapper field on the modal sample dict.

Properties#

Name

Type

Description

detections

Array< plugins.fiftyone.utilities.RawTemporalDetection >

SampleChange#

class @fiftyone/utilities.SampleChange()#

A single field-level mutation, delivered to subscribeChanges subscribers so they can reconcile their own view of the sample without re-diffing the whole thing.

  • path — the dot-delimited field path that changed (e.g. ground_truth, metadata.size_bytes). The empty string "" is the whole-sample reset sentinel: the entire sample was replaced (setData) or all edits dropped (clear), so subscribers should rebuild from a fresh snapshot.

  • labelId — for a list label (Detections, etc.), the _id of the element that changed; absent for single labels and primitives.

  • kind — see SampleChangeKind.

Properties#

Name

Type

Description

kind

plugins.fiftyone.utilities.SampleChangeKind

labelId

string

path

string

Schema#

class @fiftyone/utilities.Schema()#

Name

Type

Description

[key]

string

Stage#

class @fiftyone/utilities.Stage()#

Properties#

Name

Type

Description

kwargs

Array< [ string , object ] >

StrictField#

class @fiftyone/utilities.StrictField()#

Properties#

Name

Type

Description

dbField

string

description

string

embeddedDocType

string

fields

Array< plugins.fiftyone.utilities.StrictField >

ftype

string

info

object

name

string

path

string

pathWithDbField

string

readOnly

boolean

subfield

string

SyntheticBox#

class @fiftyone/utilities.SyntheticBox()#

Properties#

mapping can use COLOR_BY.INSTANCE’s ${label}-${index}-... hash (otherwise instance mode would collapse tracked detections of the same class to one color).”

“instance”,”Object”,”Mirrors BaseLabel.instance from @fiftyone/looker. Used as

the fallback COLOR_BY.INSTANCE hash seed for untracked detections, and as a stable instance id for the synthetic stream (which has no numeric index).”

“keyframe”,”boolean”,”true for user-authored / propagation source; false for interpolated.” “label”,”string” “propagation”,”plugins.fiftyone.utilities.PropagationBlob”,”Provenance for propagation-created labels; null for keyframes.”

class @fiftyone/utilities.BufferRange()#

BufferRange#

Name

Type

Description

BufferRange

Readonly <  > < [ number , number ] >
class @fiftyone/utilities.Buffers()#

Buffers#

class @fiftyone/utilities.ClickEventModifiers()#

ClickEventModifiers#

Modifier flags associated with a PointerEvent.

Name

Type

Description

ClickEventModifiers.altKey

boolean

ClickEventModifiers.ctrlKey

boolean

ClickEventModifiers.metaKey

boolean

ClickEventModifiers.shiftKey

boolean
class @fiftyone/utilities.FetchFunctionConfig()#

FetchFunctionConfig#

Configuration for a fetch call.

derived from the request method, path, and body.”

“FetchFunctionConfig.errorHandler”,”( response : Response )” “FetchFunctionConfig.headers”,”Record < string , string > < string , string >” “FetchFunctionConfig.method”,”string” “FetchFunctionConfig.path”,”string” “FetchFunctionConfig.result”,”plugins.fiftyone.utilities.FetchResultType” “FetchFunctionConfig.retries”,”number” “FetchFunctionConfig.retryCodes”,”Array< number >”

class @fiftyone/utilities.FetchFunctionResult()#

FetchFunctionResult#

Parsed fetch response with response headers.

Name

Type

Description

FetchFunctionResult.headers

Headers

FetchFunctionResult.response

plugins.fiftyone.utilities.T
class @fiftyone/utilities.FetchResultType()#

FetchResultType#

Supported methods for accessing response data.

Union of 'json', 'blob', 'text', 'arrayBuffer', 'json-stream'

class @fiftyone/utilities.GetFetchFunctionOptions()#

GetFetchFunctionOptions#

Options for getFetchFunction.

derived from the request method, path, and body.”

class @fiftyone/utilities.JSONDeltaSupplier()#

JSONDeltaSupplier#

class @fiftyone/utilities.JSONDeltas()#

JSONDeltas#

List of JSON-patch operation deltas between two versions of a json object.

class @fiftyone/utilities.LabelData()#

LabelData#

Minimal shape of a fiftyone label document.

class @fiftyone/utilities.NativeMediaType()#

NativeMediaType#

Union of :js:class:, :js:class:, :js:class:, :js:class:, :js:class:``

class @fiftyone/utilities.NumberKeyObjectType()#

NumberKeyObjectType#

class @fiftyone/utilities.ObjectIdHex()#

ObjectIdHex#

ObjectId hex string.

Name

Type

Description

ObjectIdHex

string
class @fiftyone/utilities.Primitive()#

Primitive#

Union of number, null, string, undefined, Object

class @fiftyone/utilities.PropagationMethod()#

PropagationMethod#

Union of 'linear', 'sam2'

class @fiftyone/utilities.RGB()#

RGB#

Copyright 2017-2026, Voxel51, Inc.

Name

Type

Description

RGB

[ number , number , number ]
class @fiftyone/utilities.RGBA()#

RGBA#

Name

Type

Description

RGBA

[ number , number , number , number ]
class @fiftyone/utilities.RecognizedMediaType()#

RecognizedMediaType#

Union of NativeMediaType, :js:class:``

class @fiftyone/utilities.SampleChangeListener()#

SampleChangeListener#

class @fiftyone/utilities.SampleOptions()#

SampleOptions#

Constructor options for Sample.

from the transient after a successful persist (see reconcilePersisted and DEFAULT_SERVER_OWNED_FIELDS). Defaults to mask/mask_path/map/map_path.”

class @fiftyone/utilities.SerializedMask()#

SerializedMask#

Segmentation mask — base64-encoded compressed numpy array, or MongoDB binary wrapper.

Union of string, Object

class @fiftyone/utilities.TransientSnapshot()#

TransientSnapshot#

A captured copy of the transient edit state (pending data + pending deletions), for transaction atomicity: capture via snapshotTransient, roll back via restoreTransient. Source data is never part of a snapshot — only setData/reconcilePersisted write it, and those are not transactional mutations.

Name

Type

Description

TransientSnapshot.transientData

Record < string , unknown > < string , unknown >

TransientSnapshot.transientDeletes

ReadonlySet < string > < string >

Enums#

COLOR_BY#

Name

Value

FIELD

INSTANCE

VALUE

LabelType#

Label-type taxonomy for the Sample model: the supported fiftyone label types, their list-vs-single classification, and the mapping to/from embedded-document type strings.

Name

Value

Classification

Classifications

Detection

Detections

Keypoint

Keypoints

Polyline

Polylines

TemporalDetection

TemporalDetections

Unknown

PathType#

Name

Value

LINUX

URL

WINDOWS

SampleChangeKind#

The nature of a SampleChange: Update/Delete for in-session edits; Reset for a rebuild (whole-sample via the "" path sentinel, or per-path after reconcilePersisted releases a server-owned field).

Name

Value

Delete

Reset

Update

Variables#

AGGS#

Name

Type

Description

BOUNDS

string

COUNT

string

COUNT_VALUES

string

DISTINCT

string

ARRAY_FIELD#

Name

Type

Description

'fiftyone.core.fields.ArrayField'

BIG_ENDIAN#

Name

Type

Description

boolean

BOOLEAN_FIELD#

Name

Type

Description

'fiftyone.core.fields.BooleanField'

BUILT_IN_PANEL_PRIORITY_CONST#

Name

Type

Description

51000

CLASSIFICATION#

Name

Type

Description

'Classification'

CLASSIFICATIONS#

Name

Type

Description

'Classifications'

CLASSIFICATIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Classifications'

CLASSIFICATION_DISABLED_SUB_PATHS#

CLASSIFICATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Classification'

CLIPS_FRAME_FIELDS#

CLIPS_SAMPLE_FIELDS#

DATE_FIELD#

Name

Type

Description

'fiftyone.core.fields.DateField'

DATE_TIME_FIELD#

Name

Type

Description

'fiftyone.core.fields.DateTimeField'

DENSE_LABELS#

Name

Type

Description

Set < string >

Set < string > < string >

DENSE_LABEL_EMBEDDED_DOC_TYPES#

DETECTION#

Name

Type

Description

'Detection'

DETECTIONS#

Name

Type

Description

'Detections'

DETECTIONS_EMBEDDED_DOC_TYPE#

Name

Type

Description

'fiftyone.core.labels.Detections'

DETECTIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Detections'

DETECTION_DISABLED_SUB_PATHS#

DETECTION_EMBEDDED_DOC_TYPE#

Name

Type

Description

'fiftyone.core.labels.Detection'

DETECTION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Detection'

DETECTION_FILED#

Name

Type

Description

'fiftyone.core.labels.Detection'

DICT_FIELD#

Name

Type

Description

'fiftyone.core.fields.DictField'

DISABLED_LABEL_FIELDS_VISIBILITY#

DISABLED_PATHS#

DYNAMIC_EMBEDDED_DOCUMENT#

Name

Type

Description

'DynamicEmbeddedDocument'

DYNAMIC_EMBEDDED_DOCUMENT_FIELD#

Name

Type

Description

'fiftyone.core.fields.DynamicEmbeddedDocumentField'

DYNAMIC_EMBEDDED_DOCUMENT_PATH#

Name

Type

Description

'fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument'

DYNAMIC_GROUP_FIELDS#

EMBEDDED_DOCUMENT#

Name

Type

Description

'EmbeddedDocument'

EMBEDDED_DOCUMENT_FIELD#

Name

Type

Description

'fiftyone.core.fields.EmbeddedDocumentField'

FLOAT_FIELD#

Name

Type

Description

'fiftyone.core.fields.FloatField'

FRAME_NUMBER_FIELD#

Name

Type

Description

'fiftyone.core.fields.FrameNumberField'

FRAME_SUPPORT_FIELD#

Name

Type

Description

'fiftyone.core.fields.FrameSupportField'

GEOLOCATION#

Name

Type

Description

'GeoLocation'

GEOLOCATIONS#

Name

Type

Description

'GeoLocations'

GEOLOCATIONS_DISABLED_SUB_PATHS#

GEOLOCATION_DISABLED_SUB_PATHS#

GEO_LOCATIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.GeoLocations'

GEO_LOCATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.GeoLocation'

GROUP#

Name

Type

Description

'fiftyone.core.groups.Group'

HEATMAP#

Name

Type

Description

'Heatmap'

HEATMAP_DISABLED_SUB_PATHS#

HEATMAP_EMBEDDED_DOC_TYPE#

Name

Type

Description

'fiftyone.core.labels.Heatmap'

HEATMAP_FIELD#

Name

Type

Description

'fiftyone.core.labels.Heatmap'

INPUT_TYPE_DATE#

Name

Type

Description

'date'

INPUT_TYPE_DATE_TIME#

Name

Type

Description

'datetime-local'

INT_FIELD#

Name

Type

Description

'fiftyone.core.fields.IntField'

JUST_FIELD#

Name

Type

Description

'fiftyone.core.fields.Field'

KEYPOINT#

Name

Type

Description

'Keypoint'

KEYPOINTS#

Name

Type

Description

'Keypoints'

KEYPOINTS_FIELD#

Name

Type

Description

'fiftyone.core.labels.Keypoints'

KEYPOINTS_POINTS_FIELD#

Name

Type

Description

'fiftyone.core.fields.KeypointsField'

KEYPOINT_DISABLED_SUB_PATHS#

KEYPOINT_FIELD#

Name

Type

Description

'fiftyone.core.labels.Keypoint'

LABELS#

LABELS_MAP#

Name

Type

Description

Classification

string

Classifications

string

Detection

string

Detections

string

GeoLocation

string

GeoLocations

string

Heatmap

string

Keypoint

string

Keypoints

string

Polyline

string

Polylines

string

Regression

string

Segmentation

string

TemporalDetection

string

TemporalDetections

string

LABELS_PATH#

Name

Type

Description

'fiftyone.core.labels'

LABEL_DOC_TYPES#

LABEL_LIST#

Name

Type

Description

Classifications

string

Detections

string

Keypoints

string

Polylines

string

TemporalDetections

string

LABEL_LISTS#

LABEL_LISTS_MAP#

Name

Type

Description

Classifications

string

Detections

string

Keypoints

string

Polylines

string

TemporalDetections

string

LABEL_LIST_PATH#

LIST_FIELD#

Name

Type

Description

'fiftyone.core.fields.ListField'

LIST_LABEL_CHILD#

For list-label types, the parent field’s child key holding the element array (e.g. a Detections field stores its elements under detections).

Name

Type

Description

Partial < Record >

Partial < Record > < Record < LabelType , string > >

MASK_LABELS#

Name

Type

Description

Set < string >

Set < string > < string >

MEDIA_TYPE_3D#

Name

Type

Description

'3d'

MEDIA_TYPE_GROUP#

Name

Type

Description

'group'

MEDIA_TYPE_IMAGE#

Name

Type

Description

'image'

MEDIA_TYPE_MULTIMODAL#

Name

Type

Description

'multimodal'

MEDIA_TYPE_POINT_CLOUD#

Name

Type

Description

'point-cloud'

MEDIA_TYPE_VIDEO#

Name

Type

Description

'video'

NONFINITES#

Name

Type

Description

Set < string >

Set < string > < string >

NOT_VISIBLE_LIST#

OBJECT_ID_FIELD#

Name

Type

Description

'fiftyone.core.fields.ObjectIdField'

PATCHES_FIELDS#

POLYLINE#

Name

Type

Description

'Polyline'

POLYLINES#

Name

Type

Description

'Polylines'

POLYLINES_FIELD#

Name

Type

Description

'fiftyone.core.labels.Polylines'

POLYLINE_DISABLED_SUB_PATHS#

POLYLINE_FIELD#

Name

Type

Description

'fiftyone.core.labels.Polyline'

PRIMITIVE#

Name

Type

Description

'Primitive'

PRIMITIVES#

Name

Type

Description

'Primitives'

REGRESSION#

Name

Type

Description

'Regression'

REGRESSION_DISABLED_SUB_PATHS#

REGRESSION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Regression'

RESERVED_FIELD_KEYS#

SEGMENTATION#

Name

Type

Description

'Segmentation'

SEGMENTATION_DISABLED_SUB_PATHS#

SEGMENTATION_EMBEDDED_DOC_TYPE#

Name

Type

Description

'fiftyone.core.labels.Segmentation'

SEGMENTATION_FIELD#

Name

Type

Description

'fiftyone.core.labels.Segmentation'

SKIP_FIELD_TYPES#

STRING_FIELD#

Name

Type

Description

'fiftyone.core.fields.StringField'

TEMPORAL_DETECTION#

Name

Type

Description

'TemporalDetection'

TEMPORAL_DETECTIONS#

Name

Type

Description

'TemporalDetections'

TEMPORAL_DETECTIONS_FIELD#

Name

Type

Description

'fiftyone.core.labels.TemporalDetections'

TEMPORAL_DETECTION_DISABLED_SUB_PATHS#

TEMPORAL_DETECTION_FIELD#

Name

Type

Description

'fiftyone.core.labels.TemporalDetection'

UNSUPPORTED_FILTER_TYPES#

UUID_FIELD#

Name

Type

Description

'fiftyone.core.fields.UUIDField'

VALID_CLASS_TYPES#

VALID_DISTRIBUTION_TYPES#

VALID_KEYPOINTS#

VALID_LABEL_TYPES#

VALID_LIST_FIELDS#

VALID_LIST_LABEL_FIELDS#

VALID_LIST_TYPES#

VALID_MASK_TYPES#

VALID_NON_LIST_LABEL_TYPES#

VALID_NUMERIC_TYPES#

VALID_OBJECT_TYPES#

VALID_PRIMITIVE_TYPES#

VECTOR_FIELD#

Name

Type

Description

'fiftyone.core.fields.VectorField'

default_app_color#

IN THIS ARTICLE