ExplorerScene
Defined in: scene/types.ts:244
Everything drawn at one focus: a heading, its clusters and nodes, and the edges between them. Your scene source builds one per focus.
Packed (the default): clusters and nodes packed together, biggest first; how a level of a
tree is shown. Radial: set focusId to an item’s id to draw it in the middle with its
neighbours round it; how one item’s neighbourhood in a graph is shown (see ExplorerEdge).
Fixed: set layout: "fixed" and give every item a box; items are drawn where you put them,
at the size you gave, for data with places of its own, such as a map.
Type Parameters
Section titled “Type Parameters”F = unknown
D = unknown
Properties
Section titled “Properties”bounds?
Section titled “bounds?”
optionalbounds?:ExplorerRect|null
Defined in: scene/types.ts:263
A fixed scene’s extent, in the same units as its items’ boxes; defaults to the smallest
rectangle round them. When a fixed scene is entered from an item of a fixed scene, its
bounds is fitted exactly onto that item’s box: give a child scene its parent item’s box as
bounds, in the same units, and the children land exactly where the parent was drawn.
clusters
Section titled “clusters”clusters:
ExplorerCluster<F,D>[]
Defined in: scene/types.ts:250
The groups in the scene.
edges:
ExplorerEdge[]
Defined in: scene/types.ts:254
Relationships between items of this scene (see ExplorerEdge).
expectedItemCount?
Section titled “expectedItemCount?”
optionalexpectedItemCount?:number
Defined in: scene/types.ts:269
How many items the scene will hold once every part has streamed in, if known in advance. The layout reserves room for that many, so a streaming scene never outgrows its space.
focusId?
Section titled “focusId?”
optionalfocusId?:string|null
Defined in: scene/types.ts:266
Makes the scene radial, centred on the item with this id. The centre is drawn at a fixed size and is never entered; its neighbours are sized against each other.
heading
Section titled “heading”heading:
string
Defined in: scene/types.ts:248
The scene’s name: announced to screen readers, and good for a breadcrumb.
id:
string
Defined in: scene/types.ts:246
Identifies the scene (for example, the focus as a string).
layout?
Section titled “layout?”
optionallayout?:"packed"|"fixed"
Defined in: scene/types.ts:258
"fixed" draws every item at its own box, ignoring weight; "packed" (the default) lays
them out for you. A fixed scene with a focusId keeps its boxes; the focus is still never
entered.
nodes:
ExplorerNode<F,D>[]
Defined in: scene/types.ts:252
The single things in the scene.