@fiftyone/state¶
State¶
activeModalSample¶
Name |
Type |
Description |
---|---|---|
activeModalSample |
|
const activeModalSample = useRecoilValue(fos.activeModalSample);
activeModalSidebarSample¶
Name |
Type |
Description |
---|---|---|
activeModalSidebarSample |
|
const activeModalSidebarSample = useRecoilValue(fos.activeModalSidebarSample);
activePcdSlices¶
const [activePcdSlices, setActivePcdSlices] = useRecoilState(fos.activePcdSlices);
activePcdSlicesToSampleMap¶
const activePcdSlicesToSampleMap = useRecoilValue(fos.activePcdSlicesToSampleMap);
activePlot¶
Name |
Type |
Description |
---|---|---|
activePlot |
|
const [activePlot, setActivePlot] = useRecoilState(fos.activePlot);
activeSliceDescriptorLabel¶
Name |
Type |
Description |
---|---|---|
activeSliceDescriptorLabel |
|
const activeSliceDescriptorLabel = useRecoilValue(fos.activeSliceDescriptorLabel);
allFieldsCheckedState¶
Name |
Type |
Description |
---|---|---|
allFieldsCheckedState |
|
const [allFieldsCheckedState, setAllFieldsCheckedState] = useRecoilState(fos.allFieldsCheckedState);
allNonPcdSlices¶
const allNonPcdSlices = useRecoilValue(fos.allNonPcdSlices);
allPcdSlices¶
const allPcdSlices = useRecoilValue(fos.allPcdSlices);
allPcdSlicesToSampleMap¶
const allPcdSlicesToSampleMap = useRecoilValue(fos.allPcdSlicesToSampleMap);
anyTagging¶
Name |
Type |
Description |
---|---|---|
anyTagging |
|
const [anyTagging, setAnyTagging] = useRecoilState(fos.anyTagging);
attributeVisibility¶
Name |
Type |
Description |
---|---|---|
attributeVisibility |
|
const [attributeVisibility, setAttributeVisibility] = useRecoilState(fos.attributeVisibility);
canEditCustomColors¶
Name |
Type |
Description |
---|---|---|
canEditCustomColors |
|
const [canEditCustomColors, setCanEditCustomColors] = useRecoilState(fos.canEditCustomColors);
canEditSavedViews¶
Name |
Type |
Description |
---|---|---|
canEditSavedViews |
|
const [canEditSavedViews, setCanEditSavedViews] = useRecoilState(fos.canEditSavedViews);
colorMap¶
const colorMap = useRecoilValue(fos.colorMap);
colorMapRGB¶
const colorMapRGB = useRecoilValue(fos.colorMapRGB);
colorScheme¶
Name |
Type |
Description |
---|---|---|
colorScheme |
|
const [colorScheme, setColorScheme] = useRecoilState(fos.colorScheme);
colorSeed¶
Name |
Type |
Description |
---|---|---|
colorSeed |
|
const [colorSeed, setColorSeed] = useRecoilState(fos.colorSeed);
coloring¶
Name |
Type |
Description |
---|---|---|
coloring |
|
const [coloring, setColoring] = useRecoilState(fos.coloring);
config¶
Name |
Type |
Description |
---|---|---|
config.colorBy |
|
|
config.colorPool |
|
|
config.colorscale |
|
|
config.gridZoom |
|
|
config.lightningThreshold |
|
|
config.loopVideos |
|
|
config.multicolorKeypoints |
|
|
config.notebookHeight |
|
|
config.plugins |
|
|
config.showConfidence |
|
|
config.showIndex |
|
|
config.showLabel |
|
|
config.showSkeletons |
|
|
config.showTooltip |
|
|
config.sidebarMode |
|
|
config.theme |
|
|
config.timezone |
|
|
config.useFrameNumber |
|
const config = useRecoilValue(fos.config);
configData¶
Name |
Type |
Description |
---|---|---|
configData |
|
const [configData, setConfigData] = useRecoilState(fos.configData);
currentModalSample¶
Name |
Type |
Description |
---|---|---|
currentModalSample |
|
const [currentModalSample, setCurrentModalSample] = useRecoilState(fos.currentModalSample);
currentSampleId¶
Name |
Type |
Description |
---|---|---|
currentSampleId |
|
const currentSampleId = useRecoilValue(fos.currentSampleId);
currentViewSlug¶
Name |
Type |
Description |
---|---|---|
currentViewSlug |
|
const currentViewSlug = useRecoilValue(fos.currentViewSlug);
dataset¶
Name |
Type |
Description |
---|---|---|
dataset |
|
const [dataset, setDataset] = useRecoilState(fos.dataset);
datasetAppConfig¶
Name |
Type |
Description |
---|---|---|
datasetAppConfig |
|
const [datasetAppConfig, setDatasetAppConfig] = useRecoilState(fos.datasetAppConfig);
datasetColorScheme¶
Name |
Type |
Description |
---|---|---|
datasetColorScheme |
|
const [datasetColorScheme, setDatasetColorScheme] = useRecoilState(fos.datasetColorScheme);
datasetFrameCount¶
Name |
Type |
Description |
---|---|---|
datasetFrameCount |
|
const datasetFrameCount = useRecoilValue(fos.datasetFrameCount);
datasetId¶
Name |
Type |
Description |
---|---|---|
datasetId |
|
const [datasetId, setDatasetId] = useRecoilState(fos.datasetId);
datasetName¶
Name |
Type |
Description |
---|---|---|
datasetName |
|
const [datasetName, setDatasetName] = useRecoilState(fos.datasetName);
datasetSampleCount¶
Name |
Type |
Description |
---|---|---|
datasetSampleCount |
|
const datasetSampleCount = useRecoilValue(fos.datasetSampleCount);
defaultGroupSlice¶
Name |
Type |
Description |
---|---|---|
defaultGroupSlice |
|
const [defaultGroupSlice, setDefaultGroupSlice] = useRecoilState(fos.defaultGroupSlice);
defaultTargets¶
Name |
Type |
Description |
---|---|---|
defaultTargets |
|
const defaultTargets = useRecoilValue(fos.defaultTargets);
disabledPaths¶
Name |
Type |
Description |
---|---|---|
disabledPaths |
|
const disabledPaths = useRecoilValue(fos.disabledPaths);
distributionPaths¶
const distributionPaths = useRecoilValue(fos.distributionPaths);
dynamicGroupCurrentElementIndex¶
Name |
Type |
Description |
---|---|---|
dynamicGroupCurrentElementIndex |
|
const [dynamicGroupCurrentElementIndex, setDynamicGroupCurrentElementIndex] = useRecoilState(fos.dynamicGroupCurrentElementIndex);
dynamicGroupFields¶
const dynamicGroupFields = useRecoilValue(fos.dynamicGroupFields);
dynamicGroupIndex¶
Name |
Type |
Description |
---|---|---|
dynamicGroupIndex |
|
const [dynamicGroupIndex, setDynamicGroupIndex] = useRecoilState(fos.dynamicGroupIndex);
dynamicGroupParameters¶
Name |
Type |
Description |
---|---|---|
dynamicGroupParameters |
|
const dynamicGroupParameters = useRecoilValue(fos.dynamicGroupParameters);
dynamicGroupsViewMode¶
Name |
Type |
Description |
---|---|---|
dynamicGroupsViewMode |
|
const [dynamicGroupsViewMode, setDynamicGroupsViewMode] = useRecoilState(fos.dynamicGroupsViewMode);
elementNames¶
Name |
Type |
Description |
---|---|---|
elementNames.plural |
|
|
elementNames.singular |
|
const elementNames = useRecoilValue(fos.elementNames);
eligibleFieldsToCustomizeColor¶
const eligibleFieldsToCustomizeColor = useRecoilValue(fos.eligibleFieldsToCustomizeColor);
excludedPathsStrippedState¶
const excludedPathsStrippedState = useRecoilValue(fos.excludedPathsStrippedState);
expandedPathsState¶
const [expandedPathsState, setExpandedPathsState] = useRecoilState(fos.expandedPathsState);
extendedSelection¶
Name |
Type |
Description |
---|---|---|
extendedSelection.scope |
|
|
extendedSelection.selection |
|
const [extendedSelection, setExtendedSelection] = useRecoilState(fos.extendedSelection);
extendedSelectionOverrideStage¶
Name |
Type |
Description |
---|---|---|
extendedSelectionOverrideStage |
|
const [extendedSelectionOverrideStage, setExtendedSelectionOverrideStage] = useRecoilState(fos.extendedSelectionOverrideStage);
extendedStages¶
Name |
Type |
Description |
---|---|---|
extendedStages |
|
const extendedStages = useRecoilValue(fos.extendedStages);
extendedStagesUnsorted¶
Name |
Type |
Description |
---|---|---|
extendedStagesUnsorted |
|
const extendedStagesUnsorted = useRecoilValue(fos.extendedStagesUnsorted);
fieldSchemaState¶
Name |
Type |
Description |
---|---|---|
fieldSchemaState |
|
const [fieldSchemaState, setFieldSchemaState] = useRecoilState(fos.fieldSchemaState);
fieldVisibilityStage¶
Name |
Type |
Description |
---|---|---|
fieldVisibilityStage |
|
const [fieldVisibilityStage, setFieldVisibilityStage] = useRecoilState(fos.fieldVisibilityStage);
filters¶
Name |
Type |
Description |
---|---|---|
filters |
|
const [filters, setFilters] = useRecoilState(fos.filters);
flatFrameFields¶
const flatFrameFields = useRecoilValue(fos.flatFrameFields);
flatSampleFields¶
const flatSampleFields = useRecoilValue(fos.flatSampleFields);
frameFields¶
const frameFields = useRecoilValue(fos.frameFields);
fullSchema¶
Name |
Type |
Description |
---|---|---|
fullSchema |
|
const fullSchema = useRecoilValue(fos.fullSchema);
fullscreen¶
Name |
Type |
Description |
---|---|---|
fullscreen |
|
const [fullscreen, setFullscreen] = useRecoilState(fos.fullscreen);
getSkeleton¶
const getSkeleton = useRecoilValue(fos.getSkeleton);
getTarget¶
const getTarget = useRecoilValue(fos.getTarget);
granularSidebarExpandedStore¶
const [granularSidebarExpandedStore, setGranularSidebarExpandedStore] = useRecoilState(fos.granularSidebarExpandedStore);
groupByFieldValue¶
Name |
Type |
Description |
---|---|---|
groupByFieldValue |
|
const [groupByFieldValue, setGroupByFieldValue] = useRecoilState(fos.groupByFieldValue);
groupField¶
Name |
Type |
Description |
---|---|---|
groupField |
|
const groupField = useRecoilValue(fos.groupField);
groupId¶
Name |
Type |
Description |
---|---|---|
groupId |
|
const [groupId, setGroupId] = useRecoilState(fos.groupId);
groupMedia3dVisibleSetting¶
Name |
Type |
Description |
---|---|---|
groupMedia3dVisibleSetting |
|
const [groupMedia3dVisibleSetting, setGroupMedia3dVisibleSetting] = useRecoilState(fos.groupMedia3dVisibleSetting);
groupMediaIs3dVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIs3dVisible |
|
const groupMediaIs3dVisible = useRecoilValue(fos.groupMediaIs3dVisible);
groupMediaIsCarouselVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIsCarouselVisible |
|
const groupMediaIsCarouselVisible = useRecoilValue(fos.groupMediaIsCarouselVisible);
groupMediaIsCarouselVisibleSetting¶
Name |
Type |
Description |
---|---|---|
groupMediaIsCarouselVisibleSetting |
|
const [groupMediaIsCarouselVisibleSetting, setGroupMediaIsCarouselVisibleSetting] = useRecoilState(fos.groupMediaIsCarouselVisibleSetting);
groupMediaIsMainVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIsMainVisible |
|
const groupMediaIsMainVisible = useRecoilValue(fos.groupMediaIsMainVisible);
groupMediaIsMainVisibleSetting¶
Name |
Type |
Description |
---|---|---|
groupMediaIsMainVisibleSetting |
|
const [groupMediaIsMainVisibleSetting, setGroupMediaIsMainVisibleSetting] = useRecoilState(fos.groupMediaIsMainVisibleSetting);
groupMediaTypes¶
const groupMediaTypes = useRecoilValue(fos.groupMediaTypes);
groupMediaTypesMap¶
const groupMediaTypesMap = useRecoilValue(fos.groupMediaTypesMap);
groupMediaTypesSet¶
Name |
Type |
Description |
---|---|---|
groupMediaTypesSet |
|
const groupMediaTypesSet = useRecoilValue(fos.groupMediaTypesSet);
groupSlice¶
Name |
Type |
Description |
---|---|---|
groupSlice |
|
const [groupSlice, setGroupSlice] = useRecoilState(fos.groupSlice);
groupSlices¶
const groupSlices = useRecoilValue(fos.groupSlices);
hasGroupSlices¶
Name |
Type |
Description |
---|---|---|
hasGroupSlices |
|
const hasGroupSlices = useRecoilValue(fos.hasGroupSlices);
hasSelectedLabels¶
Name |
Type |
Description |
---|---|---|
hasSelectedLabels |
|
const hasSelectedLabels = useRecoilValue(fos.hasSelectedLabels);
hasSelectedSamples¶
Name |
Type |
Description |
---|---|---|
hasSelectedSamples |
|
const hasSelectedSamples = useRecoilValue(fos.hasSelectedSamples);
hideNoneValuedFields¶
Name |
Type |
Description |
---|---|---|
hideNoneValuedFields |
|
const [hideNoneValuedFields, setHideNoneValuedFields] = useRecoilState(fos.hideNoneValuedFields);
hoveredSample¶
Name |
Type |
Description |
---|---|---|
hoveredSample |
|
const [hoveredSample, setHoveredSample] = useRecoilState(fos.hoveredSample);
includeNestedFieldsState¶
Name |
Type |
Description |
---|---|---|
includeNestedFieldsState |
|
const [includeNestedFieldsState, setIncludeNestedFieldsState] = useRecoilState(fos.includeNestedFieldsState);
isClipsView¶
Name |
Type |
Description |
---|---|---|
isClipsView |
|
const isClipsView = useRecoilValue(fos.isClipsView);
isDynamicGroup¶
Name |
Type |
Description |
---|---|---|
isDynamicGroup |
|
const isDynamicGroup = useRecoilValue(fos.isDynamicGroup);
isFieldVisibilityActive¶
Name |
Type |
Description |
---|---|---|
isFieldVisibilityActive |
|
const isFieldVisibilityActive = useRecoilValue(fos.isFieldVisibilityActive);
isFramesView¶
Name |
Type |
Description |
---|---|---|
isFramesView |
|
const isFramesView = useRecoilValue(fos.isFramesView);
isLargeVideo¶
Name |
Type |
Description |
---|---|---|
isLargeVideo |
|
const isLargeVideo = useRecoilValue(fos.isLargeVideo);
isModalActive¶
Name |
Type |
Description |
---|---|---|
isModalActive |
|
const isModalActive = useRecoilValue(fos.isModalActive);
isNestedDynamicGroup¶
Name |
Type |
Description |
---|---|---|
isNestedDynamicGroup |
|
const isNestedDynamicGroup = useRecoilValue(fos.isNestedDynamicGroup);
isNonNestedDynamicGroup¶
Name |
Type |
Description |
---|---|---|
isNonNestedDynamicGroup |
|
const isNonNestedDynamicGroup = useRecoilValue(fos.isNonNestedDynamicGroup);
isNotebook¶
Name |
Type |
Description |
---|---|---|
isNotebook |
|
const isNotebook = useRecoilValue(fos.isNotebook);
isOrderedDynamicGroup¶
Name |
Type |
Description |
---|---|---|
isOrderedDynamicGroup |
|
const isOrderedDynamicGroup = useRecoilValue(fos.isOrderedDynamicGroup);
isPatchesView¶
Name |
Type |
Description |
---|---|---|
isPatchesView |
|
const isPatchesView = useRecoilValue(fos.isPatchesView);
isPointcloudDataset¶
Name |
Type |
Description |
---|---|---|
isPointcloudDataset |
|
const isPointcloudDataset = useRecoilValue(fos.isPointcloudDataset);
isRootView¶
Name |
Type |
Description |
---|---|---|
isRootView |
|
const isRootView = useRecoilValue(fos.isRootView);
isSidebarFilterMode¶
Name |
Type |
Description |
---|---|---|
isSidebarFilterMode |
|
const [isSidebarFilterMode, setIsSidebarFilterMode] = useRecoilState(fos.isSidebarFilterMode);
isVideoDataset¶
Name |
Type |
Description |
---|---|---|
isVideoDataset |
|
const isVideoDataset = useRecoilValue(fos.isVideoDataset);
labelPathsSet¶
Name |
Type |
Description |
---|---|---|
labelPathsSet |
|
const labelPathsSet = useRecoilValue(fos.labelPathsSet);
labelPathsSetExpanded¶
Name |
Type |
Description |
---|---|---|
labelPathsSetExpanded |
|
const labelPathsSetExpanded = useRecoilValue(fos.labelPathsSetExpanded);
lastLoadedDatasetNameState¶
Name |
Type |
Description |
---|---|---|
lastLoadedDatasetNameState |
|
const [lastLoadedDatasetNameState, setLastLoadedDatasetNameState] = useRecoilState(fos.lastLoadedDatasetNameState);
lightningFilters¶
const lightningFilters = useRecoilValue(fos.lightningFilters);
lightningThreshold¶
Name |
Type |
Description |
---|---|---|
lightningThreshold |
|
const [lightningThreshold, setLightningThreshold] = useRecoilState(fos.lightningThreshold);
lightningThresholdConfig¶
Name |
Type |
Description |
---|---|---|
lightningThresholdConfig |
|
const lightningThresholdConfig = useRecoilValue(fos.lightningThresholdConfig);
lightningUnlocked¶
Name |
Type |
Description |
---|---|---|
lightningUnlocked |
|
const lightningUnlocked = useRecoilValue(fos.lightningUnlocked);
loading¶
Name |
Type |
Description |
---|---|---|
loading |
|
const [loading, setLoading] = useRecoilState(fos.loading);
lookerPanels¶
Name |
Type |
Description |
---|---|---|
lookerPanels.help |
|
|
lookerPanels.json |
|
const [lookerPanels, setLookerPanels] = useRecoilState(fos.lookerPanels);
mediaFields¶
const [mediaFields, setMediaFields] = useRecoilState(fos.mediaFields);
mediaType¶
Name |
Type |
Description |
---|---|---|
mediaType |
|
const [mediaType, setMediaType] = useRecoilState(fos.mediaType);
mediaTypeSelector¶
Name |
Type |
Description |
---|---|---|
mediaTypeSelector |
|
const mediaTypeSelector = useRecoilValue(fos.mediaTypeSelector);
modal¶
Name |
Type |
Description |
---|---|---|
modal |
|
const [modal, setModal] = useRecoilState(fos.modal);
modalAttributeVisibility¶
Name |
Type |
Description |
---|---|---|
modalAttributeVisibility |
|
const [modalAttributeVisibility, setModalAttributeVisibility] = useRecoilState(fos.modalAttributeVisibility);
modalFilters¶
Name |
Type |
Description |
---|---|---|
modalFilters |
|
const [modalFilters, setModalFilters] = useRecoilState(fos.modalFilters);
modalGroupSlice¶
Name |
Type |
Description |
---|---|---|
modalGroupSlice |
|
const [modalGroupSlice, setModalGroupSlice] = useRecoilState(fos.modalGroupSlice);
modalLooker¶
Name |
Type |
Description |
---|---|---|
modalLooker |
|
const [modalLooker, setModalLooker] = useRecoilState(fos.modalLooker);
modalSample¶
Name |
Type |
Description |
---|---|---|
modalSample |
|
const [modalSample, setModalSample] = useRecoilState(fos.modalSample);
modalSampleId¶
Name |
Type |
Description |
---|---|---|
modalSampleId |
|
const modalSampleId = useRecoilValue(fos.modalSampleId);
modalSampleIndex¶
Name |
Type |
Description |
---|---|---|
modalSampleIndex |
|
const modalSampleIndex = useRecoilValue(fos.modalSampleIndex);
modalTopBarVisible¶
Name |
Type |
Description |
---|---|---|
modalTopBarVisible |
|
const [modalTopBarVisible, setModalTopBarVisible] = useRecoilState(fos.modalTopBarVisible);
nonPcdSamples¶
const nonPcdSamples = useRecoilValue(fos.nonPcdSamples);
noneValuedPaths¶
Name |
Type |
Description |
---|---|---|
noneValuedPaths |
|
const [noneValuedPaths, setNoneValuedPaths] = useRecoilState(fos.noneValuedPaths);
nullableModalSampleId¶
Name |
Type |
Description |
---|---|---|
nullableModalSampleId |
|
const nullableModalSampleId = useRecoilValue(fos.nullableModalSampleId);
parentMediaTypeSelector¶
Name |
Type |
Description |
---|---|---|
parentMediaTypeSelector |
|
const parentMediaTypeSelector = useRecoilValue(fos.parentMediaTypeSelector);
patching¶
Name |
Type |
Description |
---|---|---|
patching |
|
const [patching, setPatching] = useRecoilState(fos.patching);
pcdSamples¶
const pcdSamples = useRecoilValue(fos.pcdSamples);
pinned3DSample¶
Name |
Type |
Description |
---|---|---|
pinned3DSample |
|
const pinned3DSample = useRecoilValue(fos.pinned3DSample);
pinned3DSampleSlice¶
Name |
Type |
Description |
---|---|---|
pinned3DSampleSlice |
|
const [pinned3DSampleSlice, setPinned3DSampleSlice] = useRecoilState(fos.pinned3DSampleSlice);
pinned3d¶
Name |
Type |
Description |
---|---|---|
pinned3d |
|
const [pinned3d, setPinned3d] = useRecoilState(fos.pinned3d);
readOnly¶
Name |
Type |
Description |
---|---|---|
readOnly |
|
const [readOnly, setReadOnly] = useRecoilState(fos.readOnly);
refreshGroupQuery¶
Name |
Type |
Description |
---|---|---|
refreshGroupQuery |
|
const [refreshGroupQuery, setRefreshGroupQuery] = useRecoilState(fos.refreshGroupQuery);
refresher¶
Name |
Type |
Description |
---|---|---|
refresher |
|
const [refresher, setRefresher] = useRecoilState(fos.refresher);
rootElementName¶
Name |
Type |
Description |
---|---|---|
rootElementName |
|
const rootElementName = useRecoilValue(fos.rootElementName);
rootElementNamePlural¶
Name |
Type |
Description |
---|---|---|
rootElementNamePlural |
|
const rootElementNamePlural = useRecoilValue(fos.rootElementNamePlural);
sampleFields¶
const sampleFields = useRecoilValue(fos.sampleFields);
savedLookerOptions¶
const [savedLookerOptions, setSavedLookerOptions] = useRecoilState(fos.savedLookerOptions);
savedViewsSelector¶
const savedViewsSelector = useRecoilValue(fos.savedViewsSelector);
savingFilters¶
Name |
Type |
Description |
---|---|---|
savingFilters |
|
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 |
|
const [schemaSearchTerm, setSchemaSearchTerm] = useRecoilState(fos.schemaSearchTerm);
schemaSelectedSettingsTab¶
Name |
Type |
Description |
---|---|---|
schemaSelectedSettingsTab |
|
const [schemaSelectedSettingsTab, setSchemaSelectedSettingsTab] = useRecoilState(fos.schemaSelectedSettingsTab);
searchMetaFilterState¶
const [searchMetaFilterState, setSearchMetaFilterState] = useRecoilState(fos.searchMetaFilterState);
selectedLabelIds¶
Name |
Type |
Description |
---|---|---|
selectedLabelIds |
|
const selectedLabelIds = useRecoilValue(fos.selectedLabelIds);
selectedLabelMap¶
Name |
Type |
Description |
---|---|---|
selectedLabelMap |
|
const [selectedLabelMap, setSelectedLabelMap] = useRecoilState(fos.selectedLabelMap);
selectedLabels¶
const [selectedLabels, setSelectedLabels] = useRecoilState(fos.selectedLabels);
selectedPatchSamples¶
Name |
Type |
Description |
---|---|---|
selectedPatchSamples |
|
const selectedPatchSamples = useRecoilValue(fos.selectedPatchSamples);
selectedSampleObjects¶
Name |
Type |
Description |
---|---|---|
selectedSampleObjects |
|
const [selectedSampleObjects, setSelectedSampleObjects] = useRecoilState(fos.selectedSampleObjects);
selectedSamples¶
Name |
Type |
Description |
---|---|---|
selectedSamples |
|
const [selectedSamples, setSelectedSamples] = useRecoilState(fos.selectedSamples);
selectedSavedViewState¶
Name |
Type |
Description |
---|---|---|
selectedSavedViewState |
|
const [selectedSavedViewState, setSelectedSavedViewState] = useRecoilState(fos.selectedSavedViewState);
selectedViewName¶
Name |
Type |
Description |
---|---|---|
selectedViewName |
|
const [selectedViewName, setSelectedViewName] = useRecoilState(fos.selectedViewName);
sessionGroupSlice¶
Name |
Type |
Description |
---|---|---|
sessionGroupSlice |
|
const [sessionGroupSlice, setSessionGroupSlice] = useRecoilState(fos.sessionGroupSlice);
sessionSpaces¶
Name |
Type |
Description |
---|---|---|
sessionSpaces |
|
const [sessionSpaces, setSessionSpaces] = useRecoilState(fos.sessionSpaces);
settingsModal¶
Name |
Type |
Description |
---|---|---|
settingsModal.open |
|
const [settingsModal, setSettingsModal] = useRecoilState(fos.settingsModal);
shouldRenderImaVidLooker¶
Name |
Type |
Description |
---|---|---|
shouldRenderImaVidLooker |
|
const shouldRenderImaVidLooker = useRecoilValue(fos.shouldRenderImaVidLooker);
showMetadataState¶
Name |
Type |
Description |
---|---|---|
showMetadataState |
|
const [showMetadataState, setShowMetadataState] = useRecoilState(fos.showMetadataState);
showNestedFieldsState¶
Name |
Type |
Description |
---|---|---|
showNestedFieldsState |
|
const [showNestedFieldsState, setShowNestedFieldsState] = useRecoilState(fos.showNestedFieldsState);
showOverlays¶
Name |
Type |
Description |
---|---|---|
showOverlays |
|
const [showOverlays, setShowOverlays] = useRecoilState(fos.showOverlays);
sidebarSampleId¶
Name |
Type |
Description |
---|---|---|
sidebarSampleId |
|
const sidebarSampleId = useRecoilValue(fos.sidebarSampleId);
similarityMethods¶
Name |
Type |
Description |
---|---|---|
similarityMethods.patches |
|
|
similarityMethods.samples |
|
const similarityMethods = useRecoilValue(fos.similarityMethods);
similarityParameters¶
Name |
Type |
Description |
---|---|---|
similarityParameters |
|
const [similarityParameters, setSimilarityParameters] = useRecoilState(fos.similarityParameters);
similaritySorting¶
Name |
Type |
Description |
---|---|---|
similaritySorting |
|
const [similaritySorting, setSimilaritySorting] = useRecoilState(fos.similaritySorting);
snackbarErrors¶
const [snackbarErrors, setSnackbarErrors] = useRecoilState(fos.snackbarErrors);
stageDefinitions¶
const stageDefinitions = useRecoilValue(fos.stageDefinitions);
stageInfo¶
Name |
Type |
Description |
---|---|---|
stageInfo |
|
const [stageInfo, setStageInfo] = useRecoilState(fos.stageInfo);
stateSubscription¶
Name |
Type |
Description |
---|---|---|
stateSubscription |
|
const stateSubscription = useRecoilValue(fos.stateSubscription);
targets¶
Name |
Type |
Description |
---|---|---|
targets.defaults |
|
|
targets.fields |
|
const targets = useRecoilValue(fos.targets);
theme¶
Name |
Type |
Description |
---|---|---|
theme |
|
const [theme, setTheme] = useRecoilState(fos.theme);
themeConfig¶
Name |
Type |
Description |
---|---|---|
themeConfig |
|
const themeConfig = useRecoilValue(fos.themeConfig);
view¶
const [view, setView] = useRecoilState(fos.view);
viewCls¶
Name |
Type |
Description |
---|---|---|
viewCls |
|
const [viewCls, setViewCls] = useRecoilState(fos.viewCls);
viewCounter¶
Name |
Type |
Description |
---|---|---|
viewCounter |
|
const [viewCounter, setViewCounter] = useRecoilState(fos.viewCounter);
viewName¶
Name |
Type |
Description |
---|---|---|
viewName |
|
const [viewName, setViewName] = useRecoilState(fos.viewName);
viewSchemaState¶
Name |
Type |
Description |
---|---|---|
viewSchemaState |
|
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 |
|
const [viewStateForm_INTERNAL, setViewStateForm_INTERNAL] = useRecoilState(fos.viewStateForm_INTERNAL);
Hooks¶
useAssertedRecoilValue¶
-
fos.
useAssertedRecoilValue
(recoilValue)¶ - Arguments
recoilValue (RecoilValue < T >) –
- Return type
plugins.fiftyone.state.T()
useBrowserStorage¶
-
fos.
useBrowserStorage
(key, initialValue, useSessionStorage)¶ - Arguments
key (string) –
initialValue (T) –
useSessionStorage (boolean) –
- 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
()¶
- Arguments
args ([ ]) –
- 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.
useCreateLooker¶
-
fos.
useCreateLooker
(isModal, thumbnail, options, highlight)¶ - Arguments
isModal (boolean) –
thumbnail (boolean) –
options (Omit < , >) –
highlight (( sample : Sample )) –
- Return type
MutableRefObject < >
<
( args : )
>
useEntries¶
-
fos.
useEntries
(modal)¶ - Arguments
modal (boolean) –
- Return type
[
Array< SidebarEntry >
,
( entries : )
]
useEventHandler¶
-
fos.
useEventHandler
(target, eventType, handler, useCapture)¶ - Arguments
target (EventTarget) –
eventType (string) –
handler (( event : any )) –
useCapture (boolean) –
- 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
useHoveredSample¶
-
fos.
useHoveredSample
(sample, auxHandlers)¶ - Arguments
sample (AppSample) –
auxHandlers (any) –
- 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()}
/>
)
}
useKeydownHandler¶
-
fos.
useKeydownHandler
(handler)¶ - Arguments
handler (KeyboardEventHandler < Element >) –
- 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()
>
useNotification¶
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 < HTMLElement >) –
handler (MouseEventHandler < Element >) –
eventName (string) –
- Return type
void
useRefresh¶
Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.
useResetExtendedSelection¶
-
fos.
useResetExtendedSelection
()¶ -
fos.
resetExtendedSelection
()¶ - Arguments
args ([ ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useSearchSchemaFields¶
-
fos.
useSearchSchemaFields
(mergedSchema)¶ - Arguments
mergedSchema (Any) –
- Return type
Object
useSelectFlashlightSample¶
-
fos.
useSelectFlashlightSample
()¶ -
fos.
selectFlashlightSample
()¶ - Arguments
args ([ default , SelectThumbnailData ]) –
- 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.
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
useSessionSetter¶
useSetExpandedSample¶
-
fos.
useSetExpandedSample
()¶ -
fos.
setExpandedSample
()¶ - Arguments
args ([ index ]) –
- 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.
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()
>
useSimilarityType¶
-
fos.
useSimilarityType
(props)¶ - Arguments
props (SimilarityTypeProp) –
- Return type
Object
useToClips¶
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.
useUpdateSamples¶
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.lightning (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.customView (any) –
parameter.extended (boolean) –
parameter.lightning (boolean) –
parameter.mixed (boolean) –
parameter.modal (boolean) –
parameter.paths (Array< string >) –
parameter.root (boolean) –
- Return type
RecoilState < >
<
Array< Aggregation >
>
GraphQL Selector Family for Aggregations.
aggregations¶
-
fos.
aggregations
(param)¶ - Arguments
param (Object) –
param.extended (boolean) –
param.lightning (boolean) –
param.mixed (boolean) –
param.modal (boolean) –
param.paths (Array< string >) –
- 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< StrictField >) –
frameFields (Array< StrictField >) –
- Return type
plugins.fiftyone.state.Schema()
collapseFields¶
-
fos.
collapseFields
(paths)¶ - Arguments
paths (any) –
- Return type
Array<
plugins.fiftyone.state.StrictField()
>
configuredSidebarModeDefault¶
-
fos.
configuredSidebarModeDefault
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Union< , , >
>
Returns a function which returns a memoized atom for each unique parameter value.
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< string , >) –
param.extended (boolean) –
param.ftype (Union< string , >) –
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< string , >) –
param.extended (boolean) –
param.ftype (Union< string , >) –
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.
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 (string) –
- Return type
RecoilState < >
<
( cursor : number , pageSize : number )
>
Returns a function which returns a memoized atom for each unique parameter value.
dynamicGroupViewQuery¶
-
fos.
dynamicGroupViewQuery
(param)¶ - Arguments
param (Object) –
param.groupByFieldValueExplicit (string) –
- Return type
RecoilState < >
<
Array< Stage >
>
Returns a function which returns a memoized atom for each unique parameter value.
dynamicGroupsElementCount¶
-
fos.
dynamicGroupsElementCount
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < number >
<
number
>
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.
fieldPaths¶
-
fos.
fieldPaths
(param)¶ - Arguments
param (Object) –
param.embeddedDocType (Union< string , >) –
param.ftype (Union< string , >) –
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< string , >) –
param.ftype (Union< string , >) –
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< StrictField >) –
matcher (( field : StrictField )) –
present (Set < string >) –
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< string >) –
schema (Schema) –
- Return type
Array<
string
>
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()
>
getEmbeddedLabelFields¶
-
fos.
getEmbeddedLabelFields
(fields, prefix)¶ - Arguments
fields (Array< StrictField >) –
prefix (string) –
- Return type
Array<
string
>
getLabelFields¶
-
fos.
getLabelFields
(fields, prefix)¶ - Arguments
fields (Array< StrictField >) –
prefix (string) –
- Return type
Array<
string
>
getSample¶
-
fos.
getSample
(id)¶ - Arguments
id (string) –
- Return type
plugins.fiftyone.state.ModalSample()
getSanitizedGroupByExpression¶
-
fos.
getSanitizedGroupByExpression
(expression)¶ - Arguments
expression (string) –
- Return type
string
granularSidebarExpanded¶
-
fos.
granularSidebarExpanded
(param)¶ - Arguments
param (string) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
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< string >) –
- 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.
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.
isDisabledPath¶
-
fos.
isDisabledPath
(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.
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.
isLightningPath¶
-
fos.
isLightningPath
(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.
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.
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.
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.
lightningPaths¶
-
fos.
lightningPaths
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < Set >
<
Set < string >
>
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< string >) –
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()
meetsType¶
-
fos.
meetsType
(param)¶ - Arguments
param (Object) –
param.acceptLists (boolean) –
param.embeddedDocType (Union< string , >) –
param.ftype (Union< string , >) –
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.
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
readonly
readonly RecoilValueReadOnly < 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.
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.
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.
pathIndex¶
-
fos.
pathIndex
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
pathIsLocked¶
-
fos.
pathIsLocked
(param)¶ - Arguments
param (string) –
- 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
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.
resolveGroups¶
-
fos.
resolveGroups
(sampleFields, frameFields, currentGroups, configGroups)¶ - Arguments
sampleFields (Array< StrictField >) –
frameFields (Array< StrictField >) –
currentGroups (Array< SidebarGroup >) –
configGroups (Array< SidebarGroup >) –
- Return type
Array<
plugins.fiftyone.state.SidebarGroup()
>
resolveSidebarGroups¶
-
fos.
resolveSidebarGroups
(sampleFields, frameFields)¶ - Arguments
sampleFields (Array< StrictField >) –
frameFields (Array< StrictField >) –
- Return type
Array<
plugins.fiftyone.state.SidebarGroup()
>
resolvedSidebarMode¶
-
fos.
resolvedSidebarMode
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Union< , >
>
Returns a function which returns a memoized atom for each unique parameter value.
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¶
setCurrentEnvironment¶
-
fos.
setCurrentEnvironment
(environment)¶ - Arguments
environment (default) –
- Return type
void
sidebarEntries¶
- 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¶
- 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¶
- Arguments
param (boolean) –
- Return type
RecoilState < >
<
Any
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarGroup¶
- 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¶
- 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¶
- Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Array< string >
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarGroups¶
- Arguments
param (Object) –
param.filtered (boolean) –
param.loading (boolean) –
param.modal (boolean) –
- Return type
RecoilState < >
<
Array< SidebarGroup >
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarGroupsDefinition¶
- Arguments
params (boolean) –
- Return type
RecoilState < >
<
Array< SidebarGroup >
>
sidebarMode¶
- Arguments
param (boolean) –
- Return type
RecoilState < >
<
Union< , , >
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarVisible¶
- Arguments
param (boolean) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarWidth¶
- 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.
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
validateGroupName¶
-
fos.
validateGroupName
(current, name)¶ - Arguments
current (Array< string >) –
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 (any) –
viewTwo (any) –
- Return type
boolean
Types¶
SPACE¶
Name |
Value |
---|---|
FRAME |
|
SAMPLE |
AnnotationRun¶
-
class
fos.
AnnotationRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
BrainRun¶
-
class
fos.
BrainRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
Config¶
-
class
fos.
Config
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
colorPool |
|
|
colorscale |
|
|
customizedColors |
|
|
gridZoom |
|
|
loopVideos |
|
|
mediaFields |
|
|
notebookHeight |
|
|
plugins |
|
|
showConfidence |
|
|
showIndex |
|
|
showLabel |
|
|
showTooltip |
|
|
sidebarMode |
|
|
theme |
|
|
timezone |
|
|
useFrameNumber |
|
Dataset¶
-
class
fos.
Dataset
()¶
The dataset object returned by the API.
Properties¶
Name |
Type |
Description |
---|---|---|
appConfig |
|
|
brainMethods |
|
|
createdAt |
|
|
datasetId |
|
|
defaultMaskTargets |
|
|
defaultSkeleton |
|
|
evaluations |
|
|
groupField |
|
|
groupMediaTypes |
|
|
groupSlice |
|
|
id |
|
|
info |
|
|
lastLoadedAt |
|
|
maskTargets |
|
|
mediaType |
|
|
name |
|
|
parentMediaType |
|
|
skeletons |
|
|
version |
|
DatasetAppConfig¶
-
class
fos.
DatasetAppConfig
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
gridMediaField |
|
|
mediaFields |
|
|
modalMediaField |
|
|
plugins |
|
|
sidebarMode |
|
Description¶
-
class
fos.
Description
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
dataset |
|
|
fieldVisibilityStage |
|
|
savedViewSlug |
|
|
savedViews |
|
|
selected |
|
|
selectedLabels |
|
|
spaces |
|
|
view |
|
|
viewCls |
|
|
viewName |
|
DynamicGroupParameters¶
-
class
fos.
DynamicGroupParameters
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
groupBy |
|
|
orderBy |
|
EvaluationRun¶
-
class
fos.
EvaluationRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
FieldVisibilityStage¶
-
class
fos.
FieldVisibilityStage
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
cls |
|
|
kwargs |
|
KeypointSkeleton¶
-
class
fos.
KeypointSkeleton
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
edges |
|
|
labels |
|
Run¶
-
class
fos.
Run
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
SavedView¶
-
class
fos.
SavedView
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
color |
|
|
createdAt |
|
|
datasetId |
|
|
description |
|
|
id |
|
|
lastLoadedAt |
|
|
lastModifiedAt |
|
|
name |
|
|
slug |
|
|
viewStages |
|
SelectedLabel¶
-
class
fos.
SelectedLabel
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
field |
|
|
frameNumber |
|
|
labelId |
|
|
sampleId |
|
SelectedLabelData¶
-
class
fos.
SelectedLabelData
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
field |
|
|
frameNumber |
|
|
sampleId |
|
SidebarGroup¶
-
class
fos.
SidebarGroup
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
expanded |
|
|
name |
|
|
paths |
|
SortBySimilarityParameters¶
-
class
fos.
SortBySimilarityParameters
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
brainKey |
|
|
distField |
|
|
k |
|
|
query |
|
|
queryIds |
|
|
reverse |
|
StrictKeypointSkeleton¶
-
class
fos.
StrictKeypointSkeleton
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
edges |
|
|
labels |
|
|
name |
|
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_SPACE_ID¶
Name |
Type |
Description |
---|---|---|
|
BooleanFilter¶
-
class
fos.
BooleanFilter
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
exclude |
|
|
false |
|
|
isMatching |
|
|
none |
|
|
true |
|
EmptyEntry¶
-
class
fos.
EmptyEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
group |
|
|
kind |
|
|
shown |
|
GroupEntry¶
-
class
fos.
GroupEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
name |
|
InputEntry¶
-
class
fos.
InputEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
type |
|
LookerStore¶
-
class
fos.
LookerStore
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
indices |
|
|
lookers |
|
|
reset |
|
|
samples |
|
NumericFilter¶
-
class
fos.
NumericFilter
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
exclude |
|
|
inf |
|
|
isMatching |
|
|
nan |
|
|
ninf |
|
|
none |
|
|
range |
|
PathEntry¶
-
class
fos.
PathEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
path |
|
|
shown |
|
Session¶
-
class
fos.
Session
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
canEditCustomColors |
|
|
canEditSavedViews |
|
|
colorScheme |
|
|
fieldVisibilityStage |
|
|
readOnly |
|
|
selectedLabels |
|
|
selectedSamples |
|
|
sessionGroupSlice |
|
|
sessionSpaces |
|
AggregationResponseFrom¶
A generic type that extracts the response type from a GraphQL query.
-
class
fos.
DatasetViewOption
()¶
Method¶
Name |
Type |
Description |
---|---|---|
Method.key |
|
|
Method.maxK |
|
|
Method.supportsLeastSimilarity |
|
|
Method.supportsPrompts |
|
ModalSampleData¶
Name |
Type |
Description |
---|---|---|
ModalSampleData |
|
-
class
fos.
PathFilterSelector
()¶
Variables¶
BeforeScreenshotContext¶
Name |
Type |
Description |
---|---|---|
Context < Set > |
|
DEFAULT_ALPHA¶
Name |
Type |
Description |
---|---|---|
|
DEFAULT_SELECTED¶
Name |
Type |
Description |
---|---|---|
DatasetViewOption |
|
GROUP_BY_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
LIMIT_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
MATCH_LABEL_TAGS¶
Name |
Type |
Description |
---|---|---|
embeddedDocType |
|
|
ftype |
|
|
path |
|
MATCH_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
RESERVED_GROUPS¶
Name |
Type |
Description |
---|---|---|
Set < string > |
|
RelayEnvironmentKey¶
Name |
Type |
Description |
---|---|---|
EnvironmentKey |
|
SESSION_DEFAULT¶
Name |
Type |
Description |
---|---|---|
Session |
|
SKIP_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
SORT_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
SPACES_DEFAULT¶
Name |
Type |
Description |
---|---|---|
activeChild |
|
|
children |
|
|
id |
|
|
type |
|
TAB_OPTIONS¶
TAB_OPTIONS_MAP¶
Name |
Type |
Description |
---|---|---|
FILTER_RULE |
|
|
SELECTION |
|
TAKE_VIEW_STAGE¶
Name |
Type |
Description |
---|---|---|
|
appConfigDefault¶
Name |
Type |
Description |
---|---|---|
|
datasetQueryContext¶
Name |
Type |
Description |
---|---|---|
Context < savedViewsFragment$key > |
|
replace¶
screenshotCallbacks¶
Name |
Type |
Description |
---|---|---|
Set < > |
|
stores¶
Name |
Type |
Description |
---|---|---|
Set < > |
|