Interface: CrossHairOptions

Defined in: src/display/CrossHair.ts:11

Properties

crossColor?

optional crossColor?: number;

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

Line colour (PIXI numeric colour). Default red 0xff0000.

---

crossAlpha?

optional crossAlpha?: number;

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

Line opacity in [0, 1]. Default 1.

---

crossThickness?

optional crossThickness?: number;

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

Line width in screen (CSS) pixels. Default 1.

---

crossSize?

optional crossSize?: number;

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

Retained for API compatibility; unused.

---

crossLineType?

optional crossLineType?: "solid" | "dashed";

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

Retained for API compatibility; only 'solid' is drawn.

---

crosshairGap?

optional crosshairGap?: number;

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

Gap left open around the cursor, in screen (CSS) pixels. Default 8.

---

haloColor?

optional haloColor?: number;

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

Optional contrasting halo drawn under the line (PIXI numeric colour).

---

haloAlpha?

optional haloAlpha?: number;

Defined in: src/display/CrossHair.ts:27

Halo opacity in [0, 1]. Default 0 (no halo).