Event APIs
cv.api. event
The event system definition for cv.api class. 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() |
---|
Methods Details
disableDragAndDrop(disableDragAndDrop) | ||||||
---|---|---|---|---|---|---|
Sets flag to indicate drag and drop should be disabled Source: javascript/scripts/cv_api_event.js, line 447
|
disableTableContextMenu(disableTableContextMenu) | ||||||
---|---|---|---|---|---|---|
Disables or enables the table context menu event Source: javascript/scripts/cv_api_event.js, line 475
|
disableTableDoubleClick(disableTableDoubleClick) | ||||||
---|---|---|---|---|---|---|
Disables or enables the table double click event Source: javascript/scripts/cv_api_event.js, line 460
|
isEventDisabled(event) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns whether an event should be stopped. Source: javascript/scripts/cv_api_event.js, line 488
|
registerActionEventListener(listener) : Event | ||
---|---|---|
Registers a listener that runs after report actions and before refresh report. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which is executed after report actions and before refresh report. |
Name | Description |
---|---|
Event | object which allows you to remove the listener post registration. |
Example
cv.api.event.registerActionEventListener(function(event, api, actionCode, actionCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerBuildMenuListener(listener) : Event | ||
---|---|---|
Registers a listener which runs before showing any of the menus in Analyzer. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which runs before showing any of the menus in Analyzer. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerBuildMenuListener(function(event, api, menuId, menu, x, y) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerChartDoubleClickListener(listener) : Event | ||
---|---|---|
Registers a listener which runs when double-clicking on a chart item in Analyzer. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which is executed when double-clicking a chart item. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerChartDoubleClickListener(function(event, api, ctx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
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. |
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. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerChartSelectItemsListener(function(event, api, ctx[]) { // Perform Action on api.* event.stopImmediatePropagation(); });
registerDragEventListener(listener) : Event | ||
---|---|---|
Registers a listener which runs when a user starts dragging an object in the report area, layout panel, or available fields. |
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. |
Example
cv.api.event.registerDragEventListener(function(event, api, formula) { // Perform Action on api.* event.stopImmediatePropagation(); });
registerDropEventListener(listener) : Event | ||
---|---|---|
Registers a listener which runs after a drop has occurred in the report area, filter area, trash can, or layout panel. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which is executed after a drop has occurred. |
Name | Description |
---|---|
Event | object which allows you to remove the listener after registration. |
Example
cv.api.event.registerDropEventListener(function(event, api, formula, dropClass) { // Perform Action on api.* event.stopImmediatePropagation(); });
registerInitListener(listener) : Event | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Registers a listener that runs during the initialization of analyzer. Source: javascript/scripts/cv_api_event.js, line 96
Example cv.api.event.registerInitListener(function(event, cv)) { // Perform Action on cv.api.* event.stopImmediatePropagation(); }); |
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. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which is called after the report has completely finished executing. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerPostExecutionListener(function(event, api, message) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerPreExecutionListener(listener) : Event | ||
---|---|---|
Registers a listener which is called just before the browser sends the report XML to the server for processing. |
Name | Default Value | Summary |
---|---|---|
listener : function | This is the listener function which runs before a report is run. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerPreExecutionListener(function(event, api) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerRenderListener(listener) : Event | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Registers a listener that runs after the UI has drawn the visualization. Source: javascript/scripts/cv_api_event.js, line 158
Example cv.api.event.registerRenderListener(function(event, api, reportArea) { // Perform Action on api.* event.stopImmediatePropagation(); }); |
registerTableClickListener(listener) : Event | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Registers a listener that runs at clicking on table cell of analyzer. Source: javascript/scripts/cv_api_event.js, line 116
Example cv.api.event.registerTableClickListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); }); |
registerTableContextMenuListener(listener) : Event | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Registers a listener that runs at opened context menu of table cell of analyzer. Source: javascript/scripts/cv_api_event.js, line 137
Example cv.api.event.registerTableContextMenuListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); }); |
registerTableDoubleClickListener(listener) : Event | ||
---|---|---|
Registers a listener which runs when double-clicking on a table cell in Analyzer. |
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. |
Example
cv.api.event.registerTableDoubleClickListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerTableMouseMoveListener(listener) : Event | ||
---|---|---|
Registers a listener which runs when a user moves the mouse cursor across any table cell in Analyzer. |
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. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerTableMouseMoveListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });
registerTableMouseOverListener(listener) : Event | ||
---|---|---|
Registers a listener which runs when a user positions the mouse cursor over any table cell in Analyzer. |
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. |
Name | Description |
---|---|
Event | This is the object which allows you to remove the listener after registration. |
Example
cv.api.event.registerTableMouseOverListener(function(event, api, td, ctx, filterCtx) { // Perform Action on api.* event.preventDefault(); event.stopImmediatePropagation(); });