pencil.js / network-event / NetworkEvent

Class: NetworkEvent<T>

Defined in: network-event.ts:13

Network event class

Extends

• BaseEvent<T>

Type Parameters

Type Parameter	Default type
T	unknown

Constructors

Constructor

new NetworkEvent<T>(
   name, 
   target, 
   event?
): NetworkEvent<T>;

Defined in: base-event.ts:23

BaseEvent constructor

Parameters

Parameter	Type	Description
name	string	Name of the event
target	T	Component concerned by the event
event?	Event	Original HTML event

Returns

NetworkEvent<T>

Inherited from

BaseEvent.constructor

Properties

Property	Type	Description	Inherited from	Defined in
bubble	boolean	Should the event continue to bubble up to parents	BaseEvent.bubble	base-event.ts:15
event?	Event	Original DOM event (if any)	BaseEvent.event	base-event.ts:12
name	string	Name of the event	BaseEvent.name	base-event.ts:6
target	T	Component concerned by the event	BaseEvent.target	base-event.ts:9

Accessors

events

Get Signature

get static events(): object;

Defined in: network-event.ts:17

Set of events for easy access

Returns

error

readonly error: "error" = "error";

Content load has fail

ready

readonly ready: "ready" = "ready";

Content has been loaded

Methods

getModifier()

getModifier(): string | null;

Defined in: base-event.ts:42

Get the event modifier (should be overridden by child classes)

Returns

string | null

Inherited from

BaseEvent.getModifier

---

prevent()

prevent(): this;

Defined in: base-event.ts:50

Prevent the initial event default behavior

Returns

this

Itself

Inherited from

BaseEvent.prevent

---

stop()

stop(): this;

Defined in: base-event.ts:34

Mark this event as stopped (won't bubble further)

Returns

this

Itself

Inherited from

BaseEvent.stop