Module @fiftyone/state

State

FiftyOne App state APIs

Usage

This package can be used in the following contexts

internal - for interacting with the app state within the core app modules
external - for interacting with the state of an embedded app aka the <Dataset /> component
plugin - for interacting with app state in your plugin

Types

The API assumes you are running in one of the contexts listed above, which requires the ability to interact with the following types of objects.

Recoil

Atom
Selector
SelectorFamily

React Hooks

Custom hooks following similar patterns to the following:

useEffect
useState
useCallback

Index

Namespaces

State constants

Enumerations

Classes

GroupSampleNotFound SampleNotFound

Interfaces

BooleanFilter EmptyEntry GroupEntry InputEntry LookerStore NumericFilter PathEntry SelectEvent Session SortResults StringFilter

Type Aliases

AggregationResponseFrom DatasetViewOption DebouncedState DimensionsType Lookers Method ModalNavigation ModalSample ModalSampleData ModalSelector Optional PathFilterSelector Range ResponseFrom Sample SidebarEntry SliceName

Variables

BeforeScreenshotContext DEFAULT_ALPHA DEFAULT_SELECTED GRID_SPACES_DEFAULT GROUP_BY_VIEW_STAGE LIMIT_VIEW_STAGE MATCH_LABEL_TAGS MATCH_VIEW_STAGE RESERVED_GROUPS RelayEnvironmentKey SESSION_DEFAULT SKIP_VIEW_STAGE SORT_VIEW_STAGE TAB_OPTIONS TAB_OPTIONS_MAP TAKE_VIEW_STAGE active3dSlices active3dSlicesToSampleMap activeModalSample activeModalSidebarSample activePlot activeSliceDescriptorLabel all3dSlices all3dSlicesToSampleMap allFieldsCheckedState allNon3dSlices anyTagging appConfigDefault attributeVisibility canCreateNewField canEditCustomColors canEditSavedViews canEditWorkspaces canModifySidebarGroup canTagSamplesOrLabels collapsedPaths colorMap colorMapRGB colorScheme colorSeed coloring config configData currentModalUniqueId currentSampleId currentViewSlug dataset datasetAppConfig datasetColorScheme datasetFrameCount datasetId datasetName datasetQueryContext datasetSampleCount defaultGroupSlice defaultQueryPerformanceConfig defaultTargets disableFrameFiltering disabledCheckboxPaths disabledFilterPaths disabledFrameFilterPaths distributionPaths dynamicGroupCurrentElementIndex dynamicGroupFields dynamicGroupIndex dynamicGroupParameters dynamicGroupsTargetFrameRate editingFieldAtom elementNames eligibleFieldsToCustomizeColor enableQueryPerformanceConfig escapeKeyHandlerIdsAtom excludedPathsStrippedState expandedPathsState extendedSelection extendedSelectionOverrideStage extendedStages extendedStagesUnsorted fieldSchemaState fieldVisibilityStage filters flatFrameFields flatSampleFields fo3dContent fo3dSample fo3dSlice frameFields frameFieldsList fullSchema fullscreen fullyDisabledPaths getSkeleton getTarget groupByFieldValue groupField groupId groupMedia3dVisibleSetting groupMediaIs3dVisible groupMediaIsCarouselVisible groupMediaIsCarouselVisibleSetting groupMediaIsMainVisible groupMediaIsMainVisibleSetting groupMediaTypes groupMediaTypesMap groupMediaTypesSet groupSlice groupSlices groupView has3dSlice hasFo3dSlice hasGroupSlices hasMultiple3dSlices hasSelectedLabels hasSelectedSamples hiddenLabelIds hiddenLabels hiddenLabelsArray hiddenNoneGroups hideNoneValuedFields hoveredSample includeNestedFieldsState is3DDataset isClipsView isDynamicGroup isFieldVisibilityActive isFramesView isGroup isLargeVideo isModalActive isNestedDynamicGroup isNonNestedDynamicGroup isNotebook isOrderedDynamicGroup isPatchesView isRootView isSidebarFilterMode isTooltipLocked isVideoDataset labelPathsSet labelPathsSetExpanded lastLoadedDatasetNameState loading lookerPanels mediaFields mediaType mediaTypeSelector modal modalAttributeVisibility modalFilters modalGroupSlice modalLooker modalNavigation modalSample modalSampleId modalSelector modalTopBarVisible non3dSamples noneValuedPaths nullableModalSampleId only3d parentMediaTypeSelector patching pathHiddenLabelsMap pinned3DSample pinned3DSampleSlice pinned3d queryPerformance readOnly refreshGroupQuery refresher replace rootElementName rootElementNamePlural sampleFields savedLookerOptions savingFilters schemaSearchResultList schemaSearchResults schemaSearchTerm schemaSelectedSettingsTab screenshotCallbacks searchMetaFilterState selectedLabelIds selectedLabelMap selectedLabels selectedPatchSamples selectedSampleObjects selectedSamples selectedSavedViewState selectedViewName sessionGroupSlice sessionSpaces settingsModal showMetadataState showModalNavigationControls showNestedFieldsState showOverlays sidebarSampleId similarityMethods similarityParameters similaritySorting snackbarErrors stageDefinitions stageInfo stateSubscription stores targets theme themeConfig threedSamples timeZone tooltipCoordinates tooltipDetail view viewCls viewCounter viewName viewSchemaState viewStateForm_INTERNAL

Functions

_activeFields activeField activeFields activeLabelFields activeLabelPaths activeLabels aggregation aggregationQuery aggregations appConfigOption boolExcludeAtom boolIsMatchingAtom boolean booleanCountResults booleanResults booleanSelectedValuesAtom boundedCount bounds boundsAtom buildSchema collapseFields convertTargets count countValues counts cropToContent cumulativeCounts cumulativeValues currentSlice currentSlices dbPath deferrer distribution dynamicGroupPageSelector dynamicGroupViewQuery dynamicGroupsElementCount dynamicGroupsViewMode dynamicGroupsViewModeStore ensureColorScheme excludedPathsState expandPath falseAtom field fieldHasVisibilitySetting fieldIsFiltered fieldPaths fieldSchema fieldType fields fieldsMatcher filter filterFields filterPaths filterView gatheredPaths generateBooleanSelectorFamily generateSelectorFamily getBrowserStorageEffectForKey getCurrentEnvironment getEmbeddedLabelFields getEnvironment getLabelFields getQueryPerformancePath getSample getSampleSrc getSessionRef getStandardizedUrls groupFilter groupIsEmpty groupLength groupSamples groupShown groupStatistics hasFilters hasVisibility hiddenFieldLabels histogramValues imaVidLookerState imaVidStoreKey indexedPaths isDisabledCheckboxPath isDisabledFilterPath isDisabledFrameFilterPath isFilterDefault isFrameField isInListField isLabelPath isListField isMatchingAtom isNumericField isObjectIdField isOfDocumentFieldList isStringField keypointFilter labelCount labelFields labelPath labelPaths labelTagCounts labelsMatcher lightningBooleanResults lightningBounds lightningNonfinites lightningNumericResults lightningQuery lightningStringResults listBoolean listNumber listString lookerOptions mapSampleResponse maxAtom meetsType minAtom modalAggregationPaths modalFilterFields noneAtom noneCount nonfiniteAtom nonfiniteCount nonfiniteData numGroupFieldsActive numGroupFieldsFiltered numGroupFieldsVisible numeric numericExcludeAtom numericFields numericIsMatchingAtom parentField pathCanBeOptimized pathColor pathFilter pathHasIndexes pathIndex pathIsShown persistSidebarGroups primitivesMatcher pullSidebarValue rangeAtom readableTags removeRgbProperty resolveGroups sampleTagCounts schemaReduce selectedMediaField selectedMediaFieldAtomFamily selectedPatchIds sessionAtom setCurrentEnvironment setQueryPerformancePath shouldRenderImaVidLooker sidebarEntries sidebarExpanded sidebarExpandedStore sidebarGroup sidebarGroupMapping sidebarGroupNames sidebarGroups sidebarGroupsDefinition sidebarVisible sidebarWidth skeleton sortFilterResults string stringCountResults stringExcludeAtom stringResults stringSelectedValuesAtom stringifyObj tagging textFilter transformDataset trueAtom unsupportedMatcher useAssertedRecoilValue useBeforeScreenshot useBrowserStorage useClearModal useCreateLooker useDebounceCallback useDeferrer useDimensions useEntries useEventHandler useExpandSample useFollow useHashChangeHandler useHelpPanel useHover useHoveredSample useJSONPanel useKeyDown useKeydownHandler useLookerOptions useLookerStore useNotification useObserve useOnSelectLabel useOutsideClick usePanel useQueryPerformance useRefresh useReset useResetExtendedSelection useResizeHandler useSavedViews useSchemaSettings useScreenshot useScrollHandler useSearchSchemaFields useSelectSample useSession useSessionRef useSessionSetter useSessionSpaces useSetDataset useSetExpandedSample useSetGroupSlice useSetModalState useSetSelected useSetSelectedFieldsStage useSetSelectedLabels useSetSessionColorScheme useSetSpaces useSetView useSimilarityType useTimeout useToClips useToEvaluationPatches useToPatches useTooltip useUnboundState useUpdateSamples useWindowSize validateGroupName values viewsAreEqual visibility withSuspense

Generated using TypeDoc