Skip to main content
Pentaho Documentation

APIs for Event

api.event Class

The event system definition for api class. Contains all necessary calls for creating and registering Events

Methods

registerInitListener (listener)

Registers a listener that runs during the initialization of analyzer. For more information, see Analyzer Event Registration.

Parameters

  • listener (Function)

    This is the listener function which is executed during the initialization.

Returns

  • Event

This is the object which allows you to remove the listener after registration.

Example

api.event.registerInitListener( function( e, cv ) ) {
  //Perform Action on cv.api.*
  e.stopImmediatePropagation();
});