ExplorerNode
Defined in: scene/types.ts:100
One thing in a scene: a file, a person, a module. Drawn as a disc or square (or by a custom
renderer), and listed in the accessible outline as a link to its href.
F is your focus type (where drillsInto leads) and D your own data (data), both handed back
unchanged by the selection events.
Type Parameters
Section titled “Type Parameters”F = unknown
D = unknown
Properties
Section titled “Properties”
optionalbox?:ExplorerRect|null
Defined in: scene/types.ts:138
Where the item is, in a scene with layout: "fixed": its rectangle in the scene’s units. A
square fills it; a disc or cloud is the largest circle that fits. Without one, the item
is not drawn in a fixed scene. Other layouts ignore it.
color?
Section titled “color?”
optionalcolor?:ExplorerColour|null
Defined in: scene/types.ts:125
The item’s own colour, which wins over ramp and the stable per-id colour. An unparseable
value is ignored.
optionaldata?:D
Defined in: scene/types.ts:147
Your own data for this item, handed back with it by the selection events (onNodeSelect,
onNodeHover, onNodeActivate). The explorer never reads it.
drillsInto
Section titled “drillsInto”drillsInto:
F|null
Defined in: scene/types.ts:117
The focus this item opens when entered, or null if there is nothing inside it. The item a
radial scene centres on (focusId) is never entered, whatever this says.
effects?
Section titled “effects?”
optionaleffects?:ExplorerEffect[]
Defined in: scene/types.ts:129
"glow" and/or "pulse": see ExplorerEffect.
emphasis?
Section titled “emphasis?”
optionalemphasis?:"ring"[]
Defined in: scene/types.ts:127
["ring"] draws an outline and halo: see ExplorerEmphasis.
href:
string
Defined in: scene/types.ts:114
The item’s own page. Required: everything the canvas shows must also be reachable as an ordinary link, through the outline. Use a stable in-app URL if your data has no pages.
id:
string
Defined in: scene/types.ts:102
Unique within its scene. In a radial scene, focusId and edges refer to items by it.
optionalkind?:string|null
Defined in: scene/types.ts:134
Selects a custom renderer from the view’s renderers module (for example "planet"). With
no renderer for this kind, the item is drawn as its shape.
label:
string
Defined in: scene/types.ts:104
The name shown under the item and in the outline.
labelAt?
Section titled “labelAt?”
optionallabelAt?:ExplorerPoint|null
Defined in: scene/types.ts:144
Where a region’s label goes, in the same units as its box: a point well inside it, for a
shape whose box’s middle falls outside it. Defaults to the middle of the box.
marks?
Section titled “marks?”
optionalmarks?:string[]
Defined in: scene/types.ts:111
Short display text shown with the item in the outline (badges). Never parsed. Defaults to none.
outline?
Section titled “outline?”
optionaloutline?:ExplorerOutline|null
Defined in: scene/types.ts:141
A region’s shape inside its box (see ExplorerOutline): drawn, and hit-tested, instead of
the whole box. Ignored by other shapes.
optionalramp?:number|null
Defined in: scene/types.ts:122
A position from 0 to 1 on the view’s colour ramp (ramp prop). Absent or null gives the
item a stable colour of its own instead, so a missing value never reads as an average one.
shape:
ExplorerShape
Defined in: scene/types.ts:119
Its shape: "disc" or "square" for a node (a "cloud" reads as a group).
sublabel?
Section titled “sublabel?”
optionalsublabel?:string|null
Defined in: scene/types.ts:106
A second line, shown when the item is big enough on screen, and in the outline.
texture?
Section titled “texture?”
optionaltexture?:ExplorerTexture|null
Defined in: scene/types.ts:131
An image drawn inside the item once it is big enough on screen: see ExplorerTexture.
weight
Section titled “weight”weight:
number
Defined in: scene/types.ts:109
Sets the item’s size relative to the other nodes in its scene (nodes and clusters are sized separately). Use a real count the viewer could read, such as files, members or bytes.