new EventTarget()
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 7](https://docs.videojs.com/event-target.js.html#line7)
EventTarget
is a class that can have the same API as the DOM EventTarget
. It adds shorthand functions that wrap around lengthy functions. For example: the on
function is a wrapper around addEventListener
.
See:
Methods
addEventListener()
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 75](https://docs.videojs.com/event-target.js.html#line75)
An alias of EventTarget#on. Allows EventTarget
to mimic the standard DOM API.
See:
dispatchEvent()
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 175](https://docs.videojs.com/event-target.js.html#line175)
An alias of EventTarget#trigger. Allows EventTarget
to mimic the standard DOM API.
See:
off(type, fn)
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 88](https://docs.videojs.com/event-target.js.html#line88)
Removes an event listener
for a specific event from an instance of EventTarget
. This makes it so that the event listener
will no longer get called when the named event happens.
Parameters:
Name | Type | Description |
---|---|---|
type | string | Array.<string> | An event name or an array of event names. |
fn | EventTarget~EventListener | The function to remove. |
on(type, fn)
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 58](https://docs.videojs.com/event-target.js.html#line58)
Adds an event listener
to an instance of an EventTarget
. An event listener
is a function that will get called when an event with a certain name gets triggered.
Parameters:
Name | Type | Description |
---|---|---|
type | string | Array.<string> | An event name or an array of event names. |
fn | EventTarget~EventListener | The function to call with |
one(type, fn)
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 112](https://docs.videojs.com/event-target.js.html#line112)
This function will add an event listener
that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener
with EventTarget#on that calls EventTarget#off on itself.
Parameters:
Name | Type | Description |
---|---|---|
type | string | Array.<string> | An event name or an array of event names. |
fn | EventTarget~EventListener | The function to be called once for each event name. |
removeEventListener()
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 99](https://docs.videojs.com/event-target.js.html#line99)
An alias of EventTarget#off. Allows EventTarget
to mimic the standard DOM API.
See:
trigger(event)
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 148](https://docs.videojs.com/event-target.js.html#line148)
This function causes an event to happen. This will then cause any event listeners
that are waiting for that event, to get called. If there are no event listeners
for an event then nothing will happen.
If the name of the Event
that is being triggered is in EventTarget.allowedEvents_
. Trigger will also call the on
+ uppercaseEventName
function.
Example: ‘click’ is in EventTarget.allowedEvents_
, so, trigger will attempt to call onClick
if it exists.
Parameters:
Name | Type | Description |
---|---|---|
event | string | EventTarget~Event | Object | The name of the event, an |
Type Definitions
Event
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 17](https://docs.videojs.com/event-target.js.html#line17)
A Custom DOM event.
See:
EventListener(event, hashopt)
[event-target.js](https://docs.videojs.com/event-target.js.html)
, [line 24](https://docs.videojs.com/event-target.js.html#line24)
All event listeners should follow the following format.
This:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
event | EventTarget~Event | the event that triggered this function | |
hash | Object | <optional> | hash of data sent during the event |