Events

Event Trigger

Is possible to add a listener to some events to trigger some action having a set of parameters depending on the event. The cell event can be bound to a specific column, by specifying the JSONField parameter, if not specified, the event will be bound to every column of the grid.

Cell Value Changed

This event allows to trigger an action each time a cell value is changed.
JSON structure: {
     column: [columnName],
     newValue: [_newValue],
     oldValue: [_oldValue],
     action: ['added']
  }
The column is the field name, newValue and oldValue data type depends on the cell data type and the action can have the value 'added' or 'removed', depending if is being marked as dirty (when old value is different than the new value), or removed as dirty (when the old value matches the new value).

Before Cell Editing

This event allows to trigger an action before a cell being edited.
JSON structure: {
     column: [columnName],
     newValue: [currentValue],
     oldValue: [_oldValue],
     action: ['new']
}
The column is the field name, newValue in this event will have the cell current value, the oldValue value will be the initial value, if is being edited for the first time it will have the same value as the newValue and the action can have the value 'new' or 'changed', depending if is being edited for the first time or not.

Multi Selection

This event allows to trigger an action when more than one cell is selected.
  JSON structure: {
     column: [columnName],
     newValue: [JSON statistics],
     oldValue: [previous JSON statistics],
     action: ['new']
}
The column is the field name currently being selected, if is set in the event will only trigger it for the specified column.
The newValue in this event will have a JSON having the following structure: {
     avg: [avg],
     cnt: [cnt],
     sum: [sum],
     min: [min],
     max: [max]
}
The oldValue value will have the previous selection JSON statistics, if is the first selection the oldValue will be empty.

To have access to the values returned when the event runs, should be used the NotifyGetMessage action to get the JSON text, then use the output of that action on the JSONDeserialize action to build a structure (TriggerEvent structure) filled with the cell information.
Use the JSONDeserialize action to deserialize the JSON of newValue and oldValue and have the statistics structure (StatisticSelection structure).

Single Selection

This event allows to trigger an action when only one cell is selected.
  JSON structure: {
     column: [columnName],
     newValue: [JSON statistics],
     oldValue: [previous JSON statistics],
     action: ['new']
}
The column is the field name currently being selected, if is set in the event will only trigger it for the specified column.
The newValue in this event will have a JSON having the following structure: {
     avg: [avg],
     cnt: [cnt],
     sum: [sum],
     min: [min],
     max: [max]
}
The oldValue value will have the previous selection JSON statistics, if is the first selection the oldValue will be empty.

To have access to the values returned when the event runs, should be used the NotifyGetMessage action to get the JSON text, then use the output of that action on the JSONDeserialize action to build a structure (TriggerEvent structure) filled with the cell information.
Use the JSONDeserialize action to deserialize the JSON of newValue and oldValue and have the statistics structure (StatisticSelection structure).

Row Event

Rows can trigger an action and pass some parameters that may vary depending on the event triggered.

Check

This event allows to trigger an action when a row is selected using the selection checkbox (for that CheckboxSelection option should be enabled).
JSON structure: {
     type: ['multiple'],
     value: ['checked'],
     row: [JSONData],
     action: ['changed'],
     count: ['checked rows on the current page'],
     total: ['total checked rows']
}

The type can be 'single' (row checkbox) or 'multiple' (bulk checkbox), the value will have the state of the checkbox, 'checked' or 'unchecked', the row will have the JSON data, that will have the grid structure, the action can have the value 'added' or 'removed', depending if is being created or removed the error that generated the event.

To have access to the values returned when the event runs, should be used the NotifyGetMessage action to get the JSON text, then use the output of that action on the JSONDeserialize action to build a structure (RowEventStr structure) filled with the row information, additionally to have access to each value of the row individually, should be deserialized using again the JSONDeserialize action, but receiving the RowEventStr.Row and defining as structure the grid data type. The count on the check event is the number of checked rows on the current page and the total is similar to the count but in the global context, in this case is the count of checked rows in all the pages, in case of having pagination and have more than one page, otherwise count and total will have the same value.

Error

This event allows to trigger an action when a row has an error.
JSON structure: {
     type: ['multiple'],
     value: ['checked'],
     row: [JSONData],
     action: ['changed'],
     count: ['rows with error on the current page'],
     total: ['total rows with error']
}

The type can be 'new' (created row error) or 'changed' (updated row in error), the value will have the name of the field that generated the event, the row will have the JSON data, that will have the grid structure, the action can have the value 'added' or 'removed', depending if is being created or removed the error that generated the event. The count on the error event is the number of the rows having at least one cell value with an error on the current page and the total is similar to the count but in the global context, in this case is the count of errors on all pages, in case of having pagination and have more than one page, otherwise count and total will have the same value.

Grid Events

Some events of the grid have some logic applied to handle a specific action different from the default behavior or to extend an existing behavior.

Event Handlers

Is possible to have access to the handlers of each event of the grid being applied, so it can be removed and reset the defaults if needed, or to allow to redefine an entire new behavior on an event.
The object that holds the events handler can be accessed as follows:

    var _gridId = gObj.grid;
     var _gObj = GridOS.ComponentUtils.getGridObjectById(_gridId);
     _gObj.event;

The [Handler Name] is the [Event Name] plus 'Handler', so by having the event handler name is possible to know which is the event to which it relates.
An event can be removed as follows:
_gObj.grid.[Event Name].removeHandler(_gObj.event.[Handler Name]);

To add an event is similar, but first must be set the handler function first:

    _gObj.event.[Handler Name] = function(s,e) {
        /* Logic to run when [Event Name] triggers */
    };
    _gObj.grid.[Event Name].addHandler(_gObj.event.[Handler Name]);

The event object has some sub-levels that represent the part of the grid onto event is being applied. Can be the grid itself or on the menus, filter, inputs, selection or view.

Example:
Define the copy event (copying) that triggers on Ctrl+C.

    _gObj.event.grid.copyingHandler = function(s,e) {
        e.cancel = true; // Prevents default copy
        GridOS.ContextMenuFeature.copySelected(_gObj.gridId, false, false);
    };
    _gObj.grid.copying.addHandler(_gObj.event.grid.copyingHandler);

Country

Text

Downloads

Number

Expenses

Currency

Loading ...