Skip to content

Interface: SliceViewOptions ​

Defined in: src/display/SliceView.ts:18

Options for configuring a SliceView instance.

Properties ​

width? ​

ts
optional width?: number;

Defined in: src/display/SliceView.ts:19


height? ​

ts
optional height?: number;

Defined in: src/display/SliceView.ts:20


showCrosshair? ​

ts
optional showCrosshair?: boolean;

Defined in: src/display/SliceView.ts:21


showSlider? ​

ts
optional showSlider?: boolean;

Defined in: src/display/SliceView.ts:22


crosshairOptions? ​

ts
optional crosshairOptions?: CrossHairOptions;

Defined in: src/display/SliceView.ts:24

Styling for the crosshair (colour, alpha, width and gap in screen px).


backgroundColor? ​

ts
optional backgroundColor?: number;

Defined in: src/display/SliceView.ts:26

Canvas clear colour (PIXI numeric colour). Default 0x000000.


backgroundAlpha? ​

ts
optional backgroundAlpha?: number;

Defined in: src/display/SliceView.ts:28

Canvas clear alpha in [0, 1]. Default 1.


fitPadding? ​

ts
optional fitPadding?: number;

Defined in: src/display/SliceView.ts:30

Space kept clear around the fitted slice on every side, in screen px. Default 0.

Released under the MIT License.