# Event APIs The event system definition for `cv.api` class (`cv.api.event`). Contains all necessary calls for creating and registering events. ## Constructor | Name | Description | | ------------- | ----------- | | `new event()` | | ## Methods | Name | Description | | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `disableDragAndDrop(disableDragAndDrop)` | Sets flag to indicate drag and drop should be disabled. | | `disableTableContextMenu(disableTableContextMenu)` | Disables or enables the table context menu event. | | `disableTableDoubleClick(disableTableDoubleClick)` | Disables or enables the table double click event. | | `isEventDisabled(event) : boolean` | Returns whether an event should be stopped. | | `registerActionEventListener(listener) : Event` | Registers a listener that runs after report actions and before refresh report. | | `registerBuildMenuListener(listener) : Event` | Registers a listener which runs before showing any of the menus in Analyzer. | | `registerChartDoubleClickListener(listener) : Event` | Registers a listener which runs when double-clicking on a chart item in Analyzer. | | `registerChartSelectItemsListener(listener) : Event` | Registers a listener which runs when a user selects a chart data point or lassos a collection of data points. The listener can also run when the user clears chart items by clicking on the selected chart item or by clicking the **Clear Selections** button. | | `registerDragEventListener(listener) : Event` | Registers a listener which runs when a user starts dragging an object in the report area, layout panel, or available fields. | | `registerDropEventListener(listener) : Event` | Registers a listener which runs after a drop has occurred in the report area, filter area, trash can, or layout panel. | | `registerInitListener(listener) : Event` | Registers a listener that runs during the initialization of Analyzer. | | `registerPostExecutionListener(listener) : Event` | Registers a listener which is called after the report has completely finished executing in Mondrian and the server has returned with either an HTML or JSON result, depending on the visualization type. | | `registerPreExecutionListener(listener) : Event` | Registers a listener which is called just before the browser sends the report XML to the server for processing. | | `registerRenderListener(listener) : Event` | Registers a listener that runs after the UI has drawn the visualization. | | `registerTableClickListener(listener) : Event` | Registers a listener that runs at clicking on table cell of Analyzer. | | `registerTableContextMenuListener(listener) : Event` | Registers a listener that runs at opened context menu of table cell of Analyzer. | | `registerTableDoubleClickListener(listener) : Event` | Registers a listener which runs when double-clicking on a table cell in Analyzer. | | `registerTableMouseMoveListener(listener) : Event` | Registers a listener which runs when a user moves the mouse cursor across any table cell in Analyzer. | | `registerTableMouseOverListener(listener) : Event` | Registers a listener which runs when a user positions the mouse cursor over any table cell in Analyzer. | ## Constructor Details | `new event()` | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Source: [javascript/scripts/cv\_api\_event.js, line 28](https://github.com/pentaho/pentaho-analyzer/tree/master/b/pentaho/p-analyzer/client/src/main/javascript/scripts/cv_api_event.js#L28) | ## Methods Details | `disableDragAndDrop(disableDragAndDrop)` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ------- | |

Sets flag to indicate drag and drop should be disabled.

javascript/scripts/cv\_api\_event.js, line 447

| | | | Name | Default Value | Summary | | `disableDragAndDrop :` | | | | Name | Default Value | Summary | | ---------------------- | ------------- | ------- | | `disableDragAndDrop :` | | | | `disableTableContextMenu(disableTableContextMenu)` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ------- | |

Disables or enables the table context menu event.

javascript/scripts/cv\_api\_event.js, line 475

| | | | Name | Default Value | Summary | | \`disableTableContextMenu : boolean | string\` | | | Name | Default Value | Summary | | ----------------------------------- | ------------- | ------- | | \`disableTableContextMenu : boolean | string\` | | | `disableTableDoubleClick(disableTableDoubleClick)` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ------- | |

Disables or enables the table double click event.

javascript/scripts/cv\_api\_event.js, line 460

| | | | Name | Default Value | Summary | | \`disableTableDoubleClick : boolean | string\` | | | Name | Default Value | Summary | | ----------------------------------- | ------------- | ------- | | \`disableTableDoubleClick : boolean | string\` | | | `isEventDisabled(event) : boolean` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -------------------------- | |

Returns whether an event should be stopped.

javascript/scripts/cv\_api\_event.js, line 488

| | | | Name | Default Value | Summary | | `event : string` | | Name of event in question. | | Name | Description | | | `boolean` | Flag to indicated if event should be stopped. | | | Name | Description | | --------- | --------------------------------------------- | | `boolean` | Flag to indicated if event should be stopped. | | Name | Default Value | Summary | | ---------------- | ------------- | -------------------------- | | `event : string` | | Name of event in question. |
registerActionEventListener(listener) : Event

Registers a listener that runs after report actions and before refresh report.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 178

  • Parameters
  • Returns

  • Example

cv.api.event.registerActionEventListener(function(event, api, actionCode, actionCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed after report actions and before refresh report.
NameDescription
EventObject which allows you to remove the listener post registration.
| Name | Description | | ------- | ----------------------------------------------------------------- | | `Event` | Object which allows you to remove the listener post registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed after report actions and before refresh report. |
registerBuildMenuListener(listener) : Event

Registers a listener which runs before showing any of the menus in Analyzer.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 346

  • Parameters
  • Returns

  • Example

cv.api.event.registerBuildMenuListener(function(event, api, menuId, menu, x, y) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which runs before showing any of the menus in Analyzer.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which runs before showing any of the menus in Analyzer. |
registerChartDoubleClickListener(listener) : Event

Registers a listener which runs when double-clicking on a chart item in Analyzer.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 254

  • Parameters
  • Returns

  • Example

cv.api.event.registerChartDoubleClickListener(function(event, api, ctx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed when double-clicking a chart item.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ---------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed when double-clicking a chart item. |
registerChartSelectItemsListener(listener) : Event

Registers a listener which runs when a user selects a chart data point or lassos a collection of data points. The listener can also run when the user clears chart items by clicking on the selected chart item or by clicking the Clear Selections button.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 231

  • Parameters
  • Returns

  • Example

cv.api.event.registerChartSelectItemsListener(function(event, api, ctx[]) { // Perform Action on api.* event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed when a user selects a chart data point or lassos a collection of data points.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed when a user selects a chart data point or lassos a collection of data points. | | `registerDragEventListener(listener) : Event` | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | |

Registers a listener which runs when a user starts dragging an object in the report area, layout panel, or available fields.

5.4

javascript/scripts/cv\_api\_event.js, line 378

cv.api.event.registerDragEventListener(function(event, api, formula) { // Perform Action on api.\* event.stopImmediatePropagation(); }); \`\`\`

| | | | Name | Default Value | Summary | | `listener : function` | | This is the listener function which is executed after a drag has occurred. | | Name | Description | | | `Event` | This is the object which allows you to remove the listener after registration. | | | Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | -------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed after a drag has occurred. |
registerDropEventListener(listener) : Event

Registers a listener which runs after a drop has occurred in the report area, filter area, trash can, or layout panel.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 201

  • Parameters
  • Returns

  • Example

cv.api.event.registerDropEventListener(function(event, api, formula, dropClass) { // Perform Action on api.* event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed after a drop has occurred.
NameDescription
Eventobject which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------ | | `Event` | object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | -------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed after a drop has occurred. |
registerInitListener(listener) : Event

Registers a listener that runs during the initialization of analyzer.

  • Source

javascript/scripts/cv_api_event.js, line 96

  • Parameters
  • Returns

  • Example

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

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed during the initialization.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | -------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed during the initialization. |
registerPostExecutionListener(listener) : Event

Registers a listener which is called after the report has completely finished executing in Mondrian and the server has returned with either an HTML or JSON result, depending on the visualization type.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 423

  • Parameters
  • Returns

  • Example

cv.api.event.registerPostExecutionListener(function(event, api, message) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is called after the report has completely finished executing.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is called after the report has completely finished executing. |
registerPreExecutionListener(listener) : Event

Registers a listener which is called just before the browser sends the report XML to the server for processing.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 400

  • Parameters
  • Returns

  • Example

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

```
NameDefault ValueSummary
listener : functionThis is the listener function which runs before a report is run.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ---------------------------------------------------------------- | | `listener : function` | | This is the listener function which runs before a report is run. |
registerRenderListener(listener) : Event

Registers a listener that runs after the UI has drawn the visualization.

  • Source

javascript/scripts/cv_api_event.js, line 158

  • Parameters
  • Returns

  • Example

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

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed after the UI has drawn the visualization.
NameDescription
EventObject which allows you to remove the listener post registration.
| Name | Description | | ------- | ----------------------------------------------------------------- | | `Event` | Object which allows you to remove the listener post registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed after the UI has drawn the visualization. |
registerTableClickListener(listener) : Event

Registers a listener that runs at clicking on table cell of Analyzer.

  • Source

javascript/scripts/cv_api_event.js, line 116

  • Parameters
  • Returns

  • Example

cv.api.event.registerTableClickListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed at click on table cell.
NameDescription
EventObject which allows you to remove the listener post registration.
| Name | Description | | ------- | ----------------------------------------------------------------- | | `Event` | Object which allows you to remove the listener post registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed at click on table cell. | | `registerTableContextMenuListener(listener) : Event` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | |

Registers a listener that runs at opened context menu of table cell of Analyzer.

javascript/scripts/cv\_api\_event.js, line 137

cv.api.event.registerTableContextMenuListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.\* event.preventDefault(); event.stopImmediatePropagation(); }); \`\`\`

| | | | Name | Default Value | Summary | | `listener : function` | | This is the listener function which is executed at open context menu on table cell. | | Name | Description | | | `Event` | Object which allows you to remove the listener post registration. | | | Name | Description | | ------- | ----------------------------------------------------------------- | | `Event` | Object which allows you to remove the listener post registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed at open context menu on table cell. | | `registerTableDoubleClickListener(listener) : Event` | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | |

Registers a listener which runs when double-clicking on a table cell in Analyzer.

5.4

javascript/scripts/cv\_api\_event.js, line 277

cv.api.event.registerTableDoubleClickListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.\* event.preventDefault(); event.stopImmediatePropagation(); }); \`\`\`

| | | | Name | Default Value | Summary | | `listener : function` | | This is the listener function which is executed when double-clicking on a table cell. | | Name | Description | | | `Event` | This is the object which allows you to remove the listener after registration. | | | Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed when double-clicking on a table cell. |
registerTableMouseMoveListener(listener) : Event

Registers a listener which runs when a user moves the mouse cursor across any table cell in Analyzer.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 323

  • Parameters
  • Returns

  • Example

cv.api.event.registerTableMouseMoveListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed when a user moves the mouse cursor across any table cell in Analyzer.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed when a user moves the mouse cursor across any table cell in Analyzer. |
registerTableMouseOverListener(listener) : Event

Registers a listener which runs when a user positions the mouse cursor over any table cell in Analyzer.

  • Since

5.4

  • Source

javascript/scripts/cv_api_event.js, line 300

  • Parameters
  • Returns

  • Example

cv.api.event.registerTableMouseOverListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });

```
NameDefault ValueSummary
listener : functionThis is the listener function which is executed when a user positions the mouse cursor over any table cell in Analyzer.
NameDescription
EventThis is the object which allows you to remove the listener after registration.
| Name | Description | | ------- | ------------------------------------------------------------------------------ | | `Event` | This is the object which allows you to remove the listener after registration. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------- | | `listener : function` | | This is the listener function which is executed when a user positions the mouse cursor over any table cell in Analyzer. | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.pentaho.com/analyzer-external-javascript-api/cv-apis-pentaho-analyzer-external-javascript-api-cp/event-apis-pentaho-analyzer-external-javascript-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.