Skip to content

Interface: OrientationLabelOptions

Defined in: src/display/OrientationLabelLayer.ts:13

Options for orientation labels.

Properties

fontSize?

ts
optional fontSize?: number;

Defined in: src/display/OrientationLabelLayer.ts:15

Font size in screen pixels (labels do NOT scale with the image).


color?

ts
optional color?: number;

Defined in: src/display/OrientationLabelLayer.ts:17

Fill color of the letters (PIXI numeric color).


fontFamily?

ts
optional fontFamily?: string;

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

Font family.


margin?

ts
optional margin?: number;

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

Distance from the viewport edge, in screen pixels.


strokeColor?

ts
optional strokeColor?: number;

Defined in: src/display/OrientationLabelLayer.ts:23

Outline color drawn around the letters for contrast over bright/dark anatomy.


strokeWidth?

ts
optional strokeWidth?: number;

Defined in: src/display/OrientationLabelLayer.ts:25

Outline width in pixels. Set to 0 to disable.

Released under the MIT License.