ExplorerCluster

Defined in: scene/types.ts:160

A group in a scene: a folder, a department, a package. Drawn as a soft cloud, usually entered to see what is inside. It shares a node’s fields, with two differences:

• its href may be null, but only for an aggregate: a cluster standing for items left out (“12 more”), which sets truncated and has drillsInto: null. An aggregate is drawn hollow, cannot be entered, and the outline says “showing N of M”;
• it is sized against the other clusters, and always drawn at least twice the size of the largest node in its scene.

Type Parameters

F

F = unknown

D

D = unknown

Properties

box?

optional box?: ExplorerRect | null

Defined in: scene/types.ts:193

As ExplorerNode.box.

---

color?

optional color?: ExplorerColour | null

Defined in: scene/types.ts:183

As ExplorerNode.color. An aggregate keeps the palette’s aggregate colour.

---

data?

optional data?: D

Defined in: scene/types.ts:199

As ExplorerNode.data.

---

drillsInto

drillsInto: F | null

Defined in: scene/types.ts:174

The focus this group opens when entered; null for an aggregate or a group with nothing inside.

---

effects?

optional effects?: ExplorerEffect[]

Defined in: scene/types.ts:187

As ExplorerNode.effects. Ignored on an aggregate.

---

emphasis?

optional emphasis?: "ring"[]

Defined in: scene/types.ts:185

As ExplorerNode.emphasis.

---

href

href: string | null

Defined in: scene/types.ts:172

The group’s own page, or null only for an aggregate (see above).

---

id

id: string

Defined in: scene/types.ts:162

As ExplorerNode.id.

---

kind?

optional kind?: string | null

Defined in: scene/types.ts:191

As ExplorerNode.kind.

---

label

label: string

Defined in: scene/types.ts:164

As ExplorerNode.label.

---

labelAt?

optional labelAt?: ExplorerPoint | null

Defined in: scene/types.ts:197

As ExplorerNode.labelAt.

---

marks?

optional marks?: string[]

Defined in: scene/types.ts:170

As ExplorerNode.marks.

---

outline?

optional outline?: ExplorerOutline | null

Defined in: scene/types.ts:195

As ExplorerNode.outline.

---

ramp?

optional ramp?: number | null

Defined in: scene/types.ts:181

As ExplorerNode.ramp.

---

shape

shape: ExplorerShape

Defined in: scene/types.ts:179

Usually "cloud".

---

sublabel?

optional sublabel?: string | null

Defined in: scene/types.ts:166

As ExplorerNode.sublabel.

---

texture?

optional texture?: ExplorerTexture | null

Defined in: scene/types.ts:189

As ExplorerNode.texture. A "cloud" ignores it.

---

truncated?

optional truncated?: ExplorerTruncation | null

Defined in: scene/types.ts:177

Set only on an aggregate standing for items left out (use windowed()); absent or null means this cluster is complete.

---

weight

weight: number

Defined in: scene/types.ts:168

Sets the cluster’s size relative to the other clusters in its scene. Use a real count.