Class LabelWidget

Hierarchy (View Summary)

Widget
- LabelWidget

Constructors

constructor

new LabelWidget(
    _parent: ContainerWidget,
    text: string,
    x: number,
    y: number,
    orientation: Orientation,
    rotationAngle: number,
    background: boolean,
    border: boolean,
): LabelWidget
Parameters
- _parent: ContainerWidget
- text: string
- x: number
- y: number
- orientation: Orientation
- rotationAngle: number
- background: boolean
- border: boolean
Returns LabelWidget
Overrides Widget.constructor
- Defined in ovl/label-widget.ts:55

Properties

_parent

_parent: ContainerWidget

Accessors

text

get text(): string
Returns string
- Defined in ovl/label-widget.ts:75
set text(text: string): void
Parameters
- text: string
Returns void
- Defined in ovl/label-widget.ts:79

padding

get padding(): number
Returns number
- Defined in ovl/label-widget.ts:86
set padding(padding: number): void
Parameters
- padding: number
Returns void
- Defined in ovl/label-widget.ts:90

font

get font(): string
Returns string
- Defined in ovl/label-widget.ts:97
set font(font: string): void
Parameters
- font: string
Returns void
- Defined in ovl/label-widget.ts:101

orientation

get orientation(): Orientation
Returns Orientation
- Defined in ovl/label-widget.ts:108
set orientation(orientation: Orientation): void
Parameters
- orientation: Orientation
Returns void
- Defined in ovl/label-widget.ts:112

angle

get angle(): number
Returns number
- Defined in ovl/label-widget.ts:119
set angle(angle: number): void
Parameters
- angle: number
Returns void
- Defined in ovl/label-widget.ts:123

fontStyle

get fontStyle(): string
Returns string
- Defined in ovl/label-widget.ts:130
set fontStyle(fontStyle: string): void
Parameters
- fontStyle: string
Returns void
- Defined in ovl/label-widget.ts:134

parent

get parent(): ContainerWidget
Returns ContainerWidget
Inherited from Widget.parent
- Defined in ovl/widget.ts:45
set parent(parent: ContainerWidget): void
Parameters
- parent: ContainerWidget
Returns void
Inherited from Widget.parent
- Defined in ovl/widget.ts:49

visible

get visible(): boolean
Returns boolean
Inherited from Widget.visible
- Defined in ovl/widget.ts:67
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Widget.visible
- Defined in ovl/widget.ts:71

clippable

get clippable(): boolean
Returns boolean
Inherited from Widget.clippable
- Defined in ovl/widget.ts:76
set clippable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Widget.clippable
- Defined in ovl/widget.ts:80

x

get x(): number
Returns number
Inherited from Widget.x
- Defined in ovl/widget.ts:84
set x(x: number): void
Parameters
- x: number
Returns void
Inherited from Widget.x
- Defined in ovl/widget.ts:91

y

get y(): number
Returns number
Inherited from Widget.y
- Defined in ovl/widget.ts:97
set y(y: number): void
Parameters
- y: number
Returns void
Inherited from Widget.y
- Defined in ovl/widget.ts:104

width

get width(): number
Returns number
Inherited from Widget.width
- Defined in ovl/widget.ts:110
set width(width: number): void
Parameters
- width: number
Returns void
Inherited from Widget.width
- Defined in ovl/widget.ts:117

height

get height(): number
Returns number
Inherited from Widget.height
- Defined in ovl/widget.ts:123
set height(height: number): void
Parameters
- height: number
Returns void
Inherited from Widget.height
- Defined in ovl/widget.ts:130

fillParent

get fillParent(): boolean
Returns boolean
Inherited from Widget.fillParent
- Defined in ovl/widget.ts:136
set fillParent(fillParent: boolean): void
Parameters
- fillParent: boolean
Returns void
Inherited from Widget.fillParent
- Defined in ovl/widget.ts:140

fillStyle

get fillStyle(): string | CanvasPattern | CanvasGradient
Returns string | CanvasPattern | CanvasGradient
Inherited from Widget.fillStyle
- Defined in ovl/widget.ts:145
set fillStyle(fillStyle: string | CanvasPattern | CanvasGradient): void
Parameters
- fillStyle: string | CanvasPattern | CanvasGradient
Returns void
Inherited from Widget.fillStyle
- Defined in ovl/widget.ts:149

strokeStyle

get strokeStyle(): string | CanvasPattern | CanvasGradient
Returns string | CanvasPattern | CanvasGradient
Inherited from Widget.strokeStyle
- Defined in ovl/widget.ts:156
set strokeStyle(strokeStyle: string | CanvasPattern | CanvasGradient): void
Parameters
- strokeStyle: string | CanvasPattern | CanvasGradient
Returns void
Inherited from Widget.strokeStyle
- Defined in ovl/widget.ts:160

absoluteX

get absoluteX(): number
Returns number
Inherited from Widget.absoluteX
- Defined in ovl/widget.ts:167

absoluteY

get absoluteY(): number
Returns number
Inherited from Widget.absoluteY
- Defined in ovl/widget.ts:177

onMouseMove

set onMouseMove(handler: (event: MouseMoveBimEvent) => boolean): void
Parameters
- handler: (event: MouseMoveBimEvent) => boolean
Returns void
Inherited from Widget.onMouseMove
- Defined in ovl/widget.ts:305

onMouseWheel

set onMouseWheel(handler: (event: MouseWheelBimEvent) => boolean): void
Parameters
- handler: (event: MouseWheelBimEvent) => boolean
Returns void
Inherited from Widget.onMouseWheel
- Defined in ovl/widget.ts:309

onMouseButton

set onMouseButton(handler: (event: MouseButtonBimEvent) => boolean): void
Parameters
- handler: (event: MouseButtonBimEvent) => boolean
Returns void
Inherited from Widget.onMouseButton
- Defined in ovl/widget.ts:313

onMouseEnter

set onMouseEnter(handler: (event: MouseMoveBimEvent) => boolean): void
Parameters
- handler: (event: MouseMoveBimEvent) => boolean
Returns void
Inherited from Widget.onMouseEnter
- Defined in ovl/widget.ts:317

onMouseLeave

set onMouseLeave(handler: (event: MouseMoveBimEvent) => boolean): void
Parameters
- handler: (event: MouseMoveBimEvent) => boolean
Returns void
Inherited from Widget.onMouseLeave
- Defined in ovl/widget.ts:321

onKeyDown

set onKeyDown(handler: (event: KeyButtonBimEvent) => boolean): void
Parameters
- handler: (event: KeyButtonBimEvent) => boolean
Returns void
Inherited from Widget.onKeyDown
- Defined in ovl/widget.ts:325

onKeyUp

set onKeyUp(handler: (event: KeyButtonBimEvent) => boolean): void
Parameters
- handler: (event: KeyButtonBimEvent) => boolean
Returns void
Inherited from Widget.onKeyUp
- Defined in ovl/widget.ts:329

Methods

setLabelFont

setLabelFont(fontFamily: string, size: number, fontStyle: FontStyle): void
Parameters
- fontFamily: string
- size: number
- fontStyle: FontStyle
Returns void
- Defined in ovl/label-widget.ts:141

setLabelBackgroundColor

setLabelBackgroundColor(
    red: number,
    green: number,
    blue: number,
    alpha: number,
): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in ovl/label-widget.ts:188

setLabelBorderColor

setLabelBorderColor(red: number, green: number, blue: number): void
Parameters
- red: number
- green: number
- blue: number
Returns void
- Defined in ovl/label-widget.ts:192

setLabelForegroundColor

setLabelForegroundColor(red: number, green: number, blue: number): void
Parameters
- red: number
- green: number
- blue: number
Returns void
- Defined in ovl/label-widget.ts:196

setLabelImage

setLabelImage(
    image: HTMLImageElement,
    width: number,
    height: number,
    placement: ImagePlacement,
): void
Parameters
- image: HTMLImageElement
- width: number
- height: number
- placement: ImagePlacement
Returns void
- Defined in ovl/label-widget.ts:200

setLabelOrientation

setLabelOrientation(orientation: Orientation): void
Parameters
- orientation: Orientation
Returns void
- Defined in ovl/label-widget.ts:211

moveLabel

moveLabel(x: number, y: number, rotationAngle: number): void
Parameters
- x: number
- y: number
- rotationAngle: number
Returns void
- Defined in ovl/label-widget.ts:215

moveLabelToLine

moveLabelToLine(x1: number, y1: number, x2: number, y2: number): void
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns void
- Defined in ovl/label-widget.ts:222

moveLabelToPoint

moveLabelToPoint(x1: number, y1: number, dirx: number, diry: number): void
Parameters
- x1: number
- y1: number
- dirx: number
- diry: number
Returns void
- Defined in ovl/label-widget.ts:256

paint

paint(context: CanvasRenderingContext2D): void
Parameters
- context: CanvasRenderingContext2D
Returns void
Overrides Widget.paint
- Defined in ovl/label-widget.ts:309

contains

contains(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Widget.contains
- Defined in ovl/widget.ts:32

update

update(): void
Returns void
Inherited from Widget.update
- Defined in ovl/widget.ts:187

repaint

repaint(context: CanvasRenderingContext2D): void
Parameters
- context: CanvasRenderingContext2D
Returns void
Inherited from Widget.repaint
- Defined in ovl/widget.ts:193

destroy

destroy(): void
Returns void
Inherited from Widget.destroy
- Defined in ovl/widget.ts:217

mouseMove

mouseMove(event: MouseMoveBimEvent): boolean
Parameters
- event: MouseMoveBimEvent
Returns boolean
Inherited from Widget.mouseMove
- Defined in ovl/widget.ts:240

mouseWheel

mouseWheel(event: MouseWheelBimEvent): boolean
Parameters
- event: MouseWheelBimEvent
Returns boolean
Inherited from Widget.mouseWheel
- Defined in ovl/widget.ts:263

mouseButton

mouseButton(event: MouseButtonBimEvent): boolean
Parameters
- event: MouseButtonBimEvent
Returns boolean
Inherited from Widget.mouseButton
- Defined in ovl/widget.ts:272

keyboard

keyboard(event: KeyButtonBimEvent): boolean
Parameters
- event: KeyButtonBimEvent
Returns boolean
Inherited from Widget.keyboard
- Defined in ovl/widget.ts:281

hasMouseEntered

hasMouseEntered(): boolean
Returns boolean
Inherited from Widget.hasMouseEntered
- Defined in ovl/widget.ts:291

hasMouseLeave

hasMouseLeave(): boolean
Returns boolean
Inherited from Widget.hasMouseLeave
- Defined in ovl/widget.ts:298

Class LabelWidget

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LabelWidget

Properties

_parent

Accessors

text

Returns string

Parameters

Returns void

padding

Returns number

Parameters

Returns void

font

Returns string

Parameters

Returns void

orientation

Returns Orientation

Parameters

Returns void

angle

Returns number

Parameters

Returns void

fontStyle

Returns string

Parameters

Returns void

parent

Returns ContainerWidget

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

clippable

Returns boolean

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

width

Returns number

Parameters

Returns void

height

Returns number

Parameters

Returns void

fillParent

Returns boolean

Parameters

Returns void

fillStyle

Returns string | CanvasPattern | CanvasGradient

Parameters

Returns void

strokeStyle

Returns string | CanvasPattern | CanvasGradient

Parameters

Returns void

absoluteX

Returns number