Interface BuildVolumeSlicePlaneOptions

interface BuildVolumeSlicePlaneOptions {
    axis?: SliceAxis;
    colormap?: ColormapStops;
    filter?: "linear" | "nearest";
    id?: string;
    opacity?: number;
    position?: number;
    range?: [number, number];
    resolution?: [number, number];
    zOffset?: number;
}

Properties

axis? colormap? filter? id? opacity? position? range? resolution? zOffset?

Properties

Optionalaxis

axis?: SliceAxis

Which axis the slice is perpendicular to. Default "z" for a horizontal slice.

Optionalcolormap

colormap?: ColormapStops

Colormap stops. Default viridis.

Optionalfilter

filter?: "linear" | "nearest"

Texel filtering. Default "linear". Use "nearest" for stepped voxel output.

Optionalid

id?: string

SceneModel id. Default "volumeSlicePlane".

Optionalopacity

opacity?: number

Opacity for the slice. Default 0.85.

Optionalposition

position?: number

World-space position along axis where the slice sits. Defaults to the midpoint of the grid along the chosen axis.

Optionalrange

range?: [number, number]

Value range mapped to the colormap. Default grid.valueRange, or the data-driven min/max when that's unset. Lock this when comparing multiple overlays.

Optionalresolution

resolution?: [number, number]

Sampling resolution on the slice plane, in cells along the two in-plane axes. Higher resolution costs O(nu · nv) sample lookups per rebuild. Default 80 × 80.

OptionalzOffset

zOffset?: number

Offset (in world units) along the slice's normal axis, to lift the slice off any coincident floor / wall surface and avoid Z-fighting. Default 0.02.

Settings

Member Visibility

On This Page

Properties