InteractiveLayerOptions

Defined in: map/base-engine.ts:88

Declarative interaction options shared by every engine’s retained layers. The machinery (hover overlay, tooltip, selection styling, hit-testing) lives entirely in BaseEngine — these options are just the per-layer surface that both BaseEngine.select’s and the hover/tooltip dispatch read. Plot.layer()/Plot.points() and GeoMap.layer() forward them into the LayerSpec via BaseEngine.interactionFields, so the contract has one home.

Extended by

• LayerOptions
• PlotLayerOptions
• PlotPointOptions

Type Parameters

D

D = unknown

Properties

draggable?

optional draggable?: boolean

Defined in: map/base-engine.ts:115

Opt this layer’s glyphs into node-drag (#140): a plain drag starting on a glyph moves it (instead of panning), reheating the layout. Honored only by engines that implement node-drag (BaseEngine.beginNodeDrag — currently network()); ignored by geoMap/plot. The pointer listeners are attached when the layer is registered, like selectable.

---

hover?

optional hover?: HoverOption<D> | HoverOptions<D>

Defined in: map/base-engine.ts:100

Hover-highlight, symmetric with selection (#162). true enables the default outline/ring. A HoverOptions object — { hovered?, others? } — styles it: hovered is how the hovered item looks (a HighlightStyle redraw / custom (datum, HighlightBuilder) draw fn on Scene layers; the ring’s stroke on instanced lanes), and others fades the non-hovered glyphs (the hover analogue of selection.others, opt-in — honored on instanced lanes via the shader, so it’s a uniform change that stays free even on a full LOD-off draw). A bare HighlightStyle/draw-fn is still accepted as shorthand for { hovered: … }. The hovered item is redrawn in a tiny overlay layer — O(hovered item) per change; the base layer is untouched.

---

selectable?

optional selectable?: boolean | { multi?: boolean; }

Defined in: map/base-engine.ts:110

Opt this layer into click-driven selection. true or {} = single-select (plain click replaces the selection). { multi: true } = shift/cmd/ctrl-click toggles add/remove; plain click replaces. Omitting this option leaves the layer un-selectable (no gesture, no styling on click). The pointer listeners are attached when the layer is registered — independently of on("select"), which is a pure observer.

---

selection?

optional selection?: SelectionOptions

Defined in: map/base-engine.ts:91

Styles for BaseEngine.select: the selected set and its complement. Defaults: selected keeps the base style; others { opacity: 0.3 }.

---

tooltip?

optional tooltip?: (d, id) => string | HTMLElement | null

Defined in: map/base-engine.ts:104

Hover tooltip content for this layer (null hides). Shown in a shared engine-managed div — see tooltipClass for styling. Re-evaluated only when the hovered target changes; re-declare the layer to force a refresh.

Parameters

d

D

id

string | number

Returns

string | HTMLElement | null