PlotPointOptions
Defined in: map/plot.ts:57
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.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”D = unknown
Properties
Section titled “Properties”clipTo?
Section titled “clipTo?”
optionalclipTo?:string
Defined in: map/plot.ts:64
declutter?
Section titled “declutter?”
optionaldeclutter?:number
Defined in: map/plot.ts:71
Screen-space declutter radius (px): on each transform, hide points whose projected center
falls within this radius of an already-kept one (earlier data wins). Each point’s anchor is
its center, so unlike PlotLayerOptions no explicit anchor is needed. Pairs with
sizeMode: "screen". Retained path only (not passThrough).
draggable?
Section titled “draggable?”
optionaldraggable?: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.
Inherited from
Section titled “Inherited from”InteractiveLayerOptions.draggable
optionalfill?:string| ((d,i) =>string)
Defined in: map/plot.ts:61
hover?
Section titled “hover?”
optionalhover?: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.
Inherited from
Section titled “Inherited from”
optionalid?: (d,i) =>string|number
Defined in: map/plot.ts:63
Parameters
Section titled “Parameters”D
number
Returns
Section titled “Returns”string | number
passThrough?
Section titled “passThrough?”
optionalpassThrough?:boolean
Defined in: map/plot.ts:82
Render via the backend’s pass-through path: no retained Scene geometry, no hit index (not pickable). Points are projected + drawn directly each repaint (on both Canvas and WebGL), so the data may be a callback re-invoked per repaint (you own the array). For huge / fast-changing point sets beyond the retained ceiling (~4–16M). Trade-off vs the default retained path: retained is always crisp, interactive, and pickable but capped; pass-through is uncapped + streaming but shows a slightly stale raster during pan/zoom (re-crisp on settle) and isn’t pickable.
pickable?
Section titled “pickable?”
optionalpickable?:boolean
Defined in: map/plot.ts:74
When false, skip the CPU hit index (no hover/pick) — saves an Entry per point on huge non-interactive layers (e.g. streamed points).
radius?
Section titled “radius?”
optionalradius?:number| ((d,i) =>number)
Defined in: map/plot.ts:60
selectable?
Section titled “selectable?”
optionalselectable?: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.
Inherited from
Section titled “Inherited from”InteractiveLayerOptions.selectable
selection?
Section titled “selection?”
optionalselection?: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 }.
Inherited from
Section titled “Inherited from”InteractiveLayerOptions.selection
sizeMode?
Section titled “sizeMode?”
optionalsizeMode?:"world"|"screen"
Defined in: map/plot.ts:66
“world” (default): radius scales with zoom. “screen”: constant pixel size.
stroke?
Section titled “stroke?”
optionalstroke?:string| ((d,i) =>string)
Defined in: map/plot.ts:62
tooltip?
Section titled “tooltip?”
optionaltooltip?: (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
Section titled “Parameters”D
string | number
Returns
Section titled “Returns”string | HTMLElement | null
Inherited from
Section titled “Inherited from”InteractiveLayerOptions.tooltip
x: (
d,i) =>number
Defined in: map/plot.ts:58
Parameters
Section titled “Parameters”D
number
Returns
Section titled “Returns”number
y: (
d,i) =>number
Defined in: map/plot.ts:59
Parameters
Section titled “Parameters”D
number
Returns
Section titled “Returns”number