Interface: ComponentBase<M>

Defined in: types/desktop-engine.d.ts:586

Members shared by all components (Component, Window, Video, Image, Canvas)

Extends

• EventedObject<M>

Extended by

• Component
• Window
• Video
• Image
• Canvas

Type Parameters

Type Parameter
M extends ComponentEventMap

Properties

children

readonly children: AnyComponent[];

Defined in: types/desktop-engine.d.ts:597

Array of child components (each read returns a new array)

---

height

readonly height: number;

Defined in: types/desktop-engine.d.ts:595

Height after layout (reading triggers layout first)

---

identifier

readonly identifier: string;

Defined in: types/desktop-engine.d.ts:588

Unique identifier of the native component (a pointer string)

---

onclick

onclick: 
  | EventHandler<ComponentBase<M>, ClickPayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:608

click callback

---

ondbclick

ondbclick: 
  | EventHandler<ComponentBase<M>, ClickPayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:610

dbclick (double-click) callback

---

onframechange

onframechange: 
  | EventHandler<ComponentBase<M>, FrameChangePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:606

framechange callback

---

onmousedown

onmousedown: 
  | EventHandler<ComponentBase<M>, MousePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:612

mousedown callback

---

onmouseenter

onmouseenter: 
  | EventHandler<ComponentBase<M>, MousePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:616

mouseenter callback

---

onmouseleave

onmouseleave: 
  | EventHandler<ComponentBase<M>, MousePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:618

mouseleave callback

---

onmousemove

onmousemove: 
  | EventHandler<ComponentBase<M>, MousePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:620

mousemove callback, also while a press that began on the component is dragged, unless the press moves the window (see Window.dragRegion)

---

onmouseup

onmouseup: 
  | EventHandler<ComponentBase<M>, MousePayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:614

mouseup callback

---

onwheel

onwheel: 
  | EventHandler<ComponentBase<M>, WheelPayload>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:622

wheel callback

---

width

readonly width: number;

Defined in: types/desktop-engine.d.ts:593

Width after layout (reading triggers layout first)

Accessors

style

Get Signature

get style(): ComponentStyle;

Defined in: types/desktop-engine.d.ts:590

Reading returns the style object; assigning an object replaces the whole style

Returns

ComponentStyle

Set Signature

set style(value): void;

Defined in: types/desktop-engine.d.ts:591

Parameters

Parameter	Type
value	StyleProperties

Returns

void

Methods

addEventListener()

addEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:128

Adds an event listener; type may be given with or without the on prefix

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K | `on${K}`
listener	EventHandler<ComponentBase<M>, M[K]>

Returns

void

Inherited from

EventedObject.addEventListener

---

appendChild()

appendChild(child, index?): void;

Defined in: types/desktop-engine.d.ts:599

Adds a child component at index (0 to the number of children); omit it or pass -1 to append at the end. Throws a RangeError for other indexes; a Window can't be a child

Parameters

Parameter	Type
child	AnyComponent
index?	number

Returns

void

---

destroy()

destroy(): void;

Defined in: types/desktop-engine.d.ts:132

Clears all event listeners and on callbacks so the object can be garbage-collected; components also process their children recursively

Returns

void

Inherited from

EventedObject.destroy

---

offclick()

offclick(): void;

Defined in: types/desktop-engine.d.ts:626

Removes the onclick callback

Returns

void

---

offdbclick()

offdbclick(): void;

Defined in: types/desktop-engine.d.ts:628

Removes the ondbclick callback

Returns

void

---

offframechange()

offframechange(): void;

Defined in: types/desktop-engine.d.ts:624

Removes the onframechange callback

Returns

void

---

offmousedown()

offmousedown(): void;

Defined in: types/desktop-engine.d.ts:630

Removes the onmousedown callback

Returns

void

---

offmouseenter()

offmouseenter(): void;

Defined in: types/desktop-engine.d.ts:634

Removes the onmouseenter callback

Returns

void

---

offmouseleave()

offmouseleave(): void;

Defined in: types/desktop-engine.d.ts:636

Removes the onmouseleave callback

Returns

void

---

offmousemove()

offmousemove(): void;

Defined in: types/desktop-engine.d.ts:638

Removes the onmousemove callback

Returns

void

---

offmouseup()

offmouseup(): void;

Defined in: types/desktop-engine.d.ts:632

Removes the onmouseup callback

Returns

void

---

offwheel()

offwheel(): void;

Defined in: types/desktop-engine.d.ts:640

Removes the onwheel callback

Returns

void

---

remove()

remove(): void;

Defined in: types/desktop-engine.d.ts:603

Removes this component from its parent

Returns

void

---

removeChild()

removeChild(child): void;

Defined in: types/desktop-engine.d.ts:601

Removes a child component; throws if it isn't a child of this component

Parameters

Parameter	Type
child	AnyComponent

Returns

void

---

removeEventListener()

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:130

Removes the given event listener

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K | `on${K}`
listener	EventHandler<ComponentBase<M>, M[K]>

Returns

void

Inherited from

EventedObject.removeEventListener