Class LabelWidget

Hierarchy

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

absoluteX

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

absoluteY

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

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

clippable

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

fillParent

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

fillStyle

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

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

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

height

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

onKeyDown

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

onKeyUp

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

onMouseButton

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

onMouseEnter

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

onMouseLeave

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

onMouseMove

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

onMouseWheel

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

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

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

parent

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

strokeStyle

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

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

visible

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

width

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

x

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

y

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

Methods

contains

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

destroy

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

hasMouseEntered

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

hasMouseLeave

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

keyboard

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

mouseButton

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

mouseMove

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

mouseWheel

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

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

repaint

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

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

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

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

update

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