Table of Contents
Contents

@fiftyone/utilities¶

Hooks¶

useItemsWithOrderPersistence¶

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

  • items (SortableItemsType) –

  • key (string) –

Return type

Object

Functions¶

applyAlpha¶

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

  • color (string) –

  • alpha (number) –

Return type

string

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

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

formatDate¶

@fiftyone/utilities.formatDate(timeStamp)¶
Arguments

  • timeStamp (number) –

Return type

string

formatDateTime¶

@fiftyone/utilities.formatDateTime(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 >

get32BitColor¶

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

  • color (Union< string , RGB >) –

  • alpha (number) –

Return type

number

getAPI¶

@fiftyone/utilities.getAPI()¶
Return type

any

getBasename¶

@fiftyone/utilities.getBasename(path)¶
Arguments

  • path (string) –

Return type

any

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< string , number , boolean >) –

Return type

string

getColorscaleArray¶

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

  • colorscale (Array< RGB >) –

  • alpha (number) –

Return type

Readonly < Uint32Array > < Uint32Array >

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()¶
Return type

plugins.fiftyone.utilities.FetchFunction()

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

  • schema (Schema) –

  • embeddedDocType (string) –

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

string

getSeparator¶

@fiftyone/utilities.getSeparator(pathType)¶
Arguments

  • pathType (PathType) –

Return type

string

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

isHex¶

@fiftyone/utilities.isHex(value)¶
Arguments

  • value (string) –

Return type

boolean

isNotebook¶

@fiftyone/utilities.isNotebook()¶
Return type

boolean

isNullish¶

@fiftyone/utilities.isNullish(value)¶
Arguments

  • value (any) –

Return type

boolean

isObjectIdString¶

@fiftyone/utilities.isObjectIdString(value)¶
Arguments

  • value (string) –

Return type

boolean

isPrimitiveString¶

@fiftyone/utilities.isPrimitiveString(value)¶
Arguments

  • value (unknown) –

Return type

boolean

isPrimitiveType¶

@fiftyone/utilities.isPrimitiveType(type)¶
Arguments

  • type (string) –

Return type

boolean

joinPaths¶

@fiftyone/utilities.joinPaths(paths)¶
Arguments

  • paths (Array< string >) –

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< string , >) –

  • __namedParameters.ftype (Union< string , >) –

Return type

boolean

move¶

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

  • array (Array< T >) –

  • moveIndex (number) –

  • toIndex (number) –

Return type

Array< plugins.fiftyone.utilities.T() >

pluralize¶

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

  • number (number) –

  • singular (Union< string , Element >) –

  • plural (Union< string , Element >) –

Return type

Union< string , Element >

prettify¶

@fiftyone/utilities.prettify(v)¶
Arguments

  • v (Union< string , number , boolean , >) –

Return type

Union< string , URL >

removeKeys¶

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

  • obj (KeyValue < T >) –

  • keys (Iterable < string >) –

  • 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

rgbToHexCached¶

@fiftyone/utilities.rgbToHexCached(color)¶
Arguments

  • color (RGB) –

Return type

any

sendEvent¶

@fiftyone/utilities.sendEvent(data)¶
Arguments

  • data (Any) –

Return type

Promise < unknown > < unknown >

setFetchFunction¶

@fiftyone/utilities.setFetchFunction(origin, headers, pathPrefix)¶
Arguments

  • origin (string) –

  • headers (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< string >) –

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'

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'

FetchFunction¶

class @fiftyone/utilities.FetchFunction()¶

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

subfield

string

GQLError¶

class @fiftyone/utilities.GQLError()¶

Properties¶

Name

Type

Description

extensions

Object

message

string

paths

Array< 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

subfield

string
class @fiftyone/utilities.BufferRange()¶

BufferRange¶

Name

Type

Description

BufferRange

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

Buffers¶

class @fiftyone/utilities.NumberKeyObjectType()¶

NumberKeyObjectType¶

class @fiftyone/utilities.Primitive()¶

Primitive¶

Union of number(), null(), string(), undefined(), Object()

class @fiftyone/utilities.RGB()¶

RGB¶

Copyright 2017-2024, Voxel51, Inc.

Name

Type

Description

RGB

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

RGBA¶

Name

Type

Description

RGBA

[ number , number , number , number ]

Enums¶

COLOR_BY¶

Name

Value

FIELD

INSTANCE

VALUE

PathType¶

Name

Value

LINUX

URL

WINDOWS

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 >

DETECTION¶

Name

Type

Description

'Detection'

DETECTIONS¶

Name

Type

Description

'Detections'

DETECTIONS_FIELD¶

Name

Type

Description

'fiftyone.core.labels.Detections'

DETECTION_DISABLED_SUB_PATHS¶

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

Name

Type

Description

'fiftyone.core.labels.Heatmap'

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'

MASK_LABELS¶

Name

Type

Description

Set < string >

Set < string > < string >

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'

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

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¶