| 1 |
efrain |
1 |
// This file is part of Moodle - http://moodle.org/
|
|
|
2 |
//
|
|
|
3 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
4 |
// it under the terms of the GNU General Public License as published by
|
|
|
5 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
6 |
// (at your option) any later version.
|
|
|
7 |
//
|
|
|
8 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
9 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
10 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
11 |
// GNU General Public License for more details.
|
|
|
12 |
//
|
|
|
13 |
// You should have received a copy of the GNU General Public License
|
|
|
14 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
15 |
|
|
|
16 |
/**
|
|
|
17 |
* Report builder events
|
|
|
18 |
*
|
|
|
19 |
* @module core_reportbuilder/local/events
|
|
|
20 |
* @copyright 2021 Paul Holden <paulh@moodle.com>
|
|
|
21 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
22 |
*/
|
|
|
23 |
|
|
|
24 |
/**
|
|
|
25 |
* Events for the Report builder subsystem
|
|
|
26 |
*
|
|
|
27 |
* @constant
|
|
|
28 |
* @property {String} tableReload See {@link event:tableReload}
|
|
|
29 |
*/
|
|
|
30 |
export default {
|
|
|
31 |
/**
|
|
|
32 |
* Trigger table reloading
|
|
|
33 |
*
|
|
|
34 |
* @event tableReload
|
|
|
35 |
* @type {CustomEvent}
|
|
|
36 |
* @property {object} detail
|
|
|
37 |
* @property {Boolean} detail.preservePagination Whether current pagination should be preserved (default false)
|
|
|
38 |
* @property {String} detail.preserveTriggerElement Element selector that should be focused after table reload (default null)
|
|
|
39 |
*
|
|
|
40 |
* @example <caption>Triggering table reload</caption>
|
|
|
41 |
* import {dispatchEvent} from 'core/event_dispatcher';
|
|
|
42 |
* import * as reportEvents from 'core_reportbuilder/local/events';
|
|
|
43 |
*
|
|
|
44 |
* dispatchEvent(reportEvents.tableReload, {}, document.querySelector(...));
|
|
|
45 |
*/
|
|
|
46 |
tableReload: 'core_reportbuilder_table_reload',
|
|
|
47 |
publish: {
|
|
|
48 |
reportColumnsUpdated: 'core_reportbuilder_report_columns_updated',
|
|
|
49 |
},
|
|
|
50 |
};
|