Type class
Represents an Event Dispatcher for InteractionObject
.
Besides regular EventDispatcher
functionality it adds new events with direct application to DOM nodes. Primarily used to handle keyboard events, but can turn into something else moving forward.
Sources
InteractionObjectEventDispatcher can be used (imported) via one of the following packages.
/** * -------------------------------------------------------- * Import from: "core.ts" * Use like: am4core.InteractionObjectEventDispatcher * -------------------------------------------------------- */ import * as am4core from "@amcharts/amcharts4/core";
/** * -------------------------------------------------------- * Include via: <script src="core.js"></script> * Access items like: am4.InteractionObjectEventDispatcher * -------------------------------------------------------- */
Inheritance
InteractionObjectEventDispatcher extends TargetedEventDispatcher
.
InteractionObjectEventDispatcher is not extended by any other symbol.
Properties
target # |
Type Inherited from A target object which is originating events using this dispatcher. |
---|---|
There is 1 inherited item currently hidden from this list. |
Methods
constructor( target: ) |
Returns Inherited from Constructor |
---|---|
copyFrom( source: ) |
Returns Inherited from Copies all dispatcher parameters, including listeners, from another event dispatcher. |
disable() |
Returns Inherited from Disable dispatching of events until re-enabled by |
disableType( type: ) |
Returns Inherited from Disable dispatching of events for a certain event type. Optionally, can set how many dispatches to skip before automatically re-enabling the dispatching. |
dispatch( type: ) |
Returns Inherited from Shelves the event to be dispatched within next update cycle. @todo automatically add in type and target properties if they are missing |
dispatchImmediately( type: ) |
Returns Inherited from Dispatches an event immediately without waiting for next cycle. @todo automatically add in type and target properties if they are missing |
dispose() |
Returns Inherited from Dispose (destroy) this object. |
enable() |
Returns Inherited from Enable dispatching of events if they were previously disabled by |
enableType( type: ) |
Returns Inherited from Enable dispatching particular event, if it was disabled before by |
has( type: ) |
Returns Inherited from Checks if there's already a listener with specific parameters. |
hasListeners() |
Returns Inherited from Checks if this particular event dispatcher has any listeners set. |
hasListenersByType( type: ) |
Returns Inherited from Checks if this particular event dispatcher has any particular listeners set. |
isDisposed() |
Returns Inherited from Returns if this object has been already disposed. |
isEnabled( type: ) |
Returns Inherited from Checks if dispatching for particular event type is enabled. |
off( type: ) |
Returns Inherited from Removes the event listener with specific parameters. |
on( type: ) |
Returns Inherited from Creates an event listener to be invoked on a specific event type. series.events.on("hidden", (ev) => { console.log("Series hidden: " + ev.target.name); }, this); series.events.on("hidden", function(ev) { console.log("Series hidden: " + ev.target.name); }, this); { // ... "series": [{ // ... "events": { "hidden": function(ev) { console.log("Series hidden: " + ev.target.name); } } }] } The above will invoke our custom event handler whenever series we put event on is hidden. @todo what if |
onAll( callback: ( this: ) |
Returns Inherited from Creates an event listener to be invoked on any event. @todo what if |
once( type: ) |
Returns Inherited from Creates an event listener to be invoked on a specific event type once. Once the event listener is invoked, it is automatically disposed. series.events.on("hidden", (ev) => { console.log("Series hidden: " + ev.target.name); }, this); series.events.on("hidden", function(ev) { console.log("Series hidden: " + ev.target.name); }, this); { // ... "series": [{ // ... "events": { "hidden": function(ev) { console.log("Series hidden: " + ev.target.name); } } }] } The above will invoke our custom event handler the first time series we put event on is hidden. @todo what if |
There are 18 inherited items currently hidden from this list. |
Events
InteractionObjectEventDispatcher does not have any events.
Adapters
InteractionObjectEventDispatcher does not have any adapters.