Skip to content

Interface: VolumeLayerFactoryConfig ​

Defined in: LayerRegistry.ts:123

Common fields accepted by the built-in factory configurations.

Extends ​

Properties ​

type ​

ts
readonly type: "volume";

Defined in: LayerRegistry.ts:48

Inherited from ​

BuiltInLayerConfigBase.type


id ​

ts
readonly id: string;

Defined in: LayerRegistry.ts:49

Inherited from ​

BuiltInLayerConfigBase.id


visible? ​

ts
optional visible?: boolean;

Defined in: LayerRegistry.ts:54

Inherited from ​

BuiltInLayerConfigBase.visible


opacity? ​

ts
optional opacity?: number;

Defined in: LayerRegistry.ts:55

Inherited from ​

BuiltInLayerConfigBase.opacity


blendMode? ​

ts
optional blendMode?: BlendMode;

Defined in: LayerRegistry.ts:56

Inherited from ​

BuiltInLayerConfigBase.blendMode


order? ​

ts
optional order?: number;

Defined in: LayerRegistry.ts:57

Inherited from ​

BuiltInLayerConfigBase.order


presentation? ​

ts
optional presentation?: Partial<LayerPresentation>;

Defined in: LayerRegistry.ts:58

Inherited from ​

BuiltInLayerConfigBase.presentation


alpha? ​

ts
optional alpha?: number;

Defined in: LayerRegistry.ts:60

Deprecated ​

Use opacity. Kept only for legacy configuration input.

Inherited from ​

BuiltInLayerConfigBase.alpha


volumeData ​

ts
volumeData: Float32Array<ArrayBufferLike> | number[];

Defined in: LayerRegistry.ts:124


dims ​

ts
dims: [number, number, number];

Defined in: LayerRegistry.ts:125


colormap? ​

ts
optional colormap?: 
  | string
  | ColorMap
  | Color[];

Defined in: LayerRegistry.ts:126


cmap? ​

ts
optional cmap?: 
  | string
  | ColorMap
  | Color[];

Defined in: LayerRegistry.ts:128

Deprecated ​

Use colormap.


range? ​

ts
optional range?: [number, number];

Defined in: LayerRegistry.ts:129


threshold? ​

ts
optional threshold?: [number, number];

Defined in: LayerRegistry.ts:130


worldToIJK? ​

ts
optional worldToIJK?: ArrayLike<number> | Matrix4;

Defined in: LayerRegistry.ts:131


affineMatrix? ​

ts
optional affineMatrix?: ArrayLike<number> | Matrix4;

Defined in: LayerRegistry.ts:132


affine? ​

ts
optional affine?: ArrayLike<number> | Matrix4;

Defined in: LayerRegistry.ts:134

Deprecated ​

Use affineMatrix.


voxelSize? ​

ts
optional voxelSize?: [number, number, number];

Defined in: LayerRegistry.ts:135


volumeOrigin? ​

ts
optional volumeOrigin?: [number, number, number];

Defined in: LayerRegistry.ts:136


useHalfFloat? ​

ts
optional useHalfFloat?: boolean;

Defined in: LayerRegistry.ts:137


fillValue? ​

ts
optional fillValue?: number;

Defined in: LayerRegistry.ts:138


projectionMode? ​

ts
optional projectionMode?: VolumeProjectionMode;

Defined in: LayerRegistry.ts:139


sampling? ​

ts
optional sampling?: VolumeSamplingMode;

Defined in: LayerRegistry.ts:140


quality? ​

ts
optional quality?: VolumeProjectionQuality;

Defined in: LayerRegistry.ts:141


ribbon? ​

ts
optional ribbon?: RibbonSamplingConfig;

Defined in: LayerRegistry.ts:142

Released under the MIT License.