Interface TooltipTarget

a rectangle on screen that has something to explain, in the same space as the pointer positions fed to the host

interface TooltipTarget {
    active?(): boolean;
    bounds(): { height: number; width: number; x: number; y: number };
    text(): string | undefined;
}

Index

Methods

active? bounds text

Methods

`Optional`active

active?(): boolean
false while the target is hidden; a hidden one explains nothing. True when omitted

Returns boolean
- Defined in src/two-d/ui/Tooltip.ts:215

bounds

bounds(): { height: number; width: number; x: number; y: number }
Returns { height: number; width: number; x: number; y: number }
- Defined in src/two-d/ui/Tooltip.ts:211

text

text(): string | undefined
what to say now, or undefined for nothing

Returns string | undefined
- Defined in src/two-d/ui/Tooltip.ts:213