EngineInterface

Hierarchy

• EventEmitter

  ↳ EngineInterface

Table of contents

Constructors

• constructor

Properties

• opts
• uid

Methods

• close
• closeAllControls
• deregisterControl
• listenForControls
• off
• on
• registerControl
• registerControls
• render
• renderBulk
• reset

Constructors

constructor

new EngineInterface(uid, opts?)

Parameters

Name	Type
uid	string
opts?	KeyValue

Overrides

EventEmitter.constructor

Properties

opts

Readonly opts: KeyValue

---

uid

Readonly uid: string

Methods

close

close(): void

Close the input and event handler

Returns

void

---

closeAllControls

closeAllControls(): void

Close all controls

Returns

void

---

deregisterControl

deregisterControl(uid): void

Deregister

Parameters

Name	Type
uid	string

Returns

void

---

listenForControls

listenForControls(uids): void

Listen for events from only certain uids

Parameters

Name	Type
uids	string[]

Returns

void

---

off

off(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

EventEmitter.off

---

on

on(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

EventEmitter.on

---

registerControl

registerControl(uid): EngineInterfaceControl

Register a control

Parameters

Name	Type
uid	string

Returns

EngineInterfaceControl

---

registerControls

registerControls(uids): EngineInterfaceControl[]

Register multiple controls

Parameters

Name	Type
uids	string[]

Returns

EngineInterfaceControl[]

---

render

render(sender, params?): void

Render the controls using the provided params

Parameters

Name	Type
sender	string
params?	KeyValue[]

Returns

void

---

renderBulk

renderBulk(properties?): void

Parameters

Name	Type
properties?	KeyValue[]

Returns

void

---

reset

reset(): void

Reset the controls

Returns

void