Skip to content

Interface: VolumeOptions

Defined in: plot3d/volume.ts:7

Properties

colormap?

ts
optional colormap?: ColormapSpec;

Defined in: plot3d/volume.ts:13


density?

ts
optional density?: number;

Defined in: plot3d/volume.ts:17

Overall opacity multiplier. Default 1.


dims

ts
dims: [number, number, number];

Defined in: plot3d/volume.ts:10


domain?

ts
optional domain?: Range;

Defined in: plot3d/volume.ts:15

Value range mapped to the colormap + opacity. Defaults to the data min/max.


extent?

ts
optional extent?: {
  x: Range;
  y: Range;
  z: Range;
};

Defined in: plot3d/volume.ts:12

World extent of the volume. Defaults to unit indices.

x

ts
x: Range;

y

ts
y: Range;

z

ts
z: Range;

name?

ts
optional name?: string;

Defined in: plot3d/volume.ts:18


renderType?

ts
optional renderType?: RenderType;

Defined in: plot3d/volume.ts:20

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


values

ts
values: ArrayLike<number>;

Defined in: plot3d/volume.ts:9

Scalar volume, length nx*ny*nz, indexed x + y*nx + z*nx*ny.

MIT licensed. WebGL2 required.