PointsProps

Defined in: react/Plot.tsx:25

Props for a Points child of Plot: the imperative engine.points(name, data, opts) arguments expressed declaratively.

Extends

• PlotPointOptions<D>

Type Parameters

D

D = unknown

Properties

clipTo?

optional clipTo?: string

Defined in: map/plot.ts:55

Inherited from

PlotPointOptions.clipTo

---

data

data: readonly D[]

Defined in: react/Plot.tsx:27

---

declutter?

optional declutter?: number

Defined in: map/plot.ts:62

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).

Inherited from

PlotPointOptions.declutter

---

fill?

optional fill?: string | ((d, i) => string)

Defined in: map/plot.ts:52

Inherited from

PlotPointOptions.fill

---

hover?

optional hover?: HoverOption<D>

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

Hover-highlight: true = default white outline, a HighlightStyle = redraw the hovered item with it, or a custom (datum, HighlightBuilder) draw fn. Rendered in a tiny overlay layer — O(hovered item) per change, the base layer is untouched.

Inherited from

PlotPointOptions.hover

---

id?

optional id?: (d, i) => string | number

Defined in: map/plot.ts:54

Parameters

d

D

i

number

Returns

string | number

Inherited from

PlotPointOptions.id

---

name

name: string

Defined in: react/Plot.tsx:26

---

passThrough?

optional passThrough?: boolean

Defined in: map/plot.ts:73

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.

Inherited from

PlotPointOptions.passThrough

---

pickable?

optional pickable?: boolean

Defined in: map/plot.ts:65

When false, skip the CPU hit index (no hover/pick) — saves an Entry per point on huge non-interactive layers (e.g. streamed points).

Inherited from

PlotPointOptions.pickable

---

radius?

optional radius?: number | ((d, i) => number)

Defined in: map/plot.ts:51

Inherited from

PlotPointOptions.radius

---

selection?

optional selection?: SelectionOptions

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

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

Inherited from

PlotPointOptions.selection

---

sizeMode?

optional sizeMode?: "world" | "screen"

Defined in: map/plot.ts:57

“world” (default): radius scales with zoom. “screen”: constant pixel size.

Inherited from

PlotPointOptions.sizeMode

---

stroke?

optional stroke?: string | ((d, i) => string)

Defined in: map/plot.ts:53

Inherited from

PlotPointOptions.stroke

---

tooltip?

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

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

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

Inherited from

PlotPointOptions.tooltip

---

x

x: (d, i) => number

Defined in: map/plot.ts:49

Parameters

d

D

i

number

Returns

number

Inherited from

PlotPointOptions.x

---

y

y: (d, i) => number

Defined in: map/plot.ts:50

Parameters

d

D

i

number

Returns

number

Inherited from

PlotPointOptions.y