@fiftyone/state#

State#

active3dSlices#

const [active3dSlices, setActive3dSlices] = useRecoilState(fos.active3dSlices);

active3dSlicesToSampleMap#

const active3dSlicesToSampleMap = useRecoilValue(fos.active3dSlicesToSampleMap);

activeFieldsConfig#

Name	Type	Description
activeFieldsConfig.exclude	`boolean`
activeFieldsConfig.paths	`readonly`

const activeFieldsConfig = useRecoilValue(fos.activeFieldsConfig);

activeIndex#

Name	Type	Description
activeIndex	`string`

const activeIndex = useRecoilValue(fos.activeIndex);

activeModalSample#

Name	Type	Description
activeModalSample	`plugins.fiftyone.state.Sample()`

const activeModalSample = useRecoilValue(fos.activeModalSample);

activeModalSidebarSample#

Name	Type	Description
activeModalSidebarSample	`plugins.fiftyone.state.Sample()`

const activeModalSidebarSample = useRecoilValue(fos.activeModalSidebarSample);

activePlot#

Name	Type	Description
activePlot	`string`

const [activePlot, setActivePlot] = useRecoilState(fos.activePlot);

activeSliceDescriptorLabel#

Name	Type	Description
activeSliceDescriptorLabel	`string`

const activeSliceDescriptorLabel = useRecoilValue(fos.activeSliceDescriptorLabel);

all3dSlices#

const all3dSlices = useRecoilValue(fos.all3dSlices);

all3dSlicesToSampleMap#

const all3dSlicesToSampleMap = useRecoilValue(fos.all3dSlicesToSampleMap);

allFieldsCheckedState#

Name	Type	Description
allFieldsCheckedState	`boolean`

const [allFieldsCheckedState, setAllFieldsCheckedState] = useRecoilState(fos.allFieldsCheckedState);

allNon3dSlices#

const allNon3dSlices = useRecoilValue(fos.allNon3dSlices);

anyTagging#

Name	Type	Description
anyTagging	`boolean`

const [anyTagging, setAnyTagging] = useRecoilState(fos.anyTagging);

attributeVisibility#

Name	Type	Description
attributeVisibility	`plugins.fiftyone.state.Filters()`

const [attributeVisibility, setAttributeVisibility] = useRecoilState(fos.attributeVisibility);

canCreateNewField#

Name	Type	Description
canCreateNewField.enabled	`boolean`
canCreateNewField.message	`string`

const [canCreateNewField, setCanCreateNewField] = useRecoilState(fos.canCreateNewField);

canEditCustomColors#

Name	Type	Description
canEditCustomColors.enabled	`boolean`
canEditCustomColors.message	`string`

const [canEditCustomColors, setCanEditCustomColors] = useRecoilState(fos.canEditCustomColors);

canEditSavedViews#

Name	Type	Description
canEditSavedViews.enabled	`boolean`
canEditSavedViews.message	`string`

const [canEditSavedViews, setCanEditSavedViews] = useRecoilState(fos.canEditSavedViews);

canEditWorkspaces#

Name	Type	Description
canEditWorkspaces.enabled	`boolean`
canEditWorkspaces.message	`string`

const [canEditWorkspaces, setCanEditWorkspaces] = useRecoilState(fos.canEditWorkspaces);

canModifySidebarGroup#

Name	Type	Description
canModifySidebarGroup.enabled	`boolean`
canModifySidebarGroup.message	`string`

const [canModifySidebarGroup, setCanModifySidebarGroup] = useRecoilState(fos.canModifySidebarGroup);

canTagSamplesOrLabels#

Name	Type	Description
canTagSamplesOrLabels.enabled	`boolean`
canTagSamplesOrLabels.message	`string`

const [canTagSamplesOrLabels, setCanTagSamplesOrLabels] = useRecoilState(fos.canTagSamplesOrLabels);

collapsedPaths#

Name	Type	Description
collapsedPaths	`Set < string >` `<` `string` `>`

const collapsedPaths = useRecoilValue(fos.collapsedPaths);

colorMap#

const colorMap = useRecoilValue(fos.colorMap);

colorMapRGB#

const colorMapRGB = useRecoilValue(fos.colorMapRGB);

colorScheme#

Name	Type	Description
colorScheme	`plugins.fiftyone.state.ColorSchemeInput()`

const [colorScheme, setColorScheme] = useRecoilState(fos.colorScheme);

colorSeed#

Name	Type	Description
colorSeed	`number`

const [colorSeed, setColorSeed] = useRecoilState(fos.colorSeed);

coloring#

Name	Type	Description
coloring	`plugins.fiftyone.state.Coloring()`

const [coloring, setColoring] = useRecoilState(fos.coloring);

config#

Name	Type	Description
config.colorBy	`plugins.fiftyone.state.ColorBy()`
config.colorPool	`readonly`
config.colorscale	`string`
config.defaultQueryPerformance	`boolean`
config.disableFrameFiltering	`boolean`
config.enableQueryPerformance	`boolean`
config.gridZoom	`number`
config.loopVideos	`boolean`
config.maxQueryTime	`number`
config.mediaFallback	`boolean`
config.multicolorKeypoints	`boolean`
config.notebookHeight	`number`
config.plugins	`object`
config.showConfidence	`boolean`
config.showIndex	`boolean`
config.showLabel	`boolean`
config.showSkeletons	`boolean`
config.showTooltip	`boolean`
config.theme	`plugins.fiftyone.state.Theme()`
config.timezone	`string`
config.useFrameNumber	`boolean`

const config = useRecoilValue(fos.config);

configData#

Name	Type	Description
configData	`plugins.fiftyone.state.configFragment$data()`

const [configData, setConfigData] = useRecoilState(fos.configData);

currentSampleId#

Name	Type	Description
currentSampleId	`string`

const currentSampleId = useRecoilValue(fos.currentSampleId);

currentViewSlug#

Name	Type	Description
currentViewSlug	`string`

const currentViewSlug = useRecoilValue(fos.currentViewSlug);

dataset#

Name	Type	Description
dataset	`plugins.fiftyone.state.Dataset()`

const [dataset, setDataset] = useRecoilState(fos.dataset);

datasetAppConfig#

Name	Type	Description
datasetAppConfig	`plugins.fiftyone.state.datasetAppConfigFragment$data()`

const [datasetAppConfig, setDatasetAppConfig] = useRecoilState(fos.datasetAppConfig);

datasetColorScheme#

Name	Type	Description
datasetColorScheme	`plugins.fiftyone.state.colorSchemeFragment$data()`

const [datasetColorScheme, setDatasetColorScheme] = useRecoilState(fos.datasetColorScheme);

datasetFrameCount#

Name	Type	Description
datasetFrameCount	`number`

const datasetFrameCount = useRecoilValue(fos.datasetFrameCount);

datasetId#

Name	Type	Description
datasetId	`string`

const [datasetId, setDatasetId] = useRecoilState(fos.datasetId);

datasetName#

Name	Type	Description
datasetName	`string`

const [datasetName, setDatasetName] = useRecoilState(fos.datasetName);

datasetSampleCount#

Name	Type	Description
datasetSampleCount	`number`

const datasetSampleCount = useRecoilValue(fos.datasetSampleCount);

defaultActiveFields#

const defaultActiveFields = useRecoilValue(fos.defaultActiveFields);

defaultGroupSlice#

Name	Type	Description
defaultGroupSlice	`string`

const [defaultGroupSlice, setDefaultGroupSlice] = useRecoilState(fos.defaultGroupSlice);

defaultQueryPerformanceConfig#

Name	Type	Description
defaultQueryPerformanceConfig	`boolean`

const defaultQueryPerformanceConfig = useRecoilValue(fos.defaultQueryPerformanceConfig);

defaultTargets#

Name	Type	Description
defaultTargets	`plugins.fiftyone.state.Targets()`

const defaultTargets = useRecoilValue(fos.defaultTargets);

disableFrameFiltering#

Name	Type	Description
disableFrameFiltering	`boolean`

const disableFrameFiltering = useRecoilValue(fos.disableFrameFiltering);

disabledCheckboxPaths#

Returns a set of paths that have their checkbox disabled in the sidebar

Name	Type	Description
disabledCheckboxPaths	`Set < string >` `<` `string` `>`

const disabledCheckboxPaths = useRecoilValue(fos.disabledCheckboxPaths);

disabledFilterPaths#

Returns a set of paths that have their filter dropdown disabled in the sidebar

Name	Type	Description
disabledFilterPaths	`Set < string >` `<` `string` `>`

const disabledFilterPaths = useRecoilValue(fos.disabledFilterPaths);

disabledFrameFilterPaths#

Name	Type	Description
disabledFrameFilterPaths	`Set < string >` `<` `string` `>`

const disabledFrameFilterPaths = useRecoilValue(fos.disabledFrameFilterPaths);

distributionPaths#

const distributionPaths = useRecoilValue(fos.distributionPaths);

dynamicGroupCurrentElementIndex#

Name	Type	Description
dynamicGroupCurrentElementIndex	`number`

const [dynamicGroupCurrentElementIndex, setDynamicGroupCurrentElementIndex] = useRecoilState(fos.dynamicGroupCurrentElementIndex);

dynamicGroupFields#

const dynamicGroupFields = useRecoilValue(fos.dynamicGroupFields);

dynamicGroupIndex#

Name	Type	Description
dynamicGroupIndex	`number`

const [dynamicGroupIndex, setDynamicGroupIndex] = useRecoilState(fos.dynamicGroupIndex);

dynamicGroupParameters#

Name	Type	Description
dynamicGroupParameters	`plugins.fiftyone.state.DynamicGroupParameters()`

const [dynamicGroupParameters, setDynamicGroupParameters] = useRecoilState(fos.dynamicGroupParameters);

dynamicGroupsTargetFrameRate#

Name	Type	Description
dynamicGroupsTargetFrameRate	`number`

const dynamicGroupsTargetFrameRate = useRecoilValue(fos.dynamicGroupsTargetFrameRate);

editingFieldAtom#

Name	Type	Description
editingFieldAtom	`boolean`

const [editingFieldAtom, setEditingFieldAtom] = useRecoilState(fos.editingFieldAtom);

elementNames#

Name	Type	Description
elementNames.plural	`string`
elementNames.singular	`string`

const elementNames = useRecoilValue(fos.elementNames);

eligibleFieldsToCustomizeColor#

const eligibleFieldsToCustomizeColor = useRecoilValue(fos.eligibleFieldsToCustomizeColor);

enableQueryPerformanceConfig#

Name	Type	Description
enableQueryPerformanceConfig	`boolean`

const enableQueryPerformanceConfig = useRecoilValue(fos.enableQueryPerformanceConfig);

escapeKeyHandlerIdsAtom#

Name	Type	Description
escapeKeyHandlerIdsAtom	`Set < string >` `<` `string` `>`

const [escapeKeyHandlerIdsAtom, setEscapeKeyHandlerIdsAtom] = useRecoilState(fos.escapeKeyHandlerIdsAtom);

excludedPathsStrippedState#

const excludedPathsStrippedState = useRecoilValue(fos.excludedPathsStrippedState);

expandedPathsState#

const [expandedPathsState, setExpandedPathsState] = useRecoilState(fos.expandedPathsState);

extendedSelection#

Name	Type	Description
extendedSelection.scope	`string`
extendedSelection.selection	`Array<` `string` `>`

const [extendedSelection, setExtendedSelection] = useRecoilState(fos.extendedSelection);

extendedSelectionOverrideStage#

Name	Type	Description
extendedSelectionOverrideStage	`any`

const [extendedSelectionOverrideStage, setExtendedSelectionOverrideStage] = useRecoilState(fos.extendedSelectionOverrideStage);

extendedStages#

Name	Type	Description
extendedStages	`any`

const extendedStages = useRecoilValue(fos.extendedStages);

extendedStagesNoSort#

Name	Type	Description
extendedStagesNoSort	`any`

const extendedStagesNoSort = useRecoilValue(fos.extendedStagesNoSort);

extendedStagesUnsorted#

Name	Type	Description
extendedStagesUnsorted	`any`

const extendedStagesUnsorted = useRecoilValue(fos.extendedStagesUnsorted);

fieldSchemaState#

Name	Type	Description
fieldSchemaState	`any`

const [fieldSchemaState, setFieldSchemaState] = useRecoilState(fos.fieldSchemaState);

fieldVisibilityStage#

Name	Type	Description
fieldVisibilityStage	`plugins.fiftyone.state.FieldVisibilityStage()`

const [fieldVisibilityStage, setFieldVisibilityStage] = useRecoilState(fos.fieldVisibilityStage);

filters#

Name	Type	Description
filters	`plugins.fiftyone.state.Filters()`

const [filters, setFilters] = useRecoilState(fos.filters);

flatFrameFields#

const flatFrameFields = useRecoilValue(fos.flatFrameFields);

flatSampleFields#

const flatSampleFields = useRecoilValue(fos.flatSampleFields);

fo3dContent#

Name	Type	Description
fo3dContent	`any`

const [fo3dContent, setFo3dContent] = useRecoilState(fos.fo3dContent);

fo3dSample#

Name	Type	Description
fo3dSample	`plugins.fiftyone.state.ModalSample()`

const fo3dSample = useRecoilValue(fos.fo3dSample);

fo3dSlice#

Name	Type	Description
fo3dSlice	`string`

const fo3dSlice = useRecoilValue(fos.fo3dSlice);

frameFields#

const frameFields = useRecoilValue(fos.frameFields);

frameFieldsList#

const frameFieldsList = useRecoilValue(fos.frameFieldsList);

fullSchema#

Name	Type	Description
fullSchema	`plugins.fiftyone.state.Schema()`

const fullSchema = useRecoilValue(fos.fullSchema);

fullscreen#

Name	Type	Description
fullscreen	`boolean`

const [fullscreen, setFullscreen] = useRecoilState(fos.fullscreen);

fullyDisabledPaths#

Returns a set of paths that should have both their checkbox and filter dropdown disabled in the sidebar

Name	Type	Description
fullyDisabledPaths	`Set < string >` `<` `string` `>`

const fullyDisabledPaths = useRecoilValue(fos.fullyDisabledPaths);

getSkeleton#

const getSkeleton = useRecoilValue(fos.getSkeleton);

getTarget#

const getTarget = useRecoilValue(fos.getTarget);

gridSortBy#

Name	Type	Description
gridSortBy.descending	`boolean`
gridSortBy.field	`string`

const [gridSortBy, setGridSortBy] = useRecoilState(fos.gridSortBy);

gridSortFields#

const gridSortFields = useRecoilValue(fos.gridSortFields);

groupByFieldValue#

const groupByFieldValue = useRecoilValue(fos.groupByFieldValue);

groupField#

Name	Type	Description
groupField	`string`

const groupField = useRecoilValue(fos.groupField);

groupId#

Name	Type	Description
groupId	`string`

const groupId = useRecoilValue(fos.groupId);

groupMedia3dVisibleSetting#

Name	Type	Description
groupMedia3dVisibleSetting	`boolean`

const [groupMedia3dVisibleSetting, setGroupMedia3dVisibleSetting] = useRecoilState(fos.groupMedia3dVisibleSetting);

groupMediaIs3dVisible#

Name	Type	Description
groupMediaIs3dVisible	`boolean`

const groupMediaIs3dVisible = useRecoilValue(fos.groupMediaIs3dVisible);

groupMediaIsCarouselVisible#

Name	Type	Description
groupMediaIsCarouselVisible	`boolean`

const groupMediaIsCarouselVisible = useRecoilValue(fos.groupMediaIsCarouselVisible);

groupMediaIsCarouselVisibleSetting#

Name	Type	Description
groupMediaIsCarouselVisibleSetting	`boolean`

const [groupMediaIsCarouselVisibleSetting, setGroupMediaIsCarouselVisibleSetting] = useRecoilState(fos.groupMediaIsCarouselVisibleSetting);

groupMediaIsMainVisible#

Name	Type	Description
groupMediaIsMainVisible	`boolean`

const groupMediaIsMainVisible = useRecoilValue(fos.groupMediaIsMainVisible);

groupMediaIsMainVisibleSetting#

Name	Type	Description
groupMediaIsMainVisibleSetting	`boolean`

const [groupMediaIsMainVisibleSetting, setGroupMediaIsMainVisibleSetting] = useRecoilState(fos.groupMediaIsMainVisibleSetting);

groupMediaTypes#

const groupMediaTypes = useRecoilValue(fos.groupMediaTypes);

groupMediaTypesMap#

const groupMediaTypesMap = useRecoilValue(fos.groupMediaTypesMap);

groupMediaTypesSet#

Name	Type	Description
groupMediaTypesSet	`Set < string >` `<` `string` `>`

const groupMediaTypesSet = useRecoilValue(fos.groupMediaTypesSet);

groupSlice#

Name	Type	Description
groupSlice	`string`

const [groupSlice, setGroupSlice] = useRecoilState(fos.groupSlice);

groupSlices#

const groupSlices = useRecoilValue(fos.groupSlices);

groupView#

A group view, i.e. all slices of a group, can potentially be of a dynamic group. The GroupBy stage is filtered to accomodate this

const groupView = useRecoilValue(fos.groupView);

has3dSlice#

Name	Type	Description
has3dSlice	`boolean`

const has3dSlice = useRecoilValue(fos.has3dSlice);

hasFo3dSlice#

Name	Type	Description
hasFo3dSlice	`boolean`

const hasFo3dSlice = useRecoilValue(fos.hasFo3dSlice);

hasGroupSlices#

Name	Type	Description
hasGroupSlices	`boolean`

const hasGroupSlices = useRecoilValue(fos.hasGroupSlices);

hasMultiple3dSlices#

Name	Type	Description
hasMultiple3dSlices	`boolean`

const hasMultiple3dSlices = useRecoilValue(fos.hasMultiple3dSlices);

hasSelectedLabels#

Name	Type	Description
hasSelectedLabels	`boolean`

const hasSelectedLabels = useRecoilValue(fos.hasSelectedLabels);

hasSelectedSamples#

Name	Type	Description
hasSelectedSamples	`boolean`

const hasSelectedSamples = useRecoilValue(fos.hasSelectedSamples);

hiddenLabelIds#

Name	Type	Description
hiddenLabelIds	`Set < string >` `<` `string` `>`

const hiddenLabelIds = useRecoilValue(fos.hiddenLabelIds);

hiddenLabels#

Name	Type	Description
hiddenLabels	`plugins.fiftyone.state.SelectedLabelMap()`

const [hiddenLabels, setHiddenLabels] = useRecoilState(fos.hiddenLabels);

hiddenLabelsArray#

const hiddenLabelsArray = useRecoilValue(fos.hiddenLabelsArray);

hiddenNoneGroups#

Name	Type	Description
hiddenNoneGroups.groups	`Set < string >` `<` `string` `>`
hiddenNoneGroups.paths	`Set < string >` `<` `string` `>`

const hiddenNoneGroups = useRecoilValue(fos.hiddenNoneGroups);

hideNoneValuedFields#

Name	Type	Description
hideNoneValuedFields	`boolean`

const [hideNoneValuedFields, setHideNoneValuedFields] = useRecoilState(fos.hideNoneValuedFields);

hoveredSample#

Name	Type	Description
hoveredSample	`plugins.fiftyone.state.Sample()`

const [hoveredSample, setHoveredSample] = useRecoilState(fos.hoveredSample);

includeNestedFieldsState#

Name	Type	Description
includeNestedFieldsState	`boolean`

const [includeNestedFieldsState, setIncludeNestedFieldsState] = useRecoilState(fos.includeNestedFieldsState);

indexInfo#

Name	Type	Description
indexInfo	`plugins.fiftyone.state.indexesFragment$data()`

const [indexInfo, setIndexInfo] = useRecoilState(fos.indexInfo);

is3DDataset#

Name	Type	Description
is3DDataset	`boolean`

const is3DDataset = useRecoilValue(fos.is3DDataset);

isClipsView#

Name	Type	Description
isClipsView	`boolean`

const isClipsView = useRecoilValue(fos.isClipsView);

isDynamicGroup#

Name	Type	Description
isDynamicGroup	`boolean`

const isDynamicGroup = useRecoilValue(fos.isDynamicGroup);

isFieldVisibilityActive#

Name	Type	Description
isFieldVisibilityActive	`boolean`

const isFieldVisibilityActive = useRecoilValue(fos.isFieldVisibilityActive);

isFramesView#

Name	Type	Description
isFramesView	`boolean`

const isFramesView = useRecoilValue(fos.isFramesView);

isGroup#

Name	Type	Description
isGroup	`boolean`

const isGroup = useRecoilValue(fos.isGroup);

isLargeVideo#

Name	Type	Description
isLargeVideo	`boolean`

const isLargeVideo = useRecoilValue(fos.isLargeVideo);

isModalActive#

Name	Type	Description
isModalActive	`boolean`

const isModalActive = useRecoilValue(fos.isModalActive);

isNestedDynamicGroup#

Name	Type	Description
isNestedDynamicGroup	`boolean`

const isNestedDynamicGroup = useRecoilValue(fos.isNestedDynamicGroup);

isNonNestedDynamicGroup#

Name	Type	Description
isNonNestedDynamicGroup	`boolean`

const isNonNestedDynamicGroup = useRecoilValue(fos.isNonNestedDynamicGroup);

isNotebook#

Name	Type	Description
isNotebook	`boolean`

const isNotebook = useRecoilValue(fos.isNotebook);

isOrderedDynamicGroup#

Name	Type	Description
isOrderedDynamicGroup	`boolean`

const isOrderedDynamicGroup = useRecoilValue(fos.isOrderedDynamicGroup);

isPatchesView#

Name	Type	Description
isPatchesView	`boolean`

const isPatchesView = useRecoilValue(fos.isPatchesView);

isQueryPerformantView#

Name	Type	Description
isQueryPerformantView	`boolean`

const isQueryPerformantView = useRecoilValue(fos.isQueryPerformantView);

isRootView#

Name	Type	Description
isRootView	`boolean`

const isRootView = useRecoilValue(fos.isRootView);

isSidebarFilterMode#

Name	Type	Description
isSidebarFilterMode	`boolean`

const [isSidebarFilterMode, setIsSidebarFilterMode] = useRecoilState(fos.isSidebarFilterMode);

isTooltipLocked#

Name	Type	Description
isTooltipLocked	`boolean`

const [isTooltipLocked, setIsTooltipLocked] = useRecoilState(fos.isTooltipLocked);

isVideoDataset#

Name	Type	Description
isVideoDataset	`boolean`

const isVideoDataset = useRecoilValue(fos.isVideoDataset);

labelPathsSet#

Name	Type	Description
labelPathsSet	`Set < string >` `<` `string` `>`

const labelPathsSet = useRecoilValue(fos.labelPathsSet);

labelPathsSetExpanded#

Name	Type	Description
labelPathsSetExpanded	`Set < string >` `<` `string` `>`

const labelPathsSetExpanded = useRecoilValue(fos.labelPathsSetExpanded);

lastLoadedDatasetNameState#

Name	Type	Description
lastLoadedDatasetNameState	`string`

const [lastLoadedDatasetNameState, setLastLoadedDatasetNameState] = useRecoilState(fos.lastLoadedDatasetNameState);

loading#

Name	Type	Description
loading	`boolean`

const [loading, setLoading] = useRecoilState(fos.loading);

lookerPanels#

Name	Type	Description
lookerPanels.help	`Object`
lookerPanels.json	`Object`

const [lookerPanels, setLookerPanels] = useRecoilState(fos.lookerPanels);

mediaFields#

const [mediaFields, setMediaFields] = useRecoilState(fos.mediaFields);

mediaType#

Name	Type	Description
mediaType	`string`

const [mediaType, setMediaType] = useRecoilState(fos.mediaType);

mediaTypeSelector#

Name	Type	Description
mediaTypeSelector	`Union<` `'image'` `,` `'group'` `,` `'point_cloud'` `,` `'point-cloud'` `,` `'three_d'` `,` `'3d'` `,` `'video'` `,` `'unknown'` `>`

const mediaTypeSelector = useRecoilValue(fos.mediaTypeSelector);

modalAttributeVisibility#

Name	Type	Description
modalAttributeVisibility	`plugins.fiftyone.state.Filters()`

const [modalAttributeVisibility, setModalAttributeVisibility] = useRecoilState(fos.modalAttributeVisibility);

modalFilters#

Name	Type	Description
modalFilters	`plugins.fiftyone.state.Filters()`

const [modalFilters, setModalFilters] = useRecoilState(fos.modalFilters);

modalGroupSlice#

Name	Type	Description
modalGroupSlice	`string`

const [modalGroupSlice, setModalGroupSlice] = useRecoilState(fos.modalGroupSlice);

modalLooker#

Name	Type	Description
modalLooker	`plugins.fiftyone.state.Lookers()`

const [modalLooker, setModalLooker] = useRecoilState(fos.modalLooker);

modalSample#

Name	Type	Description
modalSample	`plugins.fiftyone.state.ModalSample()`

const [modalSample, setModalSample] = useRecoilState(fos.modalSample);

modalSampleId#

Name	Type	Description
modalSampleId	`string`

const modalSampleId = useRecoilValue(fos.modalSampleId);

modalSelector#

Name	Type	Description
modalSelector	`plugins.fiftyone.state.ModalSelector()`

const [modalSelector, setModalSelector] = useRecoilState(fos.modalSelector);

modalTopBarVisible#

Name	Type	Description
modalTopBarVisible	`boolean`

const [modalTopBarVisible, setModalTopBarVisible] = useRecoilState(fos.modalTopBarVisible);

non3dSamples#

const non3dSamples = useRecoilValue(fos.non3dSamples);

noneValuedPaths#

Name	Type	Description
noneValuedPaths	`Record < string , Set >` `<` `string` `,` `Set < string >` `>`

const [noneValuedPaths, setNoneValuedPaths] = useRecoilState(fos.noneValuedPaths);

nullableModalSampleId#

Name	Type	Description
nullableModalSampleId	`string`

const nullableModalSampleId = useRecoilValue(fos.nullableModalSampleId);

only3d#

Name	Type	Description
only3d	`boolean`

const only3d = useRecoilValue(fos.only3d);

parentMediaTypeSelector#

Name	Type	Description
parentMediaTypeSelector	`Union<` `'image'` `,` `'group'` `,` `'point_cloud'` `,` `'point-cloud'` `,` `'three_d'` `,` `'3d'` `,` `'video'` `,` `'unknown'` `>`

const parentMediaTypeSelector = useRecoilValue(fos.parentMediaTypeSelector);

patching#

Name	Type	Description
patching	`boolean`

const [patching, setPatching] = useRecoilState(fos.patching);

pathHiddenLabelsMap#

const [pathHiddenLabelsMap, setPathHiddenLabelsMap] = useRecoilState(fos.pathHiddenLabelsMap);

pinned3DSample#

Name	Type	Description
pinned3DSample	`plugins.fiftyone.state.ModalSample()`

const pinned3DSample = useRecoilValue(fos.pinned3DSample);

pinned3DSampleSlice#

Name	Type	Description
pinned3DSampleSlice	`string`

const [pinned3DSampleSlice, setPinned3DSampleSlice] = useRecoilState(fos.pinned3DSampleSlice);

pinned3d#

Name	Type	Description
pinned3d	`boolean`

const [pinned3d, setPinned3d] = useRecoilState(fos.pinned3d);

queryPerformance#

Name	Type	Description
queryPerformance	`boolean`

const [queryPerformance, setQueryPerformance] = useRecoilState(fos.queryPerformance);

queryPerformanceMaxSearch#

Name	Type	Description
queryPerformanceMaxSearch	`number`

const [queryPerformanceMaxSearch, setQueryPerformanceMaxSearch] = useRecoilState(fos.queryPerformanceMaxSearch);

queryPerformanceSetting#

Name	Type	Description
queryPerformanceSetting	`boolean`

const [queryPerformanceSetting, setQueryPerformanceSetting] = useRecoilState(fos.queryPerformanceSetting);

readOnly#

Name	Type	Description
readOnly	`boolean`

const [readOnly, setReadOnly] = useRecoilState(fos.readOnly);

refreshGroupQuery#

Name	Type	Description
refreshGroupQuery	`number`

const [refreshGroupQuery, setRefreshGroupQuery] = useRecoilState(fos.refreshGroupQuery);

refresher#

Name	Type	Description
refresher	`number`

const [refresher, setRefresher] = useRecoilState(fos.refresher);

rootElementName#

Name	Type	Description
rootElementName	`string`

const rootElementName = useRecoilValue(fos.rootElementName);

rootElementNamePlural#

Name	Type	Description
rootElementNamePlural	`string`

const rootElementNamePlural = useRecoilValue(fos.rootElementNamePlural);

sampleFields#

const sampleFields = useRecoilValue(fos.sampleFields);

savedLookerOptions#

const [savedLookerOptions, setSavedLookerOptions] = useRecoilState(fos.savedLookerOptions);

savingFilters#

Name	Type	Description
savingFilters	`boolean`

const [savingFilters, setSavingFilters] = useRecoilState(fos.savingFilters);

schemaSearchResultList#

const [schemaSearchResultList, setSchemaSearchResultList] = useRecoilState(fos.schemaSearchResultList);

schemaSearchResults#

const [schemaSearchResults, setSchemaSearchResults] = useRecoilState(fos.schemaSearchResults);

schemaSearchTerm#

Name	Type	Description
schemaSearchTerm	`string`

const [schemaSearchTerm, setSchemaSearchTerm] = useRecoilState(fos.schemaSearchTerm);

schemaSelectedSettingsTab#

Name	Type	Description
schemaSelectedSettingsTab	`string`

const [schemaSelectedSettingsTab, setSchemaSelectedSettingsTab] = useRecoilState(fos.schemaSelectedSettingsTab);

searchMetaFilterState#

const [searchMetaFilterState, setSearchMetaFilterState] = useRecoilState(fos.searchMetaFilterState);

selectedLabelIds#

Name	Type	Description
selectedLabelIds	`Set < string >` `<` `string` `>`

const selectedLabelIds = useRecoilValue(fos.selectedLabelIds);

selectedLabelMap#

Name	Type	Description
selectedLabelMap	`plugins.fiftyone.state.SelectedLabelMap()`

const [selectedLabelMap, setSelectedLabelMap] = useRecoilState(fos.selectedLabelMap);

selectedLabels#

const [selectedLabels, setSelectedLabels] = useRecoilState(fos.selectedLabels);

selectedPatchSamples#

Name	Type	Description
selectedPatchSamples	`Set < unknown >` `<` `unknown` `>`

const selectedPatchSamples = useRecoilValue(fos.selectedPatchSamples);

selectedSampleObjects#

Name	Type	Description
selectedSampleObjects	`Map < string , Sample >` `<` `string` `,` `plugins.fiftyone.state.Sample()` `>`

const [selectedSampleObjects, setSelectedSampleObjects] = useRecoilState(fos.selectedSampleObjects);

selectedSamples#

Name	Type	Description
selectedSamples	`Set < string >` `<` `string` `>`

const [selectedSamples, setSelectedSamples] = useRecoilState(fos.selectedSamples);

selectedSavedViewState#

Name	Type	Description
selectedSavedViewState	`plugins.fiftyone.state.DatasetViewOption()`

const [selectedSavedViewState, setSelectedSavedViewState] = useRecoilState(fos.selectedSavedViewState);

selectedViewName#

Name	Type	Description
selectedViewName	`string`

const [selectedViewName, setSelectedViewName] = useRecoilState(fos.selectedViewName);

sessionGroupSlice#

Name	Type	Description
sessionGroupSlice	`string`

const [sessionGroupSlice, setSessionGroupSlice] = useRecoilState(fos.sessionGroupSlice);

sessionSpaces#

Name	Type	Description
sessionSpaces	`plugins.fiftyone.state.SpaceNodeJSON()`

const [sessionSpaces, setSessionSpaces] = useRecoilState(fos.sessionSpaces);

settingsModal#

Name	Type	Description
settingsModal.open	`boolean`

const [settingsModal, setSettingsModal] = useRecoilState(fos.settingsModal);

showMetadataState#

Name	Type	Description
showMetadataState	`boolean`

const [showMetadataState, setShowMetadataState] = useRecoilState(fos.showMetadataState);

showModalNavigationControls#

Name	Type	Description
showModalNavigationControls	`boolean`

const [showModalNavigationControls, setShowModalNavigationControls] = useRecoilState(fos.showModalNavigationControls);

showNestedFieldsState#

Name	Type	Description
showNestedFieldsState	`boolean`

const [showNestedFieldsState, setShowNestedFieldsState] = useRecoilState(fos.showNestedFieldsState);

showOverlays#

Name	Type	Description
showOverlays	`boolean`

const [showOverlays, setShowOverlays] = useRecoilState(fos.showOverlays);

sidebarPaths#

const sidebarPaths = useRecoilValue(fos.sidebarPaths);

sidebarSampleId#

Name	Type	Description
sidebarSampleId	`string`

const sidebarSampleId = useRecoilValue(fos.sidebarSampleId);

similarityMethods#

Name	Type	Description
similarityMethods.patches	`Array<` `[` `plugins.fiftyone.state.Method()` `,` `string` `]` `>`
similarityMethods.samples	`Array<` `plugins.fiftyone.state.Method()` `>`

const similarityMethods = useRecoilValue(fos.similarityMethods);

similarityParameters#

Name	Type	Description
similarityParameters	`plugins.fiftyone.state.SortBySimilarityParameters()`

const [similarityParameters, setSimilarityParameters] = useRecoilState(fos.similarityParameters);

similaritySorting#

Name	Type	Description
similaritySorting	`boolean`

const [similaritySorting, setSimilaritySorting] = useRecoilState(fos.similaritySorting);

snackbarErrors#

const [snackbarErrors, setSnackbarErrors] = useRecoilState(fos.snackbarErrors);

snackbarLink#

Name	Type	Description
snackbarLink.link	`string`
snackbarLink.message	`string`

const [snackbarLink, setSnackbarLink] = useRecoilState(fos.snackbarLink);

stageDefinitions#

const stageDefinitions = useRecoilValue(fos.stageDefinitions);

stageInfo#

Name	Type	Description
stageInfo	`any`

const [stageInfo, setStageInfo] = useRecoilState(fos.stageInfo);

stateSubscription#

Name	Type	Description
stateSubscription	`string`

const stateSubscription = useRecoilValue(fos.stateSubscription);

targets#

Name	Type	Description
targets.defaults	`plugins.fiftyone.state.Targets()`
targets.fields	`Any`

const targets = useRecoilValue(fos.targets);

theme#

Name	Type	Description
theme	`Union<` `'dark'` `,` `'light'` `>`

const [theme, setTheme] = useRecoilState(fos.theme);

themeConfig#

Name	Type	Description
themeConfig	`Union<` `'dark'` `,` `'light'` `,` `'browser'` `>`

const themeConfig = useRecoilValue(fos.themeConfig);

threedSamples#

const threedSamples = useRecoilValue(fos.threedSamples);

timeZone#

Name	Type	Description
timeZone	`string`

const timeZone = useRecoilValue(fos.timeZone);

tooltipCoordinates#

Name	Type	Description
tooltipCoordinates.bottom	`plugins.fiftyone.state.placement()`
tooltipCoordinates.left	`plugins.fiftyone.state.placement()`
tooltipCoordinates.right	`plugins.fiftyone.state.placement()`
tooltipCoordinates.top	`plugins.fiftyone.state.placement()`

const [tooltipCoordinates, setTooltipCoordinates] = useRecoilState(fos.tooltipCoordinates);

tooltipDetail#

Name	Type	Description
tooltipDetail	`plugins.fiftyone.state.PointInfo()` `<` `plugins.fiftyone.state.BaseLabel()` `>`

const [tooltipDetail, setTooltipDetail] = useRecoilState(fos.tooltipDetail);

view#

const [view, setView] = useRecoilState(fos.view);

viewCls#

Name	Type	Description
viewCls	`string`

const [viewCls, setViewCls] = useRecoilState(fos.viewCls);

viewCounter#

Name	Type	Description
viewCounter	`number`

const [viewCounter, setViewCounter] = useRecoilState(fos.viewCounter);

viewName#

Name	Type	Description
viewName	`string`

const [viewName, setViewName] = useRecoilState(fos.viewName);

viewSchemaState#

Name	Type	Description
viewSchemaState	`any`

const [viewSchemaState, setViewSchemaState] = useRecoilState(fos.viewSchemaState);

viewStateForm_INTERNAL#

This atom can be set to parameterize view changes

See

for example usage

Name	Type	Description
viewStateForm_INTERNAL	`plugins.fiftyone.state.StateForm()`

const [viewStateForm_INTERNAL, setViewStateForm_INTERNAL] = useRecoilState(fos.viewStateForm_INTERNAL);

Hooks#

useAssertedRecoilValue#

fos.useAssertedRecoilValue(recoilValue)#

Arguments:

recoilValue (RecoilValue)

Return type:

plugins.fiftyone.state.T()

useBeforeScreenshot#

fos.useBeforeScreenshot(cb)#

Arguments:

cb (( )())

Return type:

void

useBrowserStorage#

fos.useBrowserStorage(key, initialValue, useSessionStorage, parseFn)#

Arguments:

key (string())
initialValue (Union)
useSessionStorage (boolean())
parseFn (Object())
parseFn.parse (( value : string )())
parseFn.stringify (( value : T )())

Return type:

readonly

useClearModal#

fos.useClearModal()#

A react hook that allows clearing the modal state.

Example

function MyComponent() {
  const clearModal = useClearModal();
  return (
   <button onClick={clearModal}>Close Modal</button>
  )
}

Returns

A function that clears the modal state.

fos.clearModal()#

Return type:

void

useCreateLooker#

fos.useCreateLooker(isModal, thumbnail, options, highlight, enableTimeline)#

Arguments:

isModal (boolean())
thumbnail (boolean())
options (Omit)
highlight (( sample : Sample )())
enableTimeline (boolean())

Return type:

MutableRefObject < > < ( args : ) >

useDebounceCallback#

fos.useDebounceCallback(func, delay, options)#

Arguments:

func (T())
delay (number())
options (DebounceSettings())

Return type:

plugins.fiftyone.state.DebouncedState() < plugins.fiftyone.state.T() >

useDeferrer#

fos.useDeferrer()#

Return type:: Object

useDimensions#

fos.useDimensions()#

Return type:: Object

useEntries#

fos.useEntries(modal)#

Arguments:

modal (boolean())

Return type:

[ Array< SidebarEntry > , ( entries : ) ]

useEventHandler#

fos.useEventHandler(target, eventType, handler, options)#

Arguments:

target (EventTarget())
eventType (string())
handler (( event : any )())
options (Union)

Return type:

void

useExpandSample#

fos.useExpandSample(store)#

Arguments:

store ()

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useFollow#

fos.useFollow(leaderRef, followerRef, set)#

Arguments:

leaderRef (any())
followerRef (any())
set (any())

Return type:

void

useHashChangeHandler#

fos.useHashChangeHandler(handler)#

Arguments:

handler (any())

Return type:

void

useHelpPanel#

fos.useHelpPanel()#

Return type:: Object

useHover#

fos.useHover()#

Return type:: [ MutableRefObject < any > , boolean ]

useHoveredSample#

fos.useHoveredSample(sample, args)#

Arguments:

sample (Sample())
args (Object())
args.clear (( )())
args.update (( )())

Return type:

Object

useJSONPanel#

fos.useJSONPanel()#

Return type:: Object

Manage the JSON panel state and events.

Example

function MyComponent() {
  const jsonPanel = useJSONPanel();

  return jsonPanel.isOpen && (
     <JSONPanel
       containerRef={jsonPanel.containerRef}
       onClose={() => jsonPanel.close()}
       onCopy={() => jsonPanel.copy()}
     />
   )
}

useKeyDown#

fos.useKeyDown(key, handler, deps)#

Arguments:

key (string())
handler (( down : boolean , e : KeyboardEvent )())
deps (DependencyList())

Return type:

void

a react hook that calls the handler when a given key is down

useKeydownHandler#

fos.useKeydownHandler(handler)#

Arguments:

handler (( e : KeyboardEvent )())

Return type:

void

useLookerOptions#

fos.useLookerOptions(modal)#

Arguments:

modal (boolean())

Return type:

Partial < Omit > < Omit < , > >

useLookerStore#

fos.useLookerStore()#

Return type:: plugins.fiftyone.state.LookerStore() < plugins.fiftyone.state.Lookers() >

useMutation#

fos.useMutation(hasPermission, mutation)#

Arguments:

hasPermission (boolean())
mutation (string())

Return type:

plugins.fiftyone.state.CanPerformActionReturnType()

useNotification#

fos.useNotification()#

fos.notification()#

Arguments:

options (NotificationOption())

Return type:

void

useObserve#

fos.useObserve(target, handler)#

Arguments:

target (any())
handler (any())

Return type:

void

useOnSelectLabel#

fos.useOnSelectLabel()#

fos.onSelectLabel()#

Arguments:

args ([ SelectEvent ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useOutsideClick#

fos.useOutsideClick(ref, handler, eventName)#

Arguments:

ref (MutableRefObject)
handler (MouseEventHandler)
eventName (string())

Return type:

void

usePanel#

fos.usePanel(name, atom)#

Arguments:

name (any())
atom (any())

Return type:

Object

useQueryPerformance#

fos.useQueryPerformance()#

Return type:: Object

useRefresh#

fos.useRefresh()#

fos.refresh()#

Arguments:

args ([ ]())

Return type:

void

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useReset#

fos.useReset()#

Return type:: SetterOrUpdater < > < Array< Stage > >

Deprecated

use

instead

useResetExtendedSelection#

fos.useResetExtendedSelection()#

fos.resetExtendedSelection()#

Arguments:

args ([ ]())

Return type:

void

Returns a function that executes an atomic transaction for updating Recoil state.

useResizeHandler#

fos.useResizeHandler(handler)#

Arguments:

handler (any())

Return type:

void

useSavedViews#

fos.useSavedViews()#

Return type:: Object

useSchemaSettings#

fos.useSchemaSettings()#

Return type:: Object

useScreenshot#

fos.useScreenshot(context)#

Arguments:

context ()

useScrollHandler#

fos.useScrollHandler(handler)#

Arguments:

handler (any())

Return type:

void

useSearchSchemaFields#

fos.useSearchSchemaFields(mergedSchema)#

Arguments:

mergedSchema (Any())

Return type:

Object

useSelectSample#

fos.useSelectSample()#

fos.selectSample()#

Arguments:

args ([ sampleId ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useSession#

fos.useSession(setter, ref)#

Arguments:

setter (Setter())
ref (Session())

Return type:

void

useSessionRef#

fos.useSessionRef()#

Return type:: plugins.fiftyone.state.Session()

useSessionSetter#

fos.useSessionSetter()#

fos.sessionSetter()#

Arguments:

key (K())
value

Return type:

void

useSessionSpaces#

fos.useSessionSpaces()#

Return type:: Array< any >

useSetDataset#

fos.useSetDataset()#

Return type:: SetterOrUpdater < string > < string >

useSetExpandedSample#

fos.useSetExpandedSample()#

fos.setExpandedSample()#

Arguments:

selector (ModalSelector())

Return type:

Promise < void > < void >

useSetGroupSlice#

fos.useSetGroupSlice()#

Return type:: SetterOrUpdater < string > < string >

useSetModalState#

fos.useSetModalState()#

Initializer that applys relevant grid settings to the modal, e.g. sidebar checkboxes. If no navigation is provided, next/previous in the modal is disabled

fos.setModalState()#

Arguments:

args ([ navigation ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useSetSelected#

fos.useSetSelected()#

Return type:: SetterOrUpdater < Set > < Set < string > >

useSetSelectedFieldsStage#

fos.useSetSelectedFieldsStage()#

Return type:: Object

Returns

a callback to set the selectedFields stage

useSetSelectedLabels#

fos.useSetSelectedLabels()#

Return type:: SetterOrUpdater < > < Array< SelectedLabel > >

useSetSessionColorScheme#

fos.useSetSessionColorScheme()#

Return type:: SetterOrUpdater < ColorSchemeInput > < plugins.fiftyone.state.ColorSchemeInput() >

useSetSpaces#

fos.useSetSpaces()#

Return type:: SetterOrUpdater < SpaceNodeJSON > < plugins.fiftyone.state.SpaceNodeJSON() >

useSetView#

fos.useSetView()#

Return type:: SetterOrUpdater < > < Array< Stage > >

useSimilarityType#

fos.useSimilarityType(props)#

Arguments:

props (SimilarityTypeProp())

Return type:

Object

useTimeout#

fos.useTimeout(time)#

Arguments:

time (number())

Return type:

boolean

useToClips#

fos.useToClips()#

fos.toClips()#

Arguments:

args ([ field ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useToEvaluationPatches#

fos.useToEvaluationPatches()#

fos.toEvaluationPatches()#

Arguments:

args ([ evaluation ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useToPatches#

fos.useToPatches()#

fos.toPatches()#

Arguments:

args ([ field ]())

Return type:

Promise < void > < void >

Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.

useTooltip#

fos.useTooltip()#

Return type:: Object

useUnboundState#

fos.useUnboundState(value)#

Arguments:

value (State())

Return type:

plugins.fiftyone.state.State()

The hook can be used to get the latest value of the state without re-rendering the component.

useUpdateSamples#

fos.useUpdateSamples()#

fos.updateSamples()#

Arguments:

samples (Array)

Return type:

void

useWindowSize#

fos.useWindowSize()#

Return type:: Object

Functions#

activeField#

fos.activeField(params)#

Arguments:

params (Object())
params.modal (boolean()) – Whether the field is in a modal or not
params.path (string()) – The path of the field

Return type:

RecoilState < boolean > < boolean >

Get or set the active state of a field.

activeFields#

fos.activeFields(param)#

Arguments:

param (Object())
param.modal (boolean())

Return type:

RecoilState < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

activeLabelFields#

fos.activeLabelFields(param)#

Arguments:

param (Object())
param.modal (boolean())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

activeLabelPaths#

fos.activeLabelPaths(param)#

Arguments:

param (Object())
param.modal (boolean())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

activeLabels#

fos.activeLabels(param)#

Arguments:

param (Object())
param.expanded (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< LabelData > >

Returns a function which returns a memoized atom for each unique parameter value.

aggregation#

fos.aggregation(param)#

Arguments:

param (Object())
param.extended (boolean())
param.isQueryPerformance (boolean())
param.mixed (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , , , , , > >

Returns a function which returns a memoized atom for each unique parameter value.

aggregationQuery#

fos.aggregationQuery(parameter)#

Arguments:

parameter (Object())
parameter.dynamicGroup (SerializableParam())
parameter.extended (boolean())
parameter.isQueryPerformance (boolean())
parameter.mixed (boolean())
parameter.modal (boolean())
parameter.paths (Array)
parameter.root (boolean())
parameter.useSelection (boolean())

Return type:

RecoilState < > < Array< Aggregation > >

GraphQL Selector Family for Aggregations.

aggregations#

fos.aggregations(param)#

Arguments:

param (Object())
param.extended (boolean())
param.isQueryPerformance (boolean())
param.mixed (boolean())
param.modal (boolean())
param.paths (Array)

Return type:

readonly readonly RecoilValueReadOnly < > < Array< Aggregation > >

Returns a function which returns a memoized atom for each unique parameter value.

appConfigOption#

fos.appConfigOption(param)#

Arguments:

param (Object())
param.key (string())
param.modal (boolean())

Return type:

RecoilState < any > < any >

Returns a function which returns a memoized atom for each unique parameter value.

boolExcludeAtom#

fos.boolExcludeAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

boolIsMatchingAtom#

fos.boolIsMatchingAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

boolean#

fos.boolean(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : boolean ) >

Returns a function which returns a memoized atom for each unique parameter value.

booleanCountResults#

fos.booleanCountResults(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

booleanResults#

fos.booleanResults(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

booleanSelectedValuesAtom#

fos.booleanSelectedValuesAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

boundedCount#

fos.boundedCount(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

bounds#

fos.bounds(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < [ number , number ] >

Returns a function which returns a memoized atom for each unique parameter value.

boundsAtom#

fos.boundsAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < Range > < plugins.fiftyone.state.Range() >

Returns a function which returns a memoized atom for each unique parameter value.

buildSchema#

fos.buildSchema(sampleFields, frameFields)#

Arguments:

sampleFields (Array)
frameFields (Array)

Return type:

plugins.fiftyone.state.Schema()

collapseFields#

fos.collapseFields(paths)#

Arguments:

paths (any())

Return type:

Array< plugins.fiftyone.state.StrictField() >

convertTargets#

fos.convertTargets(targets)#

Arguments:

targets (Array)

Return type:

Any

count#

fos.count(param)#

Arguments:

param (Object())
param.extended (boolean())
param.lightning (boolean())
param.modal (boolean())
param.path (string())
param.value (string())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

countValues#

fos.countValues(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , > >

Returns a function which returns a memoized atom for each unique parameter value.

counts#

fos.counts(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

cropToContent#

fos.cropToContent(param)#

Arguments:

param (boolean())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

cumulativeCounts#

fos.cumulativeCounts(param)#

Arguments:

param (Object())
param.embeddedDocType (Union)
param.extended (boolean())
param.ftype (Union)
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

cumulativeValues#

fos.cumulativeValues(param)#

Arguments:

param (Object())
param.embeddedDocType (Union)
param.extended (boolean())
param.ftype (Union)
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

currentSlice#

fos.currentSlice(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

currentSlices#

fos.currentSlices(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

dbPath#

fos.dbPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

deferrer#

fos.deferrer(initialized)#

Arguments:

initialized ()

distribution#

fos.distribution(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , , , , > >

Returns a function which returns a memoized atom for each unique parameter value.

dynamicGroupPageSelector#

fos.dynamicGroupPageSelector(param)#

Arguments:

param (Object())
param.modal (boolean())
param.value (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( cursor : number , pageSize : number ) >

Returns a function which returns a memoized atom for each unique parameter value.

dynamicGroupsElementCount#

fos.dynamicGroupsElementCount(param)#

Arguments:

param (Object())
param.modal (boolean())
param.value (SerializableParam())

Return type:

readonly readonly RecoilValueReadOnly < any > < any >

Returns a function which returns a memoized atom for each unique parameter value.

dynamicGroupsViewMode#

fos.dynamicGroupsViewMode(param)#

Arguments:

param (boolean())

Return type:

RecoilState < > < Union< , , > >

Returns a function which returns a memoized atom for each unique parameter value.

dynamicGroupsViewModeStore#

fos.dynamicGroupsViewModeStore(param)#

Arguments:

param (boolean())

Return type:

RecoilState < > < Union< , , > >

Returns a function which returns a memoized atom for each unique parameter value.

ensureColorScheme#

fos.ensureColorScheme(colorScheme, appConfig)#

Arguments:

colorScheme (any())
appConfig (Object())
appConfig.colorBy (ColorBy())
appConfig.colorPool (readonly())
appConfig.colorscale (string())
appConfig.multicolorKeypoints (boolean())
appConfig.showSkeletons (boolean())

Return type:

plugins.fiftyone.state.ColorSchemeInput()

excludedPathsState#

fos.excludedPathsState(param)#

Arguments:

param (SerializableParam())

Return type:

RecoilState < unknown > < unknown >

Returns a function which returns a memoized atom for each unique parameter value.

expandPath#

fos.expandPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

falseAtom#

fos.falseAtom(param)#

Arguments:

param (Object())
param.isFiltering (boolean())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

field#

fos.field(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < Field > < plugins.fiftyone.state.Field() >

Returns a function which returns a memoized atom for each unique parameter value.

fieldHasVisibilitySetting#

fos.fieldHasVisibilitySetting(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

fieldIsFiltered#

fos.fieldIsFiltered(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

fieldPath#

fos.fieldPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

fieldPaths#

fos.fieldPaths(param)#

Arguments:

param (Object())
param.embeddedDocType (Union)
param.ftype (Union)
param.path (string())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

fieldSchema#

fos.fieldSchema(param)#

Arguments:

param (Object())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < Schema > < plugins.fiftyone.state.Schema() >

Returns a function which returns a memoized atom for each unique parameter value.

fieldType#

fos.fieldType(param)#

Arguments:

param (Object())
param.path (string())
param.useListSubfield (boolean())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

fields#

fos.fields(param)#

Arguments:

param (Object())
param.embeddedDocType (Union)
param.ftype (Union)
param.path (string())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< Field > >

Returns a function which returns a memoized atom for each unique parameter value.

fieldsMatcher#

fos.fieldsMatcher(fields, matcher, present, prefix)#

Arguments:

fields (Array)
matcher (( field : StrictField )())
present (Set)
prefix (string())

Return type:

Array< string >

filter#

fos.filter(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < Filter > < plugins.fiftyone.state.Filter() >

Returns a function which returns a memoized atom for each unique parameter value.

filterFields#

fos.filterFields(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

filterPaths#

fos.filterPaths(paths, schema)#

Arguments:

paths (Array)
schema (Schema())

Return type:

Array< string >

filterSearch#

fos.filterSearch(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Given a field path, return a set a field filters and index name that would result in a optimized IXSCAN, if possible

filterView#

fos.filterView(stages)#

Arguments:

stages (Array)

Return type:

string

gatheredPaths#

fos.gatheredPaths(param)#

Arguments:

param (Object())
param.embeddedDocType (Union)
param.ftype (Union)

Return type:

readonly readonly RecoilValueReadOnly < > < Array< any > >

Returns a function which returns a memoized atom for each unique parameter value.

generateBooleanSelectorFamily#

fos.generateBooleanSelectorFamily(key)#

Arguments:

key ()

Returns a function which returns a memoized atom for each unique parameter value.

generateSelectorFamily#

fos.generateSelectorFamily(key)#

Arguments:

key ()

Returns a function which returns a memoized atom for each unique parameter value.

getBrowserStorageEffectForKey#

fos.getBrowserStorageEffectForKey(key, props)#

Arguments:

key (string())
props (Object())
props.map (( value : unknown )())
props.prependDatasetNameInKey (boolean())
props.sessionStorage (boolean())
props.useJsonSerialization (boolean())
props.valueClass (Union)

Return type:

AtomEffect < T > < plugins.fiftyone.state.T() >

getCurrentEnvironment#

fos.getCurrentEnvironment()#

Return type:: default

getEmbeddedLabelFields#

fos.getEmbeddedLabelFields(fields, prefix)#

Arguments:

fields (Array)
prefix (string())

Return type:

Array< string >

getEnvironment#

fos.getEnvironment()#

Return type:: default

getLabelFields#

fos.getLabelFields(fields, prefix)#

Arguments:

fields (Array)
prefix (string())

Return type:

Array< string >

getQueryPerformancePath#

fos.getQueryPerformancePath()#

Return type:: Object

getSampleSrc#

fos.getSampleSrc(url)#

Arguments:

url (string())

Return type:

string

getSessionRef#

fos.getSessionRef()#

Return type:: plugins.fiftyone.state.Session()

getStandardizedUrls#

fos.getStandardizedUrls(urls)#

Arguments:

urls (Union)

Return type:

any

gridSortByStore#

fos.gridSortByStore(param)#

Arguments:

param (string())

Return type:

RecoilState < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

gridSortDescendingStore#

fos.gridSortDescendingStore(param)#

Arguments:

param (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

groupFilter#

fos.groupFilter(field)#

Arguments:

field (StrictField())

Return type:

boolean

groupIsEmpty#

fos.groupIsEmpty(param)#

Arguments:

param (Object())
param.group (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

groupLength#

fos.groupLength(param)#

Arguments:

param (Object())
param.group (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

groupSamples#

fos.groupSamples(parameter)#

Arguments:

parameter (Object())
parameter.count (number())
parameter.paginationData (boolean())
parameter.slices (Array)

Return type:

RecoilState < > < Array< ModalSample > >

groupShown#

fos.groupShown(param)#

Arguments:

param (Object())
param.group (string())
param.loading (boolean())
param.modal (boolean())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

groupStatistics#

fos.groupStatistics(param)#

Arguments:

param (boolean())

Return type:

RecoilState < > < Union< , > >

Returns a function which returns a memoized atom for each unique parameter value.

hasFilters#

fos.hasFilters(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

hasVisibility#

fos.hasVisibility(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

helperFunction#

fos.helperFunction(value, exclude, start, end, none, inf, ninf, nan)#

Arguments:

value (Union)
exclude (boolean())
start (number())
end (number())
none (boolean())
inf (boolean())
ninf (boolean())
nan (boolean())

Return type:

boolean

hiddenFieldLabels#

fos.hiddenFieldLabels(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

histogramValues#

fos.histogramValues(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , , > >

Returns a function which returns a memoized atom for each unique parameter value.

imaVidLookerState#

fos.imaVidLookerState(param)#

Arguments:

param (string())

Return type:

RecoilState < any > < any >

Returns a function which returns a memoized atom for each unique parameter value.

imaVidStoreKey#

fos.imaVidStoreKey(param)#

Arguments:

param (Object())
param.groupByFieldValue (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

indexedPaths#

fos.indexedPaths(param)#

Arguments:

param (Object())
param.path (string())
param.withFilters (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

indexesByPath#

fos.indexesByPath(param)#

Arguments:

param (Array)

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

isCompoundIndexed#

fos.isCompoundIndexed(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isDisabledCheckboxPath#

fos.isDisabledCheckboxPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isDisabledFilterPath#

fos.isDisabledFilterPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isDisabledFrameFilterPath#

fos.isDisabledFrameFilterPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isFilterDefault#

fos.isFilterDefault(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isFrameField#

fos.isFrameField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isInListField#

fos.isInListField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isLabelPath#

fos.isLabelPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isListField#

fos.isListField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isMatchingAtom#

fos.isMatchingAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isNumericField#

fos.isNumericField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isObjectIdField#

fos.isObjectIdField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isOfDocumentFieldList#

fos.isOfDocumentFieldList(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

isStringField#

fos.isStringField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

keypointFilter#

fos.keypointFilter(name, embeddedDocType, filter)#

Arguments:

name (string())
embeddedDocType (string())
filter ()

labelCount#

fos.labelCount(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

labelFields#

fos.labelFields(param)#

Arguments:

param (Object())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

labelPath#

fos.labelPath(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

labelPaths#

fos.labelPaths(param)#

Arguments:

param (Object())
param.expanded (boolean())
param.space (SPACE())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

labelTagCounts#

fos.labelTagCounts(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

labelsMatcher#

fos.labelsMatcher(parent)#

Arguments:

parent ()

lightningBooleanResults#

fos.lightningBooleanResults(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

lightningBounds#

fos.lightningBounds(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < [ number , number ] >

Returns a function which returns a memoized atom for each unique parameter value.

lightningNonfinites#

fos.lightningNonfinites(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , > >

Returns a function which returns a memoized atom for each unique parameter value.

lightningNumericResults#

fos.lightningNumericResults(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , > >

Returns a function which returns a memoized atom for each unique parameter value.

lightningQuery#

fos.lightningQuery(parameter)#

Arguments:

parameter (readonly())

Return type:

readonly readonly RecoilState < > < readonly >

lightningStringResults#

fos.lightningStringResults(param)#

Arguments:

param (Object())
param.exclude (Array)
param.filters (SerializableParam())
param.index (string())
param.maxDocumentsSearch (number())
param.path (string())
param.search (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

listBoolean#

fos.listBoolean(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : boolean ) >

Returns a function which returns a memoized atom for each unique parameter value.

listNumber#

fos.listNumber(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : number ) >

Returns a function which returns a memoized atom for each unique parameter value.

listString#

fos.listString(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : string ) >

Returns a function which returns a memoized atom for each unique parameter value.

lookerOptions#

fos.lookerOptions(param)#

Arguments:

param (Object())
param.modal (boolean())
param.withFilter (boolean())

Return type:

RecoilState < Partial > < Partial < Omit > >

Returns a function which returns a memoized atom for each unique parameter value.

mapSampleResponse#

fos.mapSampleResponse(data)#

Arguments:

data (T())

Return type:

plugins.fiftyone.state.T()

maxAtom#

fos.maxAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())
param.withBounds (boolean())

Return type:

RecoilState < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

meetsType#

fos.meetsType(param)#

Arguments:

param (Object())
param.acceptLists (boolean())
param.embeddedDocType (Union)
param.ftype (Union)
param.path (string())
param.under (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

minAtom#

fos.minAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())
param.withBounds (boolean())

Return type:

RecoilState < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

modalAggregationPaths#

fos.modalAggregationPaths(param)#

Arguments:

param (Object())
param.mixed (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

modalFilterFields#

fos.modalFilterFields(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

noneAtom#

fos.noneAtom(param)#

Arguments:

param (Object())
param.isFiltering (boolean())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

noneCount#

fos.noneCount(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

nonfiniteAtom#

fos.nonfiniteAtom(param)#

Arguments:

param (Object())
param.key (Union)
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

nonfiniteCount#

fos.nonfiniteCount(param)#

Arguments:

param (Object())
param.extended (boolean())
param.key (Nonfinite())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

nonfiniteData#

fos.nonfiniteData(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , , , > >

Returns a function which returns a memoized atom for each unique parameter value.

numGroupFieldsActive#

fos.numGroupFieldsActive(param)#

Arguments:

param (Object())
param.group (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

numGroupFieldsFiltered#

fos.numGroupFieldsFiltered(param)#

Arguments:

param (Object())
param.group (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

numGroupFieldsVisible#

fos.numGroupFieldsVisible(param)#

Arguments:

param (Object())
param.group (string())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

numeric#

fos.numeric(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : number ) >

Returns a function which returns a memoized atom for each unique parameter value.

numericExcludeAtom#

fos.numericExcludeAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

numericFields#

fos.numericFields(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

numericIsMatchingAtom#

fos.numericIsMatchingAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

parentField#

fos.parentField(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < Field > < plugins.fiftyone.state.Field() >

Returns a function which returns a memoized atom for each unique parameter value.

pathCanBeOptimized#

fos.pathCanBeOptimized(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Union< , > >

Returns a function which returns a memoized atom for each unique parameter value.

pathColor#

fos.pathColor(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

pathFilter#

fos.pathFilter(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < PathFilterSelector > < plugins.fiftyone.state.PathFilterSelector() >

Returns a function which returns a memoized atom for each unique parameter value.

pathHasActiveIndex#

fos.pathHasActiveIndex(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

pathHasIndexes#

fos.pathHasIndexes(param)#

Arguments:

param (Object())
param.path (string())
param.withFilters (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

pathIndex#

fos.pathIndex(param)#

Arguments:

param (Object())
param.path (string())
param.withFilters (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

pathIsShown#

fos.pathIsShown(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

persistSidebarGroups#

fos.persistSidebarGroups(variables)#

Arguments:

variables (setSidebarGroupsMutation$variables())

Return type:

void

primitivesMatcher#

fos.primitivesMatcher(field)#

Arguments:

field (StrictField())

Return type:

boolean

pullSidebarValue#

fos.pullSidebarValue(inputField, keys, input, isList)#

Arguments:

inputField (Pick)
keys (Array)
input (object())
isList (boolean())

Return type:

object

rangeAtom#

fos.rangeAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())
param.withBounds (boolean())

Return type:

RecoilState < Range > < plugins.fiftyone.state.Range() >

Returns a function which returns a memoized atom for each unique parameter value.

readableTags#

fos.readableTags(param)#

Arguments:

param (Object())
param.group (Union)
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

removeRgbProperty#

fos.removeRgbProperty(input)#

Arguments:

input (any())

Return type:

any

resolveGroups#

fos.resolveGroups(sampleFields, frameFields, currentGroups, configGroups)#

Arguments:

sampleFields (Array)
frameFields (Array)
currentGroups (Array)
configGroups (Array)

Return type:

Array< plugins.fiftyone.state.SidebarGroup() >

sampleTagCounts#

fos.sampleTagCounts(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

schemaReduce#

fos.schemaReduce(schema, field)#

Arguments:

schema (Schema())
field (StrictField())

Return type:

plugins.fiftyone.state.Schema()

selectedMediaField#

fos.selectedMediaField(param)#

Arguments:

param (boolean())

Return type:

RecoilState < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

selectedMediaFieldAtomFamily#

fos.selectedMediaFieldAtomFamily(params)#

Arguments:

params (boolean())

Return type:

RecoilState < string > < string >

selectedPatchIds#

fos.selectedPatchIds(param)#

Arguments:

param (SerializableParam())

Return type:

readonly readonly RecoilValueReadOnly < Set > < Set < string > >

Returns a function which returns a memoized atom for each unique parameter value.

sessionAtom#

fos.sessionAtom(options)#

Arguments:

options (SessionAtomOptions)

Return type:

RecoilState < > < ```` >

setCurrentEnvironment#

fos.setCurrentEnvironment(environment)#

Arguments:

environment (default())

Return type:

void

setQueryPerformancePath#

fos.setQueryPerformancePath(path, isFrameField)#

Arguments:

path (string())
isFrameField (boolean())

Return type:

void

shouldRenderImaVidLooker#

fos.shouldRenderImaVidLooker(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarEntries#

fos.sidebarEntries(param)#

Arguments:

param (Object())
param.filtered (boolean())
param.loading (boolean())
param.modal (boolean())

Return type:

RecoilState < > < Array< SidebarEntry > >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarExpanded#

fos.sidebarExpanded(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarExpandedStore#

fos.sidebarExpandedStore(param)#

Arguments:

param (boolean())

Return type:

RecoilState < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarGroup#

fos.sidebarGroup(param)#

Arguments:

param (Object())
param.filtered (boolean())
param.group (string())
param.loading (boolean())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarGroupMapping#

fos.sidebarGroupMapping(param)#

Arguments:

param (Object())
param.filtered (boolean())
param.loading (boolean())
param.modal (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Any >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarGroupNames#

fos.sidebarGroupNames(param)#

Arguments:

param (boolean())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarGroups#

fos.sidebarGroups(param)#

Arguments:

param (Object())
param.filtered (boolean())
param.loading (boolean())
param.modal (boolean())
param.persist (boolean())

Return type:

RecoilState < > < Array< SidebarGroup > >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarGroupsDefinition#

fos.sidebarGroupsDefinition(params)#

Arguments:

params (boolean())

Return type:

RecoilState < > < Array< SidebarGroup > >

sidebarVisible#

fos.sidebarVisible(param)#

Arguments:

param (boolean())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

sidebarWidth#

fos.sidebarWidth(param)#

Arguments:

param (boolean())

Return type:

RecoilState < number > < number >

Returns a function which returns a memoized atom for each unique parameter value.

skeleton#

fos.skeleton(param)#

Arguments:

param (string())

Return type:

readonly readonly RecoilValueReadOnly < KeypointSkeleton > < plugins.fiftyone.state.KeypointSkeleton() >

Returns a function which returns a memoized atom for each unique parameter value.

sortFilterResults#

fos.sortFilterResults(param)#

Arguments:

param (boolean())

Return type:

RecoilState < SortResults > < plugins.fiftyone.state.SortResults() >

Returns a function which returns a memoized atom for each unique parameter value.

string#

fos.string(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < ( value : string ) >

Returns a function which returns a memoized atom for each unique parameter value.

stringCountResults#

fos.stringCountResults(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

stringExcludeAtom#

fos.stringExcludeAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

stringResults#

fos.stringResults(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

stringSelectedValuesAtom#

fos.stringSelectedValuesAtom(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

stringifyObj#

fos.stringifyObj(obj)#

Arguments:

obj (any())

Return type:

any

tagging#

fos.tagging(param)#

Arguments:

param (Object())
param.labels (boolean())
param.modal (boolean())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

textFilter#

fos.textFilter(param)#

Arguments:

param (boolean())

Return type:

RecoilState < string > < string >

Returns a function which returns a memoized atom for each unique parameter value.

transformDataset#

fos.transformDataset(dataset)#

Arguments:

dataset (any())

Return type:

Readonly < Dataset > < plugins.fiftyone.state.Dataset() >

trueAtom#

fos.trueAtom(param)#

Arguments:

param (Object())
param.isFiltering (boolean())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < boolean > < boolean >

Returns a function which returns a memoized atom for each unique parameter value.

unsupportedMatcher#

fos.unsupportedMatcher(field)#

Arguments:

field (StrictField())

Return type:

boolean

validIndexes#

fos.validIndexes(param)#

Arguments:

param (Array)

Return type:

readonly readonly RecoilValueReadOnly < > < Object >

Returns a function which returns a memoized atom for each unique parameter value.

validateGroupName#

fos.validateGroupName(current, name)#

Arguments:

current (Array)
name (string())

Return type:

boolean

values#

fos.values(param)#

Arguments:

param (Object())
param.extended (boolean())
param.modal (boolean())
param.path (string())

Return type:

readonly readonly RecoilValueReadOnly < > < Array< string > >

Returns a function which returns a memoized atom for each unique parameter value.

viewsAreEqual#

fos.viewsAreEqual(viewOne, viewTwo)#

Arguments:

viewOne (Union)
viewTwo (Union)

Return type:

boolean

visibility#

fos.visibility(param)#

Arguments:

param (Object())
param.modal (boolean())
param.path (string())

Return type:

RecoilState < Filter > < plugins.fiftyone.state.Filter() >

Returns a function which returns a memoized atom for each unique parameter value.

withSuspense#

fos.withSuspense(Component, LoaderComponent)#

Arguments:

Component (ComponentType)
LoaderComponent ()

Types#

SPACE#

Name	Value
FRAME
SAMPLE

AnnotationRun#

class fos.AnnotationRun()#

Properties#

Name	Type	Description
config	`Any`
key	`string`
timestamp	`string`
version	`string`
viewStages	`readonly`

BrainRun#

class fos.BrainRun()#

Properties#

Name	Type	Description
config	`Object`
key	`string`
timestamp	`string`
version	`string`
viewStages	`readonly`

Config#

class fos.Config()#

Properties#

Name	Type	Description
colorPool	`Array<` `string` `>`
colorscale	`string`
customizedColors	`Array<` `plugins.fiftyone.state.CustomizeColorInput()` `>`
gridZoom	`number`
loopVideos	`boolean`
mediaFallback	`boolean`
mediaFields	`Array<` `string` `>`
notebookHeight	`number`
plugins	`plugins.fiftyone.state.PluginConfig()`
showConfidence	`boolean`
showIndex	`boolean`
showLabel	`boolean`
showTooltip	`boolean`
theme	`Union<` `'dark'` `,` `'light'` `,` `'browser'` `>`
timezone	`string`
useFrameNumber	`boolean`

Dataset#

class fos.Dataset()#

The dataset object returned by the API.

Properties#

Name	Type	Description
appConfig	`plugins.fiftyone.state.DatasetAppConfig()`
brainMethods	`Array<` `plugins.fiftyone.state.BrainRun()` `>`
createdAt	`plugins.fiftyone.state.DateTime()`
datasetId	`string`
defaultMaskTargets	`plugins.fiftyone.state.Targets()`
defaultSkeleton	`plugins.fiftyone.state.KeypointSkeleton()`
evaluations	`Array<` `plugins.fiftyone.state.EvaluationRun()` `>`
groupField	`string`
groupMediaTypes	`Array<` `Object` `>`
groupSlice	`string`
id	`string`
info	`Any`
lastLoadedAt	`plugins.fiftyone.state.DateTime()`
maskTargets	`Any`
mediaType	`plugins.fiftyone.state.MediaType()`
name	`string`
parentMediaType	`plugins.fiftyone.state.MediaType()`
skeletons	`Array<` `plugins.fiftyone.state.StrictKeypointSkeleton()` `>`
version	`string`

DatasetAppConfig#

class fos.DatasetAppConfig()#

Properties#

Name	Type	Description
activeFields	`plugins.fiftyone.state.ActiveFields()`
dynamicGroupsTargetFrameRate	`number`
gridMediaField	`string`
mediaFields	`Array<` `string` `>`
modalMediaField	`string`
plugins	`plugins.fiftyone.state.PluginConfig()`

DateTime#

class fos.DateTime()#

Properties#

Name	Type	Description
$date	`number`

Description#

class fos.Description()#

Properties#

Name	Type	Description
dataset	`string`
fieldVisibilityStage	`plugins.fiftyone.state.FieldVisibilityStage()`
savedViewSlug	`string`
savedViews	`Array<` `plugins.fiftyone.state.SavedView()` `>`
selected	`Array<` `string` `>`
selectedLabels	`Array<` `plugins.fiftyone.state.SelectedLabel()` `>`
spaces	`plugins.fiftyone.state.SpaceNodeJSON()`
view	`Array<` `plugins.fiftyone.state.Stage()` `>`
viewCls	`string`
viewName	`string`

DynamicGroupParameters#

class fos.DynamicGroupParameters()#

Properties#

Name	Type	Description
groupBy	`Union<` `object` `,` `Array< string >` `>`
orderBy	`string`
orderByKey	`unknown`

Evaluation#

class fos.Evaluation()#

EvaluationRun#

class fos.EvaluationRun()#

Properties#

Name	Type	Description
config	`Object`
key	`string`
timestamp	`string`
version	`string`
viewStages	`readonly`

FieldVisibilityStage#

class fos.FieldVisibilityStage()#

Properties#

Name	Type	Description
cls	`string`
kwargs	`Object`

Filter#

class fos.Filter()#

Name	Type	Description
[key]	`string`

Filters#

class fos.Filters()#

Name	Type	Description
[key]	`string`

ID#

class fos.ID()#

Properties#

Name	Type	Description
$oid	`string`

KeypointSkeleton#

class fos.KeypointSkeleton()#

Properties#

Name	Type	Description
edges	`Array<` `Array<` `number` `>` `>`
labels	`Array<` `string` `>`

Run#

class fos.Run()#

Properties#

Name	Type	Description
config	`Any`
key	`string`
timestamp	`string`
version	`string`
viewStages	`readonly`

SavedView#

class fos.SavedView()#

Properties#

Name	Type	Description
color	`string`
createdAt	`plugins.fiftyone.state.DateTime()`
datasetId	`string`
description	`string`
id	`string`
lastLoadedAt	`plugins.fiftyone.state.DateTime()`
lastModifiedAt	`plugins.fiftyone.state.DateTime()`
name	`string`
slug	`string`
viewStages	`Array<` `plugins.fiftyone.state.Stage()` `>`

SelectedLabel#

class fos.SelectedLabel()#

Properties#

Name	Type	Description
field	`string`
frameNumber	`number`
instanceId	`string`
labelId	`string`
sampleId	`string`

SelectedLabelData#

class fos.SelectedLabelData()#

Properties#

Name	Type	Description
field	`string`
frameNumber	`number`
instanceId	`string`
sampleId	`string`

SelectedLabelMap#

class fos.SelectedLabelMap()#

Name	Type	Description
[labelId]	`string`

SidebarGroup#

class fos.SidebarGroup()#

Properties#

Name	Type	Description
expanded	`boolean`
name	`string`
paths	`Array<` `string` `>`

SortBySimilarityParameters#

class fos.SortBySimilarityParameters()#

Properties#

Name	Type	Description
brainKey	`string`
distField	`string`
k	`number`
query	`Union<` `string` `,` `Array< string >` `>`
queryIds	`Array<` `string` `>`
reverse	`boolean`

Stage#

class fos.Stage()#

Properties#

Name	Type	Description
kwargs	`Array<` `[` `string` `,` `unknown` `]` `>`

StrictKeypointSkeleton#

class fos.StrictKeypointSkeleton()#

Properties#

Name	Type	Description
edges	`Array<` `Array<` `number` `>` `>`
labels	`Array<` `string` `>`
name	`string`

Targets#

class fos.Targets()#

Name	Type	Description
[key]	`number`

class fos.ActiveFields()#

ActiveFields#

Name	Type	Description
ActiveFields.exclude	`Union<` `boolean` `,` `null` `>`
ActiveFields.paths	`Array<` `string` `>`

class fos.MediaType()#

MediaType#

Union of 'image'(), 'group'(), 'point_cloud'(), 'point-cloud'(), 'three_d'(), '3d'(), 'video'(), 'unknown'()

class fos.PluginConfig()#

PluginConfig#

An object containing the configuration for plugins. Each key is the name of a plugin, and the value is the configuration for that plugin.

FIFTYONE_GRID_SPACES_ID#

Name	Type	Description
`'fiftyone-spaces'`

BooleanFilter#

class fos.BooleanFilter()#

Properties#

Name	Type	Description
exclude	`boolean`
false	`boolean`
isMatching	`boolean`
none	`boolean`
true	`boolean`

EmptyEntry#

class fos.EmptyEntry()#

Properties#

Name	Type	Description
group	`string`
kind	`plugins.fiftyone.state.EMPTY()`
shown	`boolean`

GroupEntry#

class fos.GroupEntry()#

Properties#

Name	Type	Description
kind	`plugins.fiftyone.state.GROUP()`
name	`string`

InputEntry#

class fos.InputEntry()#

Properties#

Name	Type	Description
kind	`plugins.fiftyone.state.INPUT()`
type	`Union<` `'filter'` `,` `'add'` `>`

LookerStore#

class fos.LookerStore()#

Properties#

Name	Type	Description
indices	`Map < number , string >` `<` `number` `,` `string` `>`
lookers	`LRUCache < string , T , unknown >` `<` `string` `,` `plugins.fiftyone.state.T()` `,` `unknown` `>`
reset	`(` `)`
samples	`Map < string , ModalSample >` `<` `string` `,` `plugins.fiftyone.state.ModalSample()` `>`

NumericFilter#

class fos.NumericFilter()#

Properties#

Name	Type	Description
exclude	`boolean`
inf	`boolean`
isMatching	`boolean`
nan	`boolean`
ninf	`boolean`
none	`boolean`
range	`plugins.fiftyone.state.Range()`

PathEntry#

class fos.PathEntry()#

Properties#

Name	Type	Description
kind	`plugins.fiftyone.state.PATH()`
path	`string`
shown	`boolean`

SelectEvent#

class fos.SelectEvent()#

Properties#

Name	Type	Description
detail	`Object`

Session#

class fos.Session()#

Properties#

Name	Type	Description
canCreateNewField	`Object`
canEditCustomColors	`Object`
canEditSavedViews	`Object`
canEditWorkspaces	`Object`
canModifySidebarGroup	`Object`
canTagSamplesOrLabels	`Object`
colorScheme	`plugins.fiftyone.state.ColorSchemeInput()`
fieldVisibilityStage	`plugins.fiftyone.state.FieldVisibilityStage()`
filters	`plugins.fiftyone.state.Filters()`
modalFilters	`plugins.fiftyone.state.Filters()`
modalSelector	`plugins.fiftyone.state.ModalSelector()`
readOnly	`boolean`
selectedLabels	`Array<` `plugins.fiftyone.state.SelectedLabel()` `>`
selectedSamples	`Set < string >` `<` `string` `>`
sessionGroupSlice	`string`
sessionSpaces	`plugins.fiftyone.state.SpaceNodeJSON()`

SortResults#

class fos.SortResults()#

Properties#

Name	Type	Description
asc	`boolean`
count	`boolean`

StringFilter#

class fos.StringFilter()#

Properties#

Name	Type	Description
exclude	`boolean`
isMatching	`boolean`
values	`Array<` `string` `>`

class fos.AggregationResponseFrom()#

AggregationResponseFrom#

A generic type that extracts the response type from a GraphQL query.

class fos.DatasetViewOption()#

DatasetViewOption#

class fos.DebouncedState()#

DebouncedState#

class fos.DimensionsType()#

DimensionsType#

Name	Type	Description
DimensionsType	`ReturnType < >` `<` ```` `>`

class fos.Lookers()#

Lookers#

Union of FrameLooker(), ImageLooker(), ImaVidLooker(), VideoLooker()

class fos.Method()#

Method#

Name	Type	Description
Method.key	`string`
Method.maxK	`number`
Method.supportsLeastSimilarity	`boolean`
Method.supportsPrompts	`boolean`

class fos.ModalNavigation()#

ModalNavigation#

Name	Type	Description
ModalNavigation.next	`(` `offset` `:` `number` `)`
ModalNavigation.previous	`(` `offset` `:` `number` `)`

class fos.ModalSample()#

ModalSample#

class fos.ModalSampleData()#

ModalSampleData#

Name	Type	Description
ModalSampleData	`Exclude < Exclude , >` `<` `Exclude < , >` `,` `null` `>`

class fos.ModalSelector()#

ModalSelector#

Name	Type	Description
ModalSelector.groupId	`string`
ModalSelector.hasNext	`boolean`
ModalSelector.hasPrevious	`boolean`
ModalSelector.id	`string`

class fos.Optional()#

Optional#

Optional From T make a set of properties by key K become optional

class fos.PathFilterSelector()#

PathFilterSelector#

class fos.Range()#

Range#

Name	Type	Description
Range	`[` `Union< number , >` `,` `Union< number , >` `]`

class fos.ResponseFrom()#

ResponseFrom#

class fos.Sample()#

Sample#

Name	Type	Description
Sample	`Exclude < Exclude , >` `<` `Exclude < , >` `,` `null` `>`

class fos.SidebarEntry()#

SidebarEntry#

Union of EmptyEntry(), GroupEntry(), PathEntry(), InputEntry()

class fos.SliceName()#

SliceName#

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

Enums#

EntryKind#

Name	Value
EMPTY
GROUP
INPUT
PATH

Variables#

BeforeScreenshotContext#

Name	Type	Description
Context < Set >	`Context < Set >` `<` `Set < >` `>`

DEFAULT_ALPHA#

Name	Type	Description
`0.7`

DEFAULT_SELECTED#

Name	Type	Description
DatasetViewOption	`plugins.fiftyone.state.DatasetViewOption()`

GRID_SPACES_DEFAULT#

Name	Type	Description
active_child	`string`
children	`Array<` `Object` `>`
component_id	`string`
id	`string`

GROUP_BY_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.GroupBy'`

LIMIT_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.Limit'`

MATCH_LABEL_TAGS#

Name	Type	Description
embeddedDocType	`Array<` `string` `>`
ftype	`string`
path	`string`

MATCH_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.Match'`

RESERVED_GROUPS#

Name	Type	Description
Set < string >	`Set < string >` `<` `string` `>`

RelayEnvironmentKey#

Name	Type	Description
EnvironmentKey	`EnvironmentKey`

SESSION_DEFAULT#

Name	Type	Description
Session	`plugins.fiftyone.state.Session()`

SKIP_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.Skip'`

SORT_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.SortBy'`

TAB_OPTIONS#

TAB_OPTIONS_MAP#

Name	Type	Description
FILTER_RULE	`string`
SELECTION	`string`

TAKE_VIEW_STAGE#

Name	Type	Description
`'fiftyone.core.stages.Take'`

appConfigDefault#

Name	Type	Description
`any`

datasetQueryContext#

Name	Type	Description
Context < savedViewsFragment$key >	`Context < savedViewsFragment$key >` `<` `plugins.fiftyone.state.savedViewsFragment$key()` `>`

modalNavigation#

Name	Type	Description
get	`(` `)`
set	`(` `value` `:` `plugins.fiftyone.state.ModalNavigation()` `)`

replace#

screenshotCallbacks#

Name	Type	Description
Set < >	`Set < >` `<` `( )` `>`

stores#

Name	Type	Description
Set < >	`Set < >` `<` `Object` `>`