@fiftyone/utilities#
Hooks#
useExternalLink#
- @fiftyone/utilities.useExternalLink(_href)#
- Arguments:
_href ()
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:
document (
T)deltas (
JSONDeltas)
- 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
classifyLabelOps#
- @fiftyone/utilities.classifyLabelOps(__namedParameters)#
- Arguments:
__namedParameters (
ClassifyLabelOpsArgs)
- Return type:
plugins.fiftyone.utilities.LabelOpsSummary
Classifies one persisted patch into deduped per-label operation sets.
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#
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
dateOnlyToUTC#
- @fiftyone/utilities.dateOnlyToUTC(date)#
- Arguments:
date (
Date)
- Return type:
string
Serialize a picker Date’s calendar date to an absolute instant at noon UTC, so the stored value renders as the same calendar date in every timezone
determinePathType#
- @fiftyone/utilities.determinePathType(path)#
- Arguments:
path (
string)
- Return type:
plugins.fiftyone.utilities.PathType
divergingDomain#
- @fiftyone/utilities.divergingDomain(min, max)#
- Arguments:
min (
number)max (
number)
- Return type:
[number,number]
The domain a zero-centered read maps signed values through: symmetric (±max(|min|, |max|)) so the ramp’s MIDDLE stop is zero. Untouched for data that does not cross zero.
doesSchemaContainEmbeddedDocType#
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#
formatRelativeTime#
- @fiftyone/utilities.formatRelativeTime(timestamp)#
- Arguments:
timestamp (
number)
- Return type:
Union<string,null>
Format an absolute timestamp as a relative time string, e.g. “3 hours ago”
Returns
the relative time string, or null for an invalid timestamp
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:
string
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#
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#
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:
options (
GetFetchFunctionOptions)
- 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:
string
getFetchParameters#
- @fiftyone/utilities.getFetchParameters()#
- Return type:
Object
getFetchPathPrefix#
- @fiftyone/utilities.getFetchPathPrefix()#
- Return type:
string
getFieldInfo#
getFieldsWithEmbeddedDocType#
getMimeType#
- @fiftyone/utilities.getMimeType(sample, selectedMediaPath)#
- Arguments:
sample (
MimeSample)selectedMediaPath (
string)
- Return type:
string
Returns the MIME type for a sample or an explicitly selected media path.
Sample metadata describes the root filepath only, so alternate media
paths are inferred independently from their normalized extension.
getProtocol#
- @fiftyone/utilities.getProtocol(path)#
- Arguments:
path (
string)
- Return type:
Union<string,undefined>
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#
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#
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.
isEmptyLabelOps#
- @fiftyone/utilities.isEmptyLabelOps(ops)#
- Arguments:
ops (
LabelOpsSummary)
- Return type:
boolean
True when the summary carries no operations.
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#
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>
rampDomain#
- @fiftyone/utilities.rampDomain(lo, hi, ramp)#
- Arguments:
lo (
number)hi (
number)ramp (
ContinuousRamp)
- Return type:
[number,number]
The values a ramp’s two ends stand for: a diverging ramp is symmetric about zero so its middle stop IS zero; every other ramp spans min..max. A legend reads its labels from here, so it cannot name a value at an end that end was never given.
rampGradient#
- @fiftyone/utilities.rampGradient(rampId)#
- Arguments:
rampId (
Union)
- Return type:
string
A left-to-right CSS gradient of a whole ramp — one color stop per ramp stop, so the bar a picker row draws is the ramp the consumer gets.
rampIdForEntry#
- @fiftyone/utilities.rampIdForEntry(entry)#
- Arguments:
entry (
unknown)
- Return type:
Union<plugins.fiftyone.utilities.ContinuousRampId,null>
Which ramp a scheme colorscale entry is, or null for a custom or absent one (e.g. a named scale or hand-edited list in the color settings modal).
rampList#
- @fiftyone/utilities.rampList(rampId)#
- Arguments:
rampId (
Union)
- Return type:
Array<Object>
A ramp’s stops in the color scheme’s list wire shape (evenly spaced).
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#
sendEvent#
- @fiftyone/utilities.sendEvent(data)#
- Arguments:
data (
Any)
- Return type:
Promise < unknown ><unknown>
serializeDateValue#
- @fiftyone/utilities.serializeDateValue(type, date, timeZone)#
- Arguments:
type (
DateFieldType)date (
Date)timeZone (
string)
- Return type:
string
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
toPickerDate#
- @fiftyone/utilities.toPickerDate(type, timestamp, timeZone)#
- Arguments:
type (
DateFieldType)timestamp (
number)timeZone (
string)
- Return type:
Date
Convert an absolute timestamp into a Date whose local-timezone components match what the app displays for the field, suitable for react-datepicker
Returns
a Date whose local-time components carry the displayed date and time
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 |
|---|---|---|
|
ARRAY_FIELD#
Name |
Type |
Description |
|---|---|---|
|
BOOK_A_DEMO_LINK#
Name |
Type |
Description |
|---|---|---|
|
BOOLEAN_FIELD#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DATE_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DATE_TIME_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DETECTIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DETECTION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DETECTION_FILED#
Name |
Type |
Description |
|---|---|---|
|
DICT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DYNAMIC_EMBEDDED_DOCUMENT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DYNAMIC_EMBEDDED_DOCUMENT_PATH#
Name |
Type |
Description |
|---|---|---|
|
EMBEDDED_DOCUMENT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FLOAT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FRAME_NUMBER_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FRAME_SUPPORT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GEO_LOCATIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GEO_LOCATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GROUP#
Name |
Type |
Description |
|---|---|---|
|
HEATMAP_FIELD#
Name |
Type |
Description |
|---|---|---|
|
INT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
IS_APP_MODE_FIFTYONE#
Name |
Type |
Description |
|---|---|---|
|
JUST_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINTS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINTS_POINTS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
LIST_FIELD#
Name |
Type |
Description |
|---|---|---|
|
OBJECT_ID_FIELD#
Name |
Type |
Description |
|---|---|---|
|
POLYLINES_FIELD#
Name |
Type |
Description |
|---|---|---|
|
POLYLINE_FIELD#
Name |
Type |
Description |
|---|---|---|
|
REGRESSION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
SEGMENTATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
STRING_FIELD#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
TRY_IN_BROWSER_LINK#
Name |
Type |
Description |
|---|---|---|
|
UUID_FIELD#
Name |
Type |
Description |
|---|---|---|
|
VECTOR_FIELD#
Name |
Type |
Description |
|---|---|---|
|
scrollbarStyles#
Name |
Type |
Description |
|---|---|---|
|
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 >>
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 >>
ContinuousRamp#
- class @fiftyone/utilities.ContinuousRamp()#
The App’s curated continuous ramps, tuned for a dark canvas. The single
home for these definitions: consumers (e.g. the embeddings plot’s palette
picker) read them from here and write a pick into the color scheme as a
plain { value, color } list — the same wire shape the color settings
modal’s list tab writes and the server resolves to rgb.
None of these clip: the ends of a ramp are the true extremes. What a ramp changes is WHERE the perceptual contrast sits, which is the whole point when the interesting values are the rare ones at the edges.
Properties#
symmetric (±max(|min|, |max|)). Without it zero lands wherever it happens to fall, so a left turn and a right turn of equal size read as the same colour.”
“hint”,”
string” “label”,”string” “stops”,”readonly”,”Evenly-spaced stops, 0-1 floats per channel.”
FetchFunction#
- class @fiftyone/utilities.FetchFunction()#
FetchFunctionExtended#
- class @fiftyone/utilities.FetchFunctionExtended()#
Field#
- class @fiftyone/utilities.Field()#
Properties#
Name |
Type |
Description |
|---|---|---|
dbField |
|
|
description |
|
|
embeddedDocType |
|
|
fields |
|
|
ftype |
|
|
info |
|
|
name |
|
|
path |
|
|
pathWithDbField |
|
|
readOnly |
|
|
subfield |
|
FrameLabelSnapshot#
- class @fiftyone/utilities.FrameLabelSnapshot()#
Properties#
Name |
Type |
Description |
|---|---|---|
detections |
|
|
frameNumber |
|
GQLError#
- class @fiftyone/utilities.GQLError()#
Properties#
Name |
Type |
Description |
|---|---|---|
extensions |
|
|
message |
|
|
paths |
|
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)”
LabelOpsSummary#
- class @fiftyone/utilities.LabelOpsSummary()#
Properties#
labels): the shared instance id, else field#track<index> for
tracking-style labels. Consumers count/dedupe by
instanceOf[id] ?? id so one temporal detection materialized
across N frames reads as ONE label, while events keep the true
per-frame label id (FOEPD-4344 follow-up).”
“modified”,”
Array<string>”
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”
RawDetection#
- class @fiftyone/utilities.RawDetection()#
Properties#
Name |
Type |
Description |
|---|---|---|
bounding_box |
|
|
id |
|
|
index |
|
|
instance |
|
|
keyframe |
|
|
label |
|
|
mask |
|
|
mask_path |
|
RawDetectionsField#
- class @fiftyone/utilities.RawDetectionsField()#
Properties#
Name |
Type |
Description |
|---|---|---|
detections |
|
RawPolyline#
- class @fiftyone/utilities.RawPolyline()#
Properties#
Name |
Type |
Description |
|---|---|---|
closed |
|
|
filled |
|
|
id |
|
|
index |
|
|
instance |
|
|
keyframe |
|
|
label |
|
|
points |
|
RawPolylinesField#
- class @fiftyone/utilities.RawPolylinesField()#
Properties#
Name |
Type |
Description |
|---|---|---|
polylines |
|
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] |
|
|
confidence |
|
|
id |
|
|
label |
|
|
support |
|
1-indexed inclusive frame range |
RawTemporalDetectionsField#
- class @fiftyone/utilities.RawTemporalDetectionsField()#
Shape of a TemporalDetections wrapper field on the modal sample dict.
Properties#
Name |
Type |
Description |
|---|---|---|
detections |
|
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_idof the element that changed; absent for single labels and primitives.kind— seeSampleChangeKind.
Properties#
Name |
Type |
Description |
|---|---|---|
kind |
|
|
labelId |
|
|
path |
|
Schema#
- class @fiftyone/utilities.Schema()#
Name |
Type |
Description |
|---|---|---|
[key] |
|
Stage#
- class @fiftyone/utilities.Stage()#
Properties#
Name |
Type |
Description |
|---|---|---|
kwargs |
|
StrictField#
- class @fiftyone/utilities.StrictField()#
Properties#
Name |
Type |
Description |
|---|---|---|
dbField |
|
|
description |
|
|
embeddedDocType |
|
|
fields |
|
|
ftype |
|
|
info |
|
|
name |
|
|
path |
|
|
pathWithDbField |
|
|
readOnly |
|
|
subfield |
|
SyntheticBox#
- class @fiftyone/utilities.SyntheticBox()#
Leaf types for the video-annotation label / per-frame stream domain. They
live here — below both @fiftyone/annotation and @fiftyone/video-annotation
— so the two packages can share them without importing each other. Pure type
shapes with no React / state deps.
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”,”MirrorsBaseLabel.instancefrom@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”,”truefor user-authored / propagation source;falsefor interpolated.” “label”,”string”
- class @fiftyone/utilities.BufferRange()#
BufferRange#
Name |
Type |
Description |
|---|---|---|
BufferRange |
|
- class @fiftyone/utilities.Buffers()#
Buffers#
- class @fiftyone/utilities.ClickEventModifiers()#
ClickEventModifiers#
Modifier flags associated with a PointerEvent.
Name |
Type |
Description |
|---|---|---|
ClickEventModifiers.altKey |
|
|
ClickEventModifiers.ctrlKey |
|
|
ClickEventModifiers.metaKey |
|
|
ClickEventModifiers.shiftKey |
|
- class @fiftyone/utilities.ContinuousRampId()#
ContinuousRampId#
- class @fiftyone/utilities.DateFieldType()#
DateFieldType#
FiftyOne renders date fields as the UTC calendar date and datetime
fields in the app timezone (fo.config.timezone, “UTC” by default),
while react-datepicker only operates on Date objects interpreted in the
browser’s local timezone. The helpers below translate between the two so
pickers show and store the same dates and times the rest of the app
displays.
Union of 'date', 'datetime'
- 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.onProgress”,”(loadedBytes:number)” “FetchFunctionConfig.path”,”string” “FetchFunctionConfig.result”,”plugins.fiftyone.utilities.FetchResultType” “FetchFunctionConfig.retries”,”number” “FetchFunctionConfig.retryCodes”,”Array<number>” “FetchFunctionConfig.signal”,”AbortSignal”,”Cancels the request and response-body read.”
- class @fiftyone/utilities.FetchFunctionResult()#
FetchFunctionResult#
Parsed fetch response with response headers.
Name |
Type |
Description |
|---|---|---|
FetchFunctionResult.headers |
|
|
FetchFunctionResult.response |
|
- class @fiftyone/utilities.FetchResultType()#
FetchResultType#
Supported methods for accessing response data.
Union of 'json', 'blob', 'text', 'arrayBuffer', 'response', '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.Primitive()#
Primitive#
Union of number, null, string, undefined, Object
- class @fiftyone/utilities.RGB()#
RGB#
Copyright 2017-2026, Voxel51, Inc.
Name |
Type |
Description |
|---|---|---|
RGB |
|
- class @fiftyone/utilities.RGBA()#
RGBA#
Name |
Type |
Description |
|---|---|---|
RGBA |
|
- 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 |
|
|
TransientSnapshot.transientDeletes |
|
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 |
|
|
COUNT |
|
|
COUNT_VALUES |
|
|
DISTINCT |
|
ARRAY_FIELD#
Name |
Type |
Description |
|---|---|---|
|
BIG_ENDIAN#
Name |
Type |
Description |
|---|---|---|
|
BOOLEAN_FIELD#
Name |
Type |
Description |
|---|---|---|
|
BUILT_IN_PANEL_PRIORITY_CONST#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATION#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATIONS#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
CLASSIFICATION_DISABLED_SUB_PATHS#
CLASSIFICATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
CLIPS_FRAME_FIELDS#
CLIPS_SAMPLE_FIELDS#
CONTINUOUS_RAMPS#
Name |
Type |
Description |
|---|---|---|
blueOrange |
|
|
cool |
|
|
coolWarm |
|
|
rainbow |
|
|
spring |
|
|
viridis |
|
CONTINUOUS_RAMP_IDS#
DATE_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DATE_TIME_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DENSE_LABELS#
Name |
Type |
Description |
|---|---|---|
Set < string > |
|
DENSE_LABEL_EMBEDDED_DOC_TYPES#
DETECTION#
Name |
Type |
Description |
|---|---|---|
|
DETECTIONS#
Name |
Type |
Description |
|---|---|---|
|
DETECTIONS_EMBEDDED_DOC_TYPE#
Name |
Type |
Description |
|---|---|---|
|
DETECTIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DETECTION_DISABLED_SUB_PATHS#
DETECTION_EMBEDDED_DOC_TYPE#
Name |
Type |
Description |
|---|---|---|
|
DETECTION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DETECTION_FILED#
Name |
Type |
Description |
|---|---|---|
|
DICT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DISABLED_LABEL_FIELDS_VISIBILITY#
DISABLED_PATHS#
DYNAMIC_EMBEDDED_DOCUMENT#
Name |
Type |
Description |
|---|---|---|
|
DYNAMIC_EMBEDDED_DOCUMENT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
DYNAMIC_EMBEDDED_DOCUMENT_PATH#
Name |
Type |
Description |
|---|---|---|
|
DYNAMIC_GROUP_FIELDS#
EMBEDDED_DOCUMENT#
Name |
Type |
Description |
|---|---|---|
|
EMBEDDED_DOCUMENT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FLOAT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FRAME_NUMBER_FIELD#
Name |
Type |
Description |
|---|---|---|
|
FRAME_SUPPORT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GAUSSIAN_SPLAT_EXTENSIONS#
Direct-media extensions decoded by the Gaussian splat viewer.
GEOLOCATION#
Name |
Type |
Description |
|---|---|---|
|
GEOLOCATIONS#
Name |
Type |
Description |
|---|---|---|
|
GEOLOCATIONS_DISABLED_SUB_PATHS#
GEOLOCATION_DISABLED_SUB_PATHS#
GEO_LOCATIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GEO_LOCATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
GROUP#
Name |
Type |
Description |
|---|---|---|
|
HEATMAP#
Name |
Type |
Description |
|---|---|---|
|
HEATMAP_DISABLED_SUB_PATHS#
HEATMAP_EMBEDDED_DOC_TYPE#
Name |
Type |
Description |
|---|---|---|
|
HEATMAP_FIELD#
Name |
Type |
Description |
|---|---|---|
|
INPUT_TYPE_DATE#
Name |
Type |
Description |
|---|---|---|
|
INPUT_TYPE_DATE_TIME#
Name |
Type |
Description |
|---|---|---|
|
INT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
JUST_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINT#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINTS#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINTS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINTS_POINTS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
KEYPOINT_DISABLED_SUB_PATHS#
KEYPOINT_FIELD#
Name |
Type |
Description |
|---|---|---|
|
LABELS#
LABELS_MAP#
Name |
Type |
Description |
|---|---|---|
Classification |
|
|
Classifications |
|
|
Detection |
|
|
Detections |
|
|
GeoLocation |
|
|
GeoLocations |
|
|
Heatmap |
|
|
Keypoint |
|
|
Keypoints |
|
|
Polyline |
|
|
Polylines |
|
|
Regression |
|
|
Segmentation |
|
|
TemporalDetection |
|
|
TemporalDetections |
|
LABELS_PATH#
Name |
Type |
Description |
|---|---|---|
|
LABEL_DOC_TYPES#
LABEL_LIST#
Name |
Type |
Description |
|---|---|---|
Classifications |
|
|
Detections |
|
|
Keypoints |
|
|
Polylines |
|
|
TemporalDetections |
|
LABEL_LISTS#
LABEL_LISTS_MAP#
Name |
Type |
Description |
|---|---|---|
Classifications |
|
|
Detections |
|
|
Keypoints |
|
|
Polylines |
|
|
TemporalDetections |
|
LABEL_LIST_PATH#
LIST_FIELD#
Name |
Type |
Description |
|---|---|---|
|
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 > |
|
MASK_LABELS#
Name |
Type |
Description |
|---|---|---|
Set < string > |
|
MEDIA_TYPE_3D#
Name |
Type |
Description |
|---|---|---|
|
MEDIA_TYPE_GROUP#
Name |
Type |
Description |
|---|---|---|
|
MEDIA_TYPE_IMAGE#
Name |
Type |
Description |
|---|---|---|
|
MEDIA_TYPE_MULTIMODAL#
Name |
Type |
Description |
|---|---|---|
|
MEDIA_TYPE_POINT_CLOUD#
Name |
Type |
Description |
|---|---|---|
|
MEDIA_TYPE_VIDEO#
Name |
Type |
Description |
|---|---|---|
|
NONFINITES#
Name |
Type |
Description |
|---|---|---|
Set < string > |
|
NOT_VISIBLE_LIST#
OBJECT_ID_FIELD#
Name |
Type |
Description |
|---|---|---|
|
PATCHES_FIELDS#
POLYLINE#
Name |
Type |
Description |
|---|---|---|
|
POLYLINES#
Name |
Type |
Description |
|---|---|---|
|
POLYLINES_FIELD#
Name |
Type |
Description |
|---|---|---|
|
POLYLINE_DISABLED_SUB_PATHS#
POLYLINE_FIELD#
Name |
Type |
Description |
|---|---|---|
|
PRIMITIVE#
Name |
Type |
Description |
|---|---|---|
|
PRIMITIVES#
Name |
Type |
Description |
|---|---|---|
|
REGRESSION#
Name |
Type |
Description |
|---|---|---|
|
REGRESSION_DISABLED_SUB_PATHS#
REGRESSION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
RESERVED_FIELD_KEYS#
SEGMENTATION#
Name |
Type |
Description |
|---|---|---|
|
SEGMENTATION_DISABLED_SUB_PATHS#
SEGMENTATION_EMBEDDED_DOC_TYPE#
Name |
Type |
Description |
|---|---|---|
|
SEGMENTATION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
SKIP_FIELD_TYPES#
STRING_FIELD#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTION#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTIONS#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTIONS_FIELD#
Name |
Type |
Description |
|---|---|---|
|
TEMPORAL_DETECTION_DISABLED_SUB_PATHS#
TEMPORAL_DETECTION_FIELD#
Name |
Type |
Description |
|---|---|---|
|
UNSUPPORTED_FILTER_TYPES#
UUID_FIELD#
Name |
Type |
Description |
|---|---|---|
|
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 |
|---|---|---|
|