Preparing search index...
The search index is not available
FiftyOne TypeScript API
FiftyOne TypeScript API
@fiftyone/state
buildSchema
Function buildSchema
build
Schema
(
sampleFields
:
StrictField
[]
, frameFields
:
StrictField
[]
)
:
Schema
Parameters
sampleFields:
StrictField
[]
frameFields:
StrictField
[]
Returns
Schema
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
Fifty
One
Type
Script API
@fiftyone/aggregations
aggregations
@fiftyone/operators
types
@fiftyone/plugins
@fiftyone/relay
@fiftyone/spaces
@fiftyone/state
State
constants
@fiftyone/utilities
constants
styles
Entry
Kind
Group
Sample
Not
Found
Sample
Not
Found
Boolean
Filter
Empty
Entry
Group
Entry
Input
Entry
Looker
Store
Numeric
Filter
Path
Entry
Select
Event
Session
Sort
Results
String
Filter
Aggregation
Response
From
Dataset
View
Option
Debounced
State
Dimensions
Type
Lookers
Method
Modal
Navigation
Modal
Sample
Modal
Sample
Data
Modal
Selector
Optional
Path
Filter
Selector
Range
Response
From
Sample
Sidebar
Entry
Slice
Name
Before
Screenshot
Context
DEFAULT_
ALPHA
DEFAULT_
SELECTED
GRID_
SPACES_
DEFAULT
GROUP_
BY_
VIEW_
STAGE
LIMIT_
VIEW_
STAGE
MATCH_
LABEL_
TAGS
MATCH_
VIEW_
STAGE
RESERVED_
GROUPS
Relay
Environment
Key
SESSION_
DEFAULT
SKIP_
VIEW_
STAGE
SORT_
VIEW_
STAGE
TAB_
OPTIONS
TAB_
OPTIONS_
MAP
TAKE_
VIEW_
STAGE
active3d
Slices
active3d
Slices
To
Sample
Map
active
Modal
Sample
active
Modal
Sidebar
Sample
active
Plot
active
Slice
Descriptor
Label
all3d
Slices
all3d
Slices
To
Sample
Map
all
Fields
Checked
State
all
Non3d
Slices
any
Tagging
app
Config
Default
attribute
Visibility
can
Create
New
Field
can
Edit
Custom
Colors
can
Edit
Saved
Views
can
Edit
Workspaces
can
Modify
Sidebar
Group
can
Tag
Samples
Or
Labels
collapsed
Paths
color
Map
color
MapRGB
color
Scheme
color
Seed
coloring
config
config
Data
current
Modal
Unique
Id
current
Sample
Id
current
View
Slug
dataset
dataset
App
Config
dataset
Color
Scheme
dataset
Frame
Count
dataset
Id
dataset
Name
dataset
Query
Context
dataset
Sample
Count
default
Group
Slice
default
Query
Performance
Config
default
Targets
disable
Frame
Filtering
disabled
Checkbox
Paths
disabled
Filter
Paths
disabled
Frame
Filter
Paths
distribution
Paths
dynamic
Group
Current
Element
Index
dynamic
Group
Fields
dynamic
Group
Index
dynamic
Group
Parameters
dynamic
Groups
Target
Frame
Rate
editing
Field
Atom
element
Names
eligible
Fields
To
Customize
Color
enable
Query
Performance
Config
escape
Key
Handler
Ids
Atom
excluded
Paths
Stripped
State
expanded
Paths
State
extended
Selection
extended
Selection
Override
Stage
extended
Stages
extended
Stages
Unsorted
field
Schema
State
field
Visibility
Stage
filters
flat
Frame
Fields
flat
Sample
Fields
fo3d
Content
fo3d
Sample
fo3d
Slice
frame
Fields
frame
Fields
List
full
Schema
fullscreen
fully
Disabled
Paths
get
Skeleton
get
Target
group
By
Field
Value
group
Field
group
Id
group
Media3d
Visible
Setting
group
Media
Is3d
Visible
group
Media
Is
Carousel
Visible
group
Media
Is
Carousel
Visible
Setting
group
Media
Is
Main
Visible
group
Media
Is
Main
Visible
Setting
group
Media
Types
group
Media
Types
Map
group
Media
Types
Set
group
Slice
group
Slices
group
View
has3d
Slice
has
Fo3d
Slice
has
Group
Slices
has
Multiple3d
Slices
has
Selected
Labels
has
Selected
Samples
hidden
Label
Ids
hidden
Labels
hidden
Labels
Array
hidden
None
Groups
hide
None
Valued
Fields
hovered
Sample
include
Nested
Fields
State
is3DDataset
is
Clips
View
is
Dynamic
Group
is
Field
Visibility
Active
is
Frames
View
is
Group
is
Large
Video
is
Modal
Active
is
Nested
Dynamic
Group
is
Non
Nested
Dynamic
Group
is
Notebook
is
Ordered
Dynamic
Group
is
Patches
View
is
Root
View
is
Sidebar
Filter
Mode
is
Tooltip
Locked
is
Video
Dataset
label
Paths
Set
label
Paths
Set
Expanded
last
Loaded
Dataset
Name
State
loading
looker
Panels
media
Fields
media
Type
media
Type
Selector
modal
modal
Attribute
Visibility
modal
Filters
modal
Group
Slice
modal
Looker
modal
Navigation
modal
Sample
modal
Sample
Id
modal
Selector
modal
Top
Bar
Visible
non3d
Samples
none
Valued
Paths
nullable
Modal
Sample
Id
only3d
parent
Media
Type
Selector
patching
path
Hidden
Labels
Map
pinned3DSample
pinned3DSample
Slice
pinned3d
query
Performance
read
Only
refresh
Group
Query
refresher
replace
root
Element
Name
root
Element
Name
Plural
sample
Fields
saved
Looker
Options
saving
Filters
schema
Search
Result
List
schema
Search
Results
schema
Search
Term
schema
Selected
Settings
Tab
screenshot
Callbacks
search
Meta
Filter
State
selected
Label
Ids
selected
Label
Map
selected
Labels
selected
Patch
Samples
selected
Sample
Objects
selected
Samples
selected
Saved
View
State
selected
View
Name
session
Group
Slice
session
Spaces
settings
Modal
show
Metadata
State
show
Modal
Navigation
Controls
show
Nested
Fields
State
show
Overlays
sidebar
Sample
Id
similarity
Methods
similarity
Parameters
similarity
Sorting
snackbar
Errors
stage
Definitions
stage
Info
state
Subscription
stores
targets
theme
theme
Config
threed
Samples
time
Zone
tooltip
Coordinates
tooltip
Detail
view
view
Cls
view
Counter
view
Name
view
Schema
State
view
State
Form_
INTERNAL
_active
Fields
active
Field
active
Fields
active
Label
Fields
active
Label
Paths
active
Labels
aggregation
aggregation
Query
aggregations
app
Config
Option
bool
Exclude
Atom
bool
Is
Matching
Atom
boolean
boolean
Count
Results
boolean
Results
boolean
Selected
Values
Atom
bounded
Count
bounds
bounds
Atom
build
Schema
collapse
Fields
convert
Targets
count
count
Values
counts
crop
To
Content
cumulative
Counts
cumulative
Values
current
Slice
current
Slices
db
Path
deferrer
distribution
dynamic
Group
Page
Selector
dynamic
Group
View
Query
dynamic
Groups
Element
Count
dynamic
Groups
View
Mode
dynamic
Groups
View
Mode
Store
ensure
Color
Scheme
excluded
Paths
State
expand
Path
false
Atom
field
field
Has
Visibility
Setting
field
Is
Filtered
field
Paths
field
Schema
field
Type
fields
fields
Matcher
filter
filter
Fields
filter
Paths
filter
View
gathered
Paths
generate
Boolean
Selector
Family
generate
Selector
Family
get
Browser
Storage
Effect
For
Key
get
Current
Environment
get
Embedded
Label
Fields
get
Environment
get
Label
Fields
get
Query
Performance
Path
get
Sample
get
Sample
Src
get
Session
Ref
get
Standardized
Urls
group
Filter
group
Is
Empty
group
Length
group
Samples
group
Shown
group
Statistics
has
Filters
has
Visibility
hidden
Field
Labels
histogram
Values
ima
Vid
Looker
State
ima
Vid
Store
Key
indexed
Paths
is
Disabled
Checkbox
Path
is
Disabled
Filter
Path
is
Disabled
Frame
Filter
Path
is
Filter
Default
is
Frame
Field
is
In
List
Field
is
Label
Path
is
List
Field
is
Matching
Atom
is
Numeric
Field
is
Object
Id
Field
is
Of
Document
Field
List
is
String
Field
keypoint
Filter
label
Count
label
Fields
label
Path
label
Paths
label
Tag
Counts
labels
Matcher
lightning
Boolean
Results
lightning
Bounds
lightning
Nonfinites
lightning
Numeric
Results
lightning
Query
lightning
String
Results
list
Boolean
list
Number
list
String
looker
Options
map
Sample
Response
max
Atom
meets
Type
min
Atom
modal
Aggregation
Paths
modal
Filter
Fields
none
Atom
none
Count
nonfinite
Atom
nonfinite
Count
nonfinite
Data
num
Group
Fields
Active
num
Group
Fields
Filtered
num
Group
Fields
Visible
numeric
numeric
Exclude
Atom
numeric
Fields
numeric
Is
Matching
Atom
parent
Field
path
Can
Be
Optimized
path
Color
path
Filter
path
Has
Indexes
path
Index
path
Is
Shown
persist
Sidebar
Groups
primitives
Matcher
pull
Sidebar
Value
range
Atom
readable
Tags
remove
Rgb
Property
resolve
Groups
sample
Tag
Counts
schema
Reduce
selected
Media
Field
selected
Media
Field
Atom
Family
selected
Patch
Ids
session
Atom
set
Current
Environment
set
Query
Performance
Path
should
Render
Ima
Vid
Looker
sidebar
Entries
sidebar
Expanded
sidebar
Expanded
Store
sidebar
Group
sidebar
Group
Mapping
sidebar
Group
Names
sidebar
Groups
sidebar
Groups
Definition
sidebar
Visible
sidebar
Width
skeleton
sort
Filter
Results
string
string
Count
Results
string
Exclude
Atom
string
Results
string
Selected
Values
Atom
stringify
Obj
tagging
text
Filter
transform
Dataset
true
Atom
unsupported
Matcher
use
Asserted
Recoil
Value
use
Before
Screenshot
use
Browser
Storage
use
Clear
Modal
use
Create
Looker
use
Debounce
Callback
use
Deferrer
use
Dimensions
use
Entries
use
Event
Handler
use
Expand
Sample
use
Follow
use
Hash
Change
Handler
use
Help
Panel
use
Hover
use
Hovered
Sample
useJSONPanel
use
Key
Down
use
Keydown
Handler
use
Looker
Options
use
Looker
Store
use
Notification
use
Observe
use
On
Select
Label
use
Outside
Click
use
Panel
use
Query
Performance
use
Refresh
use
Reset
use
Reset
Extended
Selection
use
Resize
Handler
use
Saved
Views
use
Schema
Settings
use
Screenshot
use
Scroll
Handler
use
Search
Schema
Fields
use
Select
Sample
use
Session
use
Session
Ref
use
Session
Setter
use
Session
Spaces
use
Set
Dataset
use
Set
Expanded
Sample
use
Set
Group
Slice
use
Set
Modal
State
use
Set
Selected
use
Set
Selected
Fields
Stage
use
Set
Selected
Labels
use
Set
Session
Color
Scheme
use
Set
Spaces
use
Set
View
use
Similarity
Type
use
Timeout
use
To
Clips
use
To
Evaluation
Patches
use
To
Patches
use
Tooltip
use
Unbound
State
use
Update
Samples
use
Window
Size
validate
Group
Name
values
views
Are
Equal
visibility
with
Suspense
Generated using
TypeDoc