Interface VolumeOverlayPanelParams

Constructor parameters for VolumeOverlayPanel.

interface VolumeOverlayPanelParams {
    container?: HTMLElement;
    grid: VoxelGrid;
    initialAxis?: SliceAxis;
    initialColormap?: string;
    initialIsovalue?: number;
    initialPosition?: number;
    initialSeedDensity?: number;
    initialTechnique?: VolumeTechnique;
    scene: Scene;
    storageKey?: string;
    studio?: Studio;
    vectorGrid?: VectorGrid;
    visible?: boolean;
}

Properties

container? grid initialAxis? initialColormap? initialIsovalue? initialPosition? initialSeedDensity? initialTechnique? scene storageKey? studio? vectorGrid? visible?

Properties

Optionalcontainer

container?: HTMLElement

grid

grid: VoxelGrid

The scalar voxel field this panel controls. The panel takes a reference to the grid; it doesn't copy the data.

OptionalinitialAxis

initialAxis?: SliceAxis

Optional starting slice axis. Default "z".

OptionalinitialColormap

initialColormap?: string

Optional initial colormap name (key of COLORMAPS). Default "viridis".

OptionalinitialIsovalue

initialIsovalue?: number

Initial iso-surface value. Default = midpoint of grid.valueRange.

OptionalinitialPosition

initialPosition?: number

Optional starting slice position. Default = midpoint along axis.

OptionalinitialSeedDensity

initialSeedDensity?: number

Initial streamline seed density (one axis). Default 8 (≈ 512 streamlines).

OptionalinitialTechnique

initialTechnique?: VolumeTechnique

Initial visualisation technique. Default "slice".

scene

scene: Scene

Scene the overlay SceneModel lives in.

OptionalstorageKey

storageKey?: string

Optionalstudio

studio?: Studio

Optional Studio for routing build / load errors through studio.reportError / reportWarning (so they land in the IssuesPanel alongside other Studio-side failures). When omitted, errors are dropped silently — the panel still stays in a consistent state but the failure isn't surfaced.

OptionalvectorGrid

vectorGrid?: VectorGrid

Optional vector field over the same volume — when supplied, the "Streamlines" technique becomes available. The vector grid's bbox should match grid.min / grid.max for sensible results.

Optionalvisible

visible?: boolean

Settings

Member Visibility

On This Page

Properties