Module @fiftyone/relay

Relay

This package contains shared FiftyOne Relay GraphQL queries, mutations, and subscriptions along with some core interfaces for syncing Relay data with Recoil data flow.

GraphQL Atoms

`graphQLSyncFragmentAtom`

graphQLSyncFragmentAtom wraps a Recoil Atom, tying it to the Relay store via the Writer. Given a list of fragments, the Writer will attempt to sync the atom with the current data for the last fragment in the list, after recursing the previous fragment keys. On optional read function can be provided for mapping the fragment data to a new shape.

`graphQLSyncFragmentAtom`

A parameterized version of graphQLSyncFragmentAtom. Includes the optional sync parameter to conditionally opt-in to fragment syncing given an atom instance's parameters P.

Relay interfaces

`Writer`

Writer is the core interface containing the environment implementation controlling the atomic updates with the Relay store.

Index

Interfaces

Type Aliases

Aggregate AggregationForm BrainRunType ColorBy ColorSchemeInput ColorscaleInput ColorscaleListInput Count CountValues CustomizeColorInput DefaultColorscaleInput ExtendedViewForm GraphQLSyncFragmentAtomFamilyOptions GraphQLSyncFragmentAtomOptions GraphQLSyncFragmentSyncAtomFamilyOptions GraphQLSyncFragmentSyncAtomOptions GroupElementFilter HistogramValues IndexType LabelTagColorInput LightningInput LightningPathInput MaskColorInput MediaType PageSubscription SampleFilter SavedViewInfo SelectedLabel Setter SidebarGroupInput SidebarMode StateForm Theme ValueColorInput aggregateQuery aggregateQuery$data aggregateQuery$variables aggregationsQuery aggregationsQuery$data aggregationsQuery$variables colorSchemeFragment$data colorSchemeFragment$key configFragment$data configFragment$key configQuery configQuery$data configQuery$variables countValuesQuery countValuesQuery$data countValuesQuery$variables createSavedViewMutation createSavedViewMutation$data createSavedViewMutation$variables datasetAppConfigFragment$data datasetAppConfigFragment$key datasetFragment$data datasetFragment$key datasetQuery datasetQuery$data datasetQuery$variables deleteSavedViewMutation deleteSavedViewMutation$data deleteSavedViewMutation$variables estimatedCountsFragment$data estimatedCountsFragment$key frameFieldsFragment$data frameFieldsFragment$key groupSliceFragment$data groupSliceFragment$key histogramValuesQuery histogramValuesQuery$data histogramValuesQuery$variables indexesFragment$data indexesFragment$key lightningQuery lightningQuery$data lightningQuery$variables mainSampleQuery mainSampleQuery$data mainSampleQuery$variables mediaFieldsFragment$data mediaFieldsFragment$key mediaTypeFragment$data mediaTypeFragment$key paginateSamplesQuery paginateSamplesQuery$data paginateSamplesQuery$variables sampleFieldsFragment$data sampleFieldsFragment$key savedViewsFragment$data savedViewsFragment$key savedViewsFragmentQuery savedViewsFragmentQuery$data savedViewsFragmentQuery$variables searchSelectFieldsMutation searchSelectFieldsMutation$data searchSelectFieldsMutation$variables setColorSchemeMutation setColorSchemeMutation$data setColorSchemeMutation$variables setDatasetColorSchemeMutation setDatasetColorSchemeMutation$data setDatasetColorSchemeMutation$variables setDatasetMutation setDatasetMutation$data setDatasetMutation$variables setFieldVisibilityStageMutation setFieldVisibilityStageMutation$data setFieldVisibilityStageMutation$variables setGroupSliceMutation setGroupSliceMutation$data setGroupSliceMutation$variables setSampleMutation setSampleMutation$data setSampleMutation$variables setSelectedLabelsMutation setSelectedLabelsMutation$data setSelectedLabelsMutation$variables setSelectedMutation setSelectedMutation$data setSelectedMutation$variables setSidebarGroupsMutation setSidebarGroupsMutation$data setSidebarGroupsMutation$variables setSpacesMutation setSpacesMutation$data setSpacesMutation$variables setViewMutation setViewMutation$data setViewMutation$variables sidebarGroupsFragment$data sidebarGroupsFragment$key stageDefinitionsFragment$data stageDefinitionsFragment$key updateSavedViewMutation updateSavedViewMutation$data updateSavedViewMutation$variables viewFragment$data viewFragment$key viewSchemaFragment$data viewSchemaFragment$key

Functions

Writer getPageQuery graphQLSyncFragmentAtom graphQLSyncFragmentAtomFamily readFragment resetEffect selectorWithEffect subscribe subscribeBefore useRelayEnvironment

Generated using TypeDoc