Skip to content

Interface: ScatterOptions

Defined in: layers/scatter.ts:21

Properties

color?

ts
optional color?: string | Color;

Defined in: layers/scatter.ts:24


colorBy?

ts
optional colorBy?: {
  colormap?: ColormapSpec;
  domain?: Range;
  values: ArrayLike<number>;
};

Defined in: layers/scatter.ts:48

Color each point by a value through a colormap.

colormap?

ts
optional colormap?: ColormapSpec;

domain?

ts
optional domain?: Range;

Value range mapped to [0,1]. Defaults to the data min/max.

values

ts
values: ArrayLike<number>;

colors?

ts
optional colors?: readonly (string | Color)[];

Defined in: layers/scatter.ts:36

Explicit per-point colors. Overrides color; ignored when colorBy is set (that drives the same per-point buffer).


labels?

ts
optional labels?: ArrayLike<string>;

Defined in: layers/scatter.ts:46

Optional per-point text shown when a point is clicked (one entry per point, parallel to x/y). Lets you attach your own info instead of the default coordinate readout.


marker?

ts
optional marker?: MarkerShape;

Defined in: layers/scatter.ts:38

Marker glyph. Default "circle".


name?

ts
optional name?: string;

Defined in: layers/scatter.ts:39


renderType?

ts
optional renderType?: RenderType;

Defined in: layers/scatter.ts:55

Buffer-usage hint; set "dynamic" when streaming via setData. Default "static".


size?

ts
optional size?: number;

Defined in: layers/scatter.ts:26

Marker diameter in CSS pixels.


sizes?

ts
optional sizes?: ArrayLike<number>;

Defined in: layers/scatter.ts:31

Per-point diameter in CSS pixels — a bubble chart. Overrides size wherever it is > 0; entries of 0 fall back to the uniform size.


x

ts
x: ArrayLike<number>;

Defined in: layers/scatter.ts:22


y

ts
y: ArrayLike<number>;

Defined in: layers/scatter.ts:23


yAxis?

ts
optional yAxis?: string;

Defined in: layers/scatter.ts:40

MIT licensed. WebGL2 required.