Skip to content

Interface: ImageOptions

Defined in: layers/image.ts:9

Properties

extent

ts
extent: {
  x: Range;
  y: Range;
};

Defined in: layers/image.ts:13

Data-space rectangle the image spans.

x

ts
x: Range;

y

ts
y: Range;

name?

ts
optional name?: string;

Defined in: layers/image.ts:22


onLoad?

ts
optional onLoad?: () => void;

Defined in: layers/image.ts:19

Called after an async (URL) image finishes loading — wire to plot.requestRender.

Returns

void


opacity?

ts
optional opacity?: number;

Defined in: layers/image.ts:17

Overall opacity 0..1. Default 1.


renderType?

ts
optional renderType?: RenderType;

Defined in: layers/image.ts:21

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


smooth?

ts
optional smooth?: boolean;

Defined in: layers/image.ts:15

Bilinear filtering (default) vs. nearest.


source

ts
source: ImageSource;

Defined in: layers/image.ts:11

A decoded bitmap/canvas/ImageData, or a URL to load (CORS-enabled).


yAxis?

ts
optional yAxis?: string;

Defined in: layers/image.ts:23

MIT licensed. WebGL2 required.