fiftyone.state¶
State¶
activePlot¶
Name |
Type |
Description |
---|---|---|
activePlot |
|
const [activePlot, setActivePlot] = useRecoilState(fos.activePlot);
anyTagging¶
Name |
Type |
Description |
---|---|---|
anyTagging |
|
const [anyTagging, setAnyTagging] = useRecoilState(fos.anyTagging);
appTeamsIsOpen¶
Name |
Type |
Description |
---|---|---|
appTeamsIsOpen |
|
const [appTeamsIsOpen, setAppTeamsIsOpen] = useRecoilState(fos.appTeamsIsOpen);
canEditSavedViews¶
Name |
Type |
Description |
---|---|---|
canEditSavedViews |
|
const [canEditSavedViews, setCanEditSavedViews] = useRecoilState(fos.canEditSavedViews);
colorPool¶
const colorPool = useRecoilValue(fos.colorPool);
colorscale¶
const colorscale = useRecoilValue(fos.colorscale);
compactLayout¶
Name |
Type |
Description |
---|---|---|
compactLayout |
|
const [compactLayout, setCompactLayout] = useRecoilState(fos.compactLayout);
config¶
Name |
Type |
Description |
---|---|---|
config.colorBy |
|
|
config.colorPool |
|
|
config.colorscale |
|
|
config.gridZoom |
|
|
config.loopVideos |
|
|
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);
currentViewSlug¶
Name |
Type |
Description |
---|---|---|
currentViewSlug |
|
const currentViewSlug = useRecoilValue(fos.currentViewSlug);
dataset¶
The state of the current dataset. Contains informations about the dataset, and the samples contained in it.
See fiftyone.core.dataset.Dataset
for python documentation.
Name |
Type |
Description |
---|---|---|
dataset |
const [dataset, setDataset] = useRecoilState(fos.dataset);
datasetAppConfig¶
Name |
Type |
Description |
---|---|---|
datasetAppConfig |
const datasetAppConfig = useRecoilValue(fos.datasetAppConfig);
datasetName¶
Name |
Type |
Description |
---|---|---|
datasetName |
|
const datasetName = useRecoilValue(fos.datasetName);
defaultGroupSlice¶
Name |
Type |
Description |
---|---|---|
defaultGroupSlice |
|
const defaultGroupSlice = useRecoilValue(fos.defaultGroupSlice);
defaultPinnedSlice¶
Name |
Type |
Description |
---|---|---|
defaultPinnedSlice |
|
const defaultPinnedSlice = useRecoilValue(fos.defaultPinnedSlice);
defaultTargets¶
Name |
Type |
Description |
---|---|---|
defaultTargets |
const defaultTargets = useRecoilValue(fos.defaultTargets);
disabledPaths¶
Name |
Type |
Description |
---|---|---|
disabledPaths |
|
const disabledPaths = useRecoilValue(fos.disabledPaths);
elementNames¶
Name |
Type |
Description |
---|---|---|
elementNames.plural |
|
|
elementNames.singular |
|
const elementNames = useRecoilValue(fos.elementNames);
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);
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);
groupField¶
Name |
Type |
Description |
---|---|---|
groupField |
|
const groupField = useRecoilValue(fos.groupField);
groupId¶
Name |
Type |
Description |
---|---|---|
groupId |
|
const [groupId, setGroupId] = useRecoilState(fos.groupId);
groupMediaIs3DVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIs3DVisible |
|
const [groupMediaIs3DVisible, setGroupMediaIs3DVisible] = useRecoilState(fos.groupMediaIs3DVisible);
groupMediaIsCarouselVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIsCarouselVisible |
|
const [groupMediaIsCarouselVisible, setGroupMediaIsCarouselVisible] = useRecoilState(fos.groupMediaIsCarouselVisible);
groupMediaIsImageVisible¶
Name |
Type |
Description |
---|---|---|
groupMediaIsImageVisible |
|
const [groupMediaIsImageVisible, setGroupMediaIsImageVisible] = useRecoilState(fos.groupMediaIsImageVisible);
groupMediaTypes¶
const groupMediaTypes = useRecoilValue(fos.groupMediaTypes);
groupPaginationFragment¶
Name |
Type |
Description |
---|---|---|
groupPaginationFragment |
|
const groupPaginationFragment = useRecoilValue(fos.groupPaginationFragment);
groupQuery¶
Name |
Type |
Description |
---|---|---|
groupQuery |
|
const [groupQuery, setGroupQuery] = useRecoilState(fos.groupQuery);
groupSlices¶
const groupSlices = useRecoilValue(fos.groupSlices);
hasPinnedSlice¶
Name |
Type |
Description |
---|---|---|
hasPinnedSlice |
|
const hasPinnedSlice = useRecoilValue(fos.hasPinnedSlice);
hasSelectedLabels¶
Name |
Type |
Description |
---|---|---|
hasSelectedLabels |
|
const hasSelectedLabels = useRecoilValue(fos.hasSelectedLabels);
hasSelectedSamples¶
Name |
Type |
Description |
---|---|---|
hasSelectedSamples |
|
const hasSelectedSamples = useRecoilValue(fos.hasSelectedSamples);
hoveredSample¶
Name |
Type |
Description |
---|---|---|
hoveredSample |
|
const [hoveredSample, setHoveredSample] = useRecoilState(fos.hoveredSample);
isClipsView¶
Name |
Type |
Description |
---|---|---|
isClipsView |
|
const isClipsView = useRecoilValue(fos.isClipsView);
isFramesView¶
Name |
Type |
Description |
---|---|---|
isFramesView |
|
const isFramesView = useRecoilValue(fos.isFramesView);
isLargeVideo¶
Name |
Type |
Description |
---|---|---|
isLargeVideo |
|
const isLargeVideo = useRecoilValue(fos.isLargeVideo);
isNotebook¶
Name |
Type |
Description |
---|---|---|
isNotebook |
|
const isNotebook = useRecoilValue(fos.isNotebook);
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);
isVideoDataset¶
Name |
Type |
Description |
---|---|---|
isVideoDataset |
|
const isVideoDataset = useRecoilValue(fos.isVideoDataset);
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 = useRecoilValue(fos.mediaFields);
mediaTypeSelector¶
Name |
Type |
Description |
---|---|---|
mediaTypeSelector |
|
const mediaTypeSelector = useRecoilValue(fos.mediaTypeSelector);
modalFilters¶
Name |
Type |
Description |
---|---|---|
modalFilters |
const [modalFilters, setModalFilters] = useRecoilState(fos.modalFilters);
modalTopBarVisible¶
Name |
Type |
Description |
---|---|---|
modalTopBarVisible |
|
const [modalTopBarVisible, setModalTopBarVisible] = useRecoilState(fos.modalTopBarVisible);
patching¶
Name |
Type |
Description |
---|---|---|
patching |
|
const [patching, setPatching] = useRecoilState(fos.patching);
pinnedSlice¶
Name |
Type |
Description |
---|---|---|
pinnedSlice |
|
const [pinnedSlice, setPinnedSlice] = useRecoilState(fos.pinnedSlice);
pinnedSliceSample¶
Name |
Type |
Description |
---|---|---|
pinnedSliceSample.id |
|
|
pinnedSliceSample.sample |
|
|
pinnedSliceSample.urls |
|
const [pinnedSliceSample, setPinnedSliceSample] = useRecoilState(fos.pinnedSliceSample);
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);
savedLookerOptions¶
const [savedLookerOptions, setSavedLookerOptions] = useRecoilState(fos.savedLookerOptions);
savedViewsSelector¶
const savedViewsSelector = useRecoilValue(fos.savedViewsSelector);
savingFilters¶
Name |
Type |
Description |
---|---|---|
savingFilters |
|
const [savingFilters, setSavingFilters] = useRecoilState(fos.savingFilters);
selectedLabelIds¶
Name |
Type |
Description |
---|---|---|
selectedLabelIds |
|
const selectedLabelIds = useRecoilValue(fos.selectedLabelIds);
selectedLabelList¶
const selectedLabelList = useRecoilValue(fos.selectedLabelList);
selectedLabels¶
Name |
Type |
Description |
---|---|---|
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);
sessionSpaces¶
Name |
Type |
Description |
---|---|---|
sessionSpaces |
|
const [sessionSpaces, setSessionSpaces] = useRecoilState(fos.sessionSpaces);
showOverlays¶
Name |
Type |
Description |
---|---|---|
showOverlays |
|
const [showOverlays, setShowOverlays] = useRecoilState(fos.showOverlays);
sidebarOverride¶
Name |
Type |
Description |
---|---|---|
sidebarOverride |
|
const [sidebarOverride, setSidebarOverride] = useRecoilState(fos.sidebarOverride);
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);
stageInfo¶
Name |
Type |
Description |
---|---|---|
stageInfo |
|
const [stageInfo, setStageInfo] = useRecoilState(fos.stageInfo);
stateProxy¶
Name |
Type |
Description |
---|---|---|
stateProxy |
|
const [stateProxy, setStateProxy] = useRecoilState(fos.stateProxy);
stateSubscription¶
Name |
Type |
Description |
---|---|---|
stateSubscription |
|
const stateSubscription = useRecoilValue(fos.stateSubscription);
targets¶
Name |
Type |
Description |
---|---|---|
targets.defaults |
||
targets.fields |
|
const targets = useRecoilValue(fos.targets);
teams¶
Name |
Type |
Description |
---|---|---|
teams.minimized |
|
|
teams.open |
|
|
teams.submitted |
|
const [teams, setTeams] = useRecoilState(fos.teams);
theme¶
Name |
Type |
Description |
---|---|---|
theme |
|
const [theme, setTheme] = useRecoilState(fos.theme);
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);
Hooks¶
useBrowserStorage¶
-
fiftyone.state.
useBrowserStorage
(key, initialValue, useSessionStorage)¶ - Arguments
key (string) –
initialValue (T) –
useSessionStorage (boolean) –
- Return type
readonly
useClearModal¶
-
fiftyone.state.
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.
fiftyone.state.
clearModal
()¶
- Arguments
args ([ ]) –
- Return type
void
Returns a function that executes an atomic transaction for updating Recoil state.
useCreateLooker¶
-
fiftyone.state.
useCreateLooker
(isModal, thumbnail, options, highlight)¶ - Arguments
isModal (boolean) –
thumbnail (boolean) –
options (Omit < ReturnType , >) –
highlight (boolean) –
- Return type
MutableRefObject < >
<
( data : SampleData )
>
useEntries¶
-
fiftyone.state.
useEntries
(modal)¶ - Arguments
modal (boolean) –
- Return type
[
Array< SidebarEntry >
,
( entries : )
]
useEventHandler¶
-
fiftyone.state.
useEventHandler
(target, eventType, handler, useCapture)¶ - Arguments
target (any) –
eventType (any) –
handler (any) –
useCapture (boolean) –
- Return type
void
useExpandSample¶
-
fiftyone.state.
useExpandSample
()¶ -
fiftyone.state.
expandSample
()¶ - Arguments
args ([ sample , 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.
useFollow¶
-
fiftyone.state.
useFollow
(leaderRef, followerRef, set)¶ - Arguments
leaderRef (any) –
followerRef (any) –
set (any) –
- Return type
void
useHashChangeHandler¶
-
fiftyone.state.
useHashChangeHandler
(handler)¶ - Arguments
handler (any) –
- Return type
void
useHoveredSample¶
-
fiftyone.state.
useHoveredSample
(sample, auxHandlers)¶ - Arguments
sample (AppSample) –
auxHandlers (any) –
- Return type
Object
useJSONPanel¶
-
fiftyone.state.
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¶
-
fiftyone.state.
useKeydownHandler
(handler)¶ - Arguments
handler (any) –
- Return type
void
useLabelTagText¶
-
fiftyone.state.
useLabelTagText
(modal)¶ - Arguments
modal (boolean) –
- Return type
Object
useLookerOptions¶
-
fiftyone.state.
useLookerOptions
(modal)¶ - Arguments
modal (boolean) –
- Return type
Partial < Omit >
<
Omit < , >
>
useObserve¶
-
fiftyone.state.
useObserve
(target, handler)¶ - Arguments
target (any) –
handler (any) –
- Return type
void
useOnSelectLabel¶
-
fiftyone.state.
useOnSelectLabel
()¶ -
fiftyone.state.
onSelectLabel
()¶ - Arguments
args ([ SelectEvent ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useOutsideClick¶
-
fiftyone.state.
useOutsideClick
(ref, handler)¶ - Arguments
ref (any) –
handler (any) –
- Return type
void
usePanel¶
-
fiftyone.state.
usePanel
(name, atom)¶ - Arguments
name (any) –
atom (any) –
- Return type
Object
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.
useReset¶
Returns a function that executes an atomic transaction for updating Recoil state.
useResetExtendedSelection¶
-
fiftyone.state.
useResetExtendedSelection
()¶ -
fiftyone.state.
resetExtendedSelection
()¶ - Arguments
args ([ ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useResizeHandler¶
-
fiftyone.state.
useResizeHandler
(handler)¶ - Arguments
handler (any) –
- Return type
void
useRouter¶
-
fiftyone.state.
useRouter
(makeRoutes, deps)¶ - Arguments
makeRoutes (( environment : default )) –
deps (DependencyList) –
- Return type
Object
useScrollHandler¶
-
fiftyone.state.
useScrollHandler
(handler)¶ - Arguments
handler (any) –
- Return type
void
useSelectFlashlightSample¶
-
fiftyone.state.
useSelectFlashlightSample
()¶ -
fiftyone.state.
selectFlashlightSample
()¶ - Arguments
args ([ default , SelectThumbnailData ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useSelectSample¶
-
fiftyone.state.
useSelectSample
()¶ -
fiftyone.state.
selectSample
()¶ - Arguments
args ([ sampleId ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useSetDataset¶
useSetExpandedSample¶
-
fiftyone.state.
useSetExpandedSample
(withGroup)¶ - Arguments
withGroup () –
Returns a function that executes an atomic transaction for updating Recoil state.
useSetGroupSlice¶
-
fiftyone.state.
useSetGroupSlice
()¶ -
fiftyone.state.
setGroupSlice
()¶ - Arguments
args ([ slice ]) –
- Return type
void
-
Returns a function that executes an atomic transaction for updating Recoil state.
useSetSelected¶
useSetSelectedLabels¶
useSetSpaces¶
useSetView¶
-
fiftyone.state.
useSetView
(patch, selectSlice, onComplete)¶ - Arguments
patch (boolean) –
selectSlice (boolean) –
onComplete () –
Returns a function that will run the callback that was passed when calling this hook. Useful for accessing Recoil state in response to events.
useStateUpdate¶
-
fiftyone.state.
useStateUpdate
(ignoreSpaces)¶ - Arguments
ignoreSpaces () –
Returns a function that executes an atomic transaction for updating Recoil state.
useToClips¶
-
fiftyone.state.
useToClips
()¶ -
fiftyone.state.
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¶
-
fiftyone.state.
useToEvaluationPatches
()¶ -
fiftyone.state.
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¶
-
fiftyone.state.
useToPatches
()¶ -
fiftyone.state.
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.
useUnprocessedStateUpdate¶
-
fiftyone.state.
useUnprocessedStateUpdate
(ignoreSpaces)¶ - Arguments
ignoreSpaces () –
useUpdateSample¶
Functions¶
activeField¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
activeModalSample¶
-
fiftyone.state.
activeModalSample
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Union< AppSample , >
>
Returns a function which returns a memoized atom for each unique parameter value.
aggregation¶
-
fiftyone.state.
aggregation
(param)¶ - Arguments
param (Object) –
param.extended (boolean) –
param.mixed (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.
aggregationQuery¶
-
fiftyone.state.
aggregationQuery
(parameter)¶ - Arguments
parameter (Object) –
parameter.extended (boolean) –
parameter.mixed (boolean) –
parameter.modal (boolean) –
parameter.paths (Array< string >) –
parameter.root (boolean) –
- Return type
RecoilState < aggregationsQuery$data >
<
fiftyone.state.aggregationsQuery$data()
>
GraphQL Selector Family for Aggregations.
aggregations¶
-
fiftyone.state.
aggregations
(param)¶ - Arguments
param (Object) –
param.extended (boolean) –
param.modal (boolean) –
param.paths (Array< string >) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
readonly
>
Returns a function which returns a memoized atom for each unique parameter value.
alpha¶
-
fiftyone.state.
alpha
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < number >
<
number
>
Returns a function which returns a memoized atom for each unique parameter value.
appConfigOption¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
boolOnlyMatchAtom¶
-
fiftyone.state.
boolOnlyMatchAtom
(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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
booleanFieldIsFiltered¶
-
fiftyone.state.
booleanFieldIsFiltered
(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.
booleanSelectedValuesAtom¶
-
fiftyone.state.
booleanSelectedValuesAtom
(param)¶ - Arguments
param (Object) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < >
<
Array< boolean >
>
Returns a function which returns a memoized atom for each unique parameter value.
boundedCount¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
boundsAtom
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
param.path (string) –
- Return type
readonly
readonly RecoilValueReadOnly < Range >
<
fiftyone.state.Range()
>
Returns a function which returns a memoized atom for each unique parameter value.
buildSchema¶
-
fiftyone.state.
buildSchema
(dataset)¶ - Arguments
dataset (Dataset) –
- Return type
fiftyone.state.Schema()
collapseFields¶
-
fiftyone.state.
collapseFields
(paths)¶ - Arguments
paths (any) –
- Return type
Array<
fiftyone.state.StrictField()
>
colorMap¶
-
fiftyone.state.
colorMap
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
( val : any )
>
Returns a function which returns a memoized atom for each unique parameter value.
colorMapRGB¶
-
fiftyone.state.
colorMapRGB
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
( val : any )
>
Returns a function which returns a memoized atom for each unique parameter value.
colorSeed¶
-
fiftyone.state.
colorSeed
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < number >
<
number
>
Returns a function which returns a memoized atom for each unique parameter value.
coloring¶
-
fiftyone.state.
coloring
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < Coloring >
<
fiftyone.state.Coloring()
>
Returns a function which returns a memoized atom for each unique parameter value.
configuredSidebarModeDefault¶
-
fiftyone.state.
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¶
-
fiftyone.state.
count
(param)¶ - Arguments
param (Object) –
param.extended (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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
createRouter¶
-
fiftyone.state.
createRouter
(environment, routes, __namedParameters)¶ - Arguments
environment (default) –
routes (Array< RouteDefinition < OperationType > >) –
__namedParameters (Object) –
__namedParameters.errors (boolean) –
- Return type
fiftyone.state.Router()
<
any
>
cropToContent¶
-
fiftyone.state.
cropToContent
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
cumulativeCounts¶
-
fiftyone.state.
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.
cumulativePaths¶
-
fiftyone.state.
cumulativePaths
(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.
cumulativeValues¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
distribution¶
-
fiftyone.state.
distribution
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Union< , , , , >
>
Returns a function which returns a memoized atom for each unique parameter value.
distributionPaths¶
-
fiftyone.state.
distributionPaths
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Array< string >
>
Returns a function which returns a memoized atom for each unique parameter value.
expandPath¶
-
fiftyone.state.
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¶
-
fiftyone.state.
falseAtom
(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.
field¶
-
fiftyone.state.
field
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < Field >
<
fiftyone.state.Field()
>
Returns a function which returns a memoized atom for each unique parameter value.
fieldIsFiltered¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
fieldSchema
(param)¶ - Arguments
param (Object) –
param.space (SPACE) –
- Return type
readonly
readonly RecoilValueReadOnly < Schema >
<
fiftyone.state.Schema()
>
Returns a function which returns a memoized atom for each unique parameter value.
fieldType¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
filter¶
-
fiftyone.state.
filter
(param)¶ - Arguments
param (Object) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < Filter >
<
fiftyone.state.Filter()
>
Returns a function which returns a memoized atom for each unique parameter value.
filterFields¶
-
fiftyone.state.
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¶
-
fiftyone.state.
filterPaths
(paths, schema)¶ - Arguments
paths (Array< string >) –
schema (Schema) –
- Return type
Array<
string
>
getBrowserStorageEffectForKey¶
-
fiftyone.state.
getBrowserStorageEffectForKey
(key, props)¶ - Arguments
key (string) –
props (Object) –
props.sessionStorage (boolean) –
props.valueClass () –
getDatasetName¶
-
fiftyone.state.
getDatasetName
(context)¶ - Arguments
context (RoutingContext < any >) –
- Return type
string
getSavedViewName¶
-
fiftyone.state.
getSavedViewName
(context)¶ - Arguments
context (RoutingContext < any >) –
- Return type
string
groupIsEmpty¶
-
fiftyone.state.
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.
groupSample¶
-
fiftyone.state.
groupSample
(param)¶ - Arguments
param (string) –
- Return type
RecoilState < SampleData >
<
fiftyone.state.SampleData()
>
Returns a function which returns a memoized atom for each unique parameter value.
groupShown¶
-
fiftyone.state.
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.
groupSlice¶
-
fiftyone.state.
groupSlice
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < string >
<
string
>
Returns a function which returns a memoized atom for each unique parameter value.
groupStatistics¶
-
fiftyone.state.
groupStatistics
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < >
<
Union< , >
>
Returns a function which returns a memoized atom for each unique parameter value.
hasFilters¶
-
fiftyone.state.
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.
histogramValues¶
-
fiftyone.state.
histogramValues
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < >
<
Union< , , >
>
Returns a function which returns a memoized atom for each unique parameter value.
imageFilters¶
-
fiftyone.state.
imageFilters
(param)¶ - Arguments
param (Object) –
param.filter (string) –
param.modal (boolean) –
- Return type
RecoilState < number >
<
number
>
Returns a function which returns a memoized atom for each unique parameter value.
isMatchingAtom¶
-
fiftyone.state.
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.
labelCount¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
labelValues¶
-
fiftyone.state.
labelValues
(param)¶ - Arguments
param (Object) –
param.expanded (boolean) –
param.sample (Sample) –
- Return type
RecoilState < >
<
Array< string >
>
Returns a function which returns a memoized atom for each unique parameter value.
listString¶
-
fiftyone.state.
listString
(param)¶ - Arguments
param (Object) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < >
<
( value : string )
>
Returns a function which returns a memoized atom for each unique parameter value.
lookerOptions¶
-
fiftyone.state.
lookerOptions
(param)¶ - Arguments
param (Object) –
param.modal (boolean) –
param.withFilter (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < Partial >
<
Partial < Omit >
>
Returns a function which returns a memoized atom for each unique parameter value.
makeRouteDefinitions¶
-
fiftyone.state.
makeRouteDefinitions
(environment, children)¶ - Arguments
environment (Environment) –
children (Array< RouteOptions < T > >) –
- Return type
Array<
fiftyone.state.RouteDefinition()
<
fiftyone.state.T()
>
>
matchPath¶
-
fiftyone.state.
matchPath
(pathname, options, variables, search)¶ - Arguments
pathname (string) –
options (MatchPathOptions) –
variables (Partial < VariablesOf >) –
search (string) –
- Return type
fiftyone.state.MatchPathResult()
<
fiftyone.state.T()
>
matchRoutes¶
-
fiftyone.state.
matchRoutes
(routes, pathname, variables, branch, search)¶ - Arguments
routes (Array< RouteBase < T > >) –
pathname (string) –
variables –
branch (Array< Object >) –
search (string) –
- Return type
Array<
Object
>
meetsType¶
-
fiftyone.state.
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.
noDistributionPathsData¶
-
fiftyone.state.
noDistributionPathsData
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
noneAtom¶
-
fiftyone.state.
noneAtom
(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.
noneCount¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
nonfiniteCounts¶
-
fiftyone.state.
nonfiniteCounts
(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.
numeric¶
-
fiftyone.state.
numeric
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
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¶
-
fiftyone.state.
numericExcludeAtom
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
numericFieldIsFiltered¶
-
fiftyone.state.
numericFieldIsFiltered
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
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.
numericIsMatchingAtom¶
-
fiftyone.state.
numericIsMatchingAtom
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
numericOnlyMatchAtom¶
-
fiftyone.state.
numericOnlyMatchAtom
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
param.modal (boolean) –
param.path (string) –
- Return type
RecoilState < boolean >
<
boolean
>
Returns a function which returns a memoized atom for each unique parameter value.
onlyMatchAtom¶
-
fiftyone.state.
onlyMatchAtom
(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.
pathColor¶
-
fiftyone.state.
pathColor
(param)¶ - Arguments
param (Object) –
param.modal (boolean) –
param.path (string) –
- Return type
readonly
readonly RecoilValueReadOnly < string >
<
string
>
Returns a function which returns a memoized atom for each unique parameter value.
pathFilter¶
-
fiftyone.state.
pathFilter
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < PathFilterSelector >
<
fiftyone.state.PathFilterSelector()
>
Returns a function which returns a memoized atom for each unique parameter value.
pathIsShown¶
-
fiftyone.state.
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¶
-
fiftyone.state.
persistSidebarGroups
(variables)¶ - Arguments
variables (setSidebarGroupsMutation$variables) –
- Return type
void
rangeAtom¶
-
fiftyone.state.
rangeAtom
(param)¶ - Arguments
param (Object) –
param.defaultRange (Range) –
param.modal (boolean) –
param.path (string) –
param.withBounds (boolean) –
- Return type
RecoilState < Range >
<
fiftyone.state.Range()
>
Returns a function which returns a memoized atom for each unique parameter value.
readableTags¶
-
fiftyone.state.
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¶
-
fiftyone.state.
resolveGroups
(dataset, current)¶ - Arguments
dataset (Dataset) –
current (Array< SidebarGroup >) –
- Return type
Array<
fiftyone.state.SidebarGroup()
>
resolvedGroupSlice¶
-
fiftyone.state.
resolvedGroupSlice
(param)¶ - Arguments
param (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < string >
<
string
>
Returns a function which returns a memoized atom for each unique parameter value.
resolvedSidebarMode¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
schemaReduce
(schema, field)¶ - Arguments
schema (Schema) –
field (StrictField) –
- Return type
fiftyone.state.Schema()
selectedMediaField¶
-
fiftyone.state.
selectedMediaField
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < string >
<
string
>
Returns a function which returns a memoized atom for each unique parameter value.
selectedPatchIds¶
-
fiftyone.state.
selectedPatchIds
(param)¶ - Arguments
param (SerializableParam) –
- Return type
readonly
readonly RecoilValueReadOnly < Set >
<
Set < any >
>
Returns a function which returns a memoized atom for each unique parameter value.
setCurrentEnvironment¶
-
fiftyone.state.
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.
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) –
param.persist (boolean) –
- Return type
RecoilState < >
<
Array< SidebarGroup >
>
Returns a function which returns a memoized atom for each unique parameter value.
sidebarGroupsDefinition¶
- Arguments
param (boolean) –
- Return type
RecoilState < >
<
Array< SidebarGroup >
>
Returns a function which returns a memoized atom for each unique parameter value.
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¶
-
fiftyone.state.
skeleton
(param)¶ - Arguments
param (string) –
- Return type
readonly
readonly RecoilValueReadOnly < KeypointSkeleton >
<
fiftyone.state.KeypointSkeleton()
>
Returns a function which returns a memoized atom for each unique parameter value.
sortFilterResults¶
-
fiftyone.state.
sortFilterResults
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < SortResults >
<
fiftyone.state.SortResults()
>
Returns a function which returns a memoized atom for each unique parameter value.
string¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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.
stringSelectedValuesAtom¶
-
fiftyone.state.
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¶
-
fiftyone.state.
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¶
-
fiftyone.state.
textFilter
(param)¶ - Arguments
param (boolean) –
- Return type
RecoilState < string >
<
string
>
Returns a function which returns a memoized atom for each unique parameter value.
transformDataset¶
-
fiftyone.state.
transformDataset
(dataset)¶ - Arguments
dataset (any) –
- Return type
Readonly < Dataset >
<
fiftyone.state.Dataset()
>
trueAtom¶
-
fiftyone.state.
trueAtom
(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.
validateGroupName¶
-
fiftyone.state.
validateGroupName
(current, name)¶ - Arguments
current (Array< string >) –
name (string) –
- Return type
boolean
values¶
-
fiftyone.state.
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.
viewStateForm¶
-
fiftyone.state.
viewStateForm
(param)¶ - Arguments
param (Object) –
param.addStages (string) –
param.modal (boolean) –
param.omitSelected (boolean) –
param.selectSlice (boolean) –
- Return type
readonly
readonly RecoilValueReadOnly < StateForm >
<
fiftyone.state.StateForm()
>
Returns a function which returns a memoized atom for each unique parameter value.
Types¶
SPACE¶
Name |
Value |
---|---|
FRAME |
|
SAMPLE |
AnnotationRun¶
-
class
fiftyone.state.
AnnotationRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
BrainRun¶
-
class
fiftyone.state.
BrainRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
Config¶
-
class
fiftyone.state.
Config
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
colorPool |
|
|
colorscale |
|
|
gridZoom |
|
|
loopVideos |
|
|
mediaFields |
|
|
notebookHeight |
|
|
plugins |
||
showConfidence |
|
|
showIndex |
|
|
showLabel |
|
|
showTooltip |
|
|
sidebarMode |
|
|
theme |
|
|
timezone |
|
|
useFrameNumber |
|
Dataset¶
-
class
fiftyone.state.
Dataset
()¶
The dataset object returned by the API.
Properties¶
Name |
Type |
Description |
---|---|---|
appConfig |
||
brainMethods |
|
|
createdAt |
||
defaultGroupSlice |
|
|
defaultMaskTargets |
||
defaultSkeleton |
||
evaluations |
|
|
frameFields |
|
|
groupField |
|
|
groupMediaTypes |
|
|
groupSlice |
|
|
id |
|
|
info |
|
|
lastLoadedAt |
||
maskTargets |
|
|
mediaType |
||
name |
|
|
sampleFields |
|
|
savedViews |
|
|
skeletons |
||
stages |
|
|
version |
|
|
viewCls |
|
DatasetAppConfig¶
-
class
fiftyone.state.
DatasetAppConfig
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
gridMediaField |
|
|
mediaFields |
|
|
modalMediaField |
|
|
plugins |
||
sidebarGroups |
|
|
sidebarMode |
|
Description¶
-
class
fiftyone.state.
Description
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
dataset |
|
|
savedViewSlug |
|
|
savedViews |
|
|
selected |
|
|
selectedLabels |
|
|
spaces |
|
|
view |
|
|
viewCls |
|
|
viewName |
|
EvaluationRun¶
-
class
fiftyone.state.
EvaluationRun
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
KeypointSkeleton¶
-
class
fiftyone.state.
KeypointSkeleton
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
edges |
|
|
labels |
|
Run¶
-
class
fiftyone.state.
Run
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
config |
|
|
key |
|
|
timestamp |
|
|
version |
|
|
viewStages |
|
SavedView¶
-
class
fiftyone.state.
SavedView
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
color |
|
|
createdAt |
||
datasetId |
|
|
description |
|
|
id |
|
|
lastLoadedAt |
||
lastModifiedAt |
||
name |
|
|
slug |
|
|
viewStages |
|
SelectedLabel¶
-
class
fiftyone.state.
SelectedLabel
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
field |
|
|
frameNumber |
|
|
labelId |
|
|
sampleId |
|
SelectedLabelData¶
-
class
fiftyone.state.
SelectedLabelData
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
field |
|
|
frameNumber |
|
|
sampleId |
|
SidebarGroup¶
-
class
fiftyone.state.
SidebarGroup
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
expanded |
|
|
name |
|
|
paths |
|
SortBySimilarityParameters¶
-
class
fiftyone.state.
SortBySimilarityParameters
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
brainKey |
|
|
distField |
|
|
k |
|
|
query |
|
|
queryIds |
|
|
reverse |
|
Stage¶
-
class
fiftyone.state.
Stage
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kwargs |
|
StrictKeypointSkeleton¶
-
class
fiftyone.state.
StrictKeypointSkeleton
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
edges |
|
|
labels |
|
|
name |
|
Targets¶
-
class
fiftyone.state.
Targets
()¶
Name |
Type |
Description |
---|---|---|
[key] |
|
-
class
fiftyone.state.
MediaType
()¶
MediaType¶
Union of 'image'()
, 'group'()
, 'point_cloud'()
, 'video'()
-
class
fiftyone.state.
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.
AppSample¶
-
class
fiftyone.state.
AppSample
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
filepath |
|
|
id |
|
|
metadata |
|
|
support |
|
|
tags |
|
BooleanFilter¶
-
class
fiftyone.state.
BooleanFilter
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
exclude |
|
|
false |
|
|
isMatching |
|
|
none |
|
|
onlyMatch |
|
|
true |
|
EmptyEntry¶
-
class
fiftyone.state.
EmptyEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
group |
|
|
kind |
|
|
shown |
|
Entry¶
-
class
fiftyone.state.
Entry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
entries |
|
|
pathname |
|
|
queryParams |
|
|
state |
|
GroupEntry¶
-
class
fiftyone.state.
GroupEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
name |
|
InputEntry¶
-
class
fiftyone.state.
InputEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
type |
|
LookerStore¶
-
class
fiftyone.state.
LookerStore
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
indices |
|
|
lookers |
|
|
reset |
|
|
samples |
|
ModalSample¶
-
class
fiftyone.state.
ModalSample
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
aspectRatio |
|
|
frameNumber |
|
|
frameRate |
|
|
navigation |
||
sample |
||
urls |
|
NumericFilter¶
-
class
fiftyone.state.
NumericFilter
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
exclude |
|
|
inf |
|
|
isMatching |
|
|
nan |
|
|
ninf |
|
|
none |
|
|
onlyMatch |
|
|
range |
PathEntry¶
-
class
fiftyone.state.
PathEntry
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
kind |
|
|
path |
|
|
shown |
|
RouteBase¶
-
class
fiftyone.state.
RouteBase
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
children |
|
|
component |
|
|
exact |
|
|
path |
|
|
queryParams |
|
RouteData¶
-
class
fiftyone.state.
RouteData
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
isExact |
|
|
path |
|
|
url |
|
|
variables |
RouteDefinition¶
-
class
fiftyone.state.
RouteDefinition
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
children |
|
|
component |
|
|
exact |
|
|
path |
|
|
query |
|
|
queryParams |
|
RouteOptions¶
-
class
fiftyone.state.
RouteOptions
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
children |
|
|
component |
|
|
exact |
|
|
path |
|
|
query |
||
queryParams |
|
Router¶
-
class
fiftyone.state.
Router
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
cleanup |
|
|
context |
|
RoutingContext¶
-
class
fiftyone.state.
RoutingContext
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
get |
|
|
history |
|
|
pathname |
|
|
state |
|
|
subscribe |
|
SampleData¶
-
class
fiftyone.state.
SampleData
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
aspectRatio |
|
|
frameNumber |
|
|
frameRate |
|
|
sample |
||
urls |
|
SortResults¶
-
class
fiftyone.state.
SortResults
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
asc |
|
|
count |
|
StateUpdate¶
-
class
fiftyone.state.
StateUpdate
()¶
Properties¶
Name |
Type |
Description |
---|---|---|
colorscale |
|
|
config |
||
dataset |
||
state |
|
AggregationResponseFrom¶
A generic type that extracts the response type from a GraphQL query.
-
class
fiftyone.state.
DatasetViewOption
()¶
Method¶
Name |
Type |
Description |
---|---|---|
Method.key |
|
|
Method.maxK |
|
|
Method.supportsLeastSimilarity |
|
|
Method.supportsPrompts |
|
-
class
fiftyone.state.
PathFilterSelector
()¶
Range¶
Name |
Type |
Description |
---|---|---|
Range |
|
-
class
fiftyone.state.
ResponseFrom
()¶
Route¶
Name |
Type |
Description |
---|---|---|
Route |
|
-
class
fiftyone.state.
SidebarEntry
()¶
SidebarEntry¶
Union of EmptyEntry()
, GroupEntry()
, PathEntry()
, InputEntry()
-
class
fiftyone.state.
StateResolver
()¶
StateResolver¶
Union of StateUpdate()
, ( t : TransactionInterface_UNSTABLE )()
Variables¶
BeforeScreenshotContext¶
Name |
Type |
Description |
---|---|---|
Context < Set > |
|
DEFAULT_ALPHA¶
Name |
Type |
Description |
---|---|---|
|
DEFAULT_SELECTED¶
Name |
Type |
Description |
---|---|---|
DatasetViewOption |
EventsContext¶
Name |
Type |
Description |
---|---|---|
Context < EventsSink > |
|
IMAGE_FILTERS¶
Name |
Type |
Description |
---|---|---|
brightness |
|
MATCH_LABEL_TAGS¶
Name |
Type |
Description |
---|---|---|
embeddedDocType |
|
|
ftype |
|
|
path |
|
RESERVED_GROUPS¶
Name |
Type |
Description |
---|---|---|
Set < string > |
|
RelayEnvironmentKey¶
Name |
Type |
Description |
---|---|---|
EnvironmentKey |
|
RouterContext¶
Name |
Type |
Description |
---|---|---|
React.Context < RoutingContext > |
|
appConfigDefault¶
Name |
Type |
Description |
---|---|---|
|
screenshotCallbacks¶
Name |
Type |
Description |
---|---|---|
Set < > |
|
stores¶
Name |
Type |
Description |
---|---|---|
Set < > |
|