Генератор отчетов поддерживает события, которые предоставляют возможность выполнить необходимые операции перед определенными действиями - как на стороне JavaScript клиента, включая платформу Node.js, так и на стороне Python сервера.

 

Для вызова события на стороне JavaScript клиента, необходимо добавить к событию название определенной в HTML шаблоне JavaScript функции в виде строки. При отсутствии HTML шаблона, а также при построении либо экспорте отчета на стороне сервера при помощи Node.js платформы, вместо названия функции необходимо к событию добавить саму функцию в виде строки или строк кода. Аргументы события будут находиться в предварительно заданной переменной args, которую можно использовать в коде события.

 
Для вызова события на стороне Python сервера, необходимо добавить к событию саму Python функцию, определенную ранее в коде. Аргументы события будут переданы в параметрах функции.
 
Для одного события можно добавлять любое количество функций, как клиентских, так и серверных. Пример различных вариантов добавления функций разного типа к событию:

 

app.py

 

def prepareVariables(args: StiVariablesEventArgs):

   variables = args.variables

 

report = StiReport()

report.onPrepareVariables += prepareVariables

report.onPrepareVariables += 'prepareVariables'

report.onBeforeRender += 'args.report.dictionary.clear();'

report.onAfterRender += 'afterRender'

report.loadFile(url_for('static', filename='reports/SimpleList.mrt'))

report.render()

 

 

report.html

 

<script>

  function prepareVariables(args) {

      let variables = args.variables;

   }

 

  function afterRender(args) {

       alert("The report rendering is completed.");

   }

</script>

 

 

 

В зависимости от события, оно может быть вызвано на стороне JavaScript клиента и на стороне PHP сервера одновременно, либо только на стороне JavaScript клиента, либо только на стороне Python сервера. Это связано с архитектурой компонентов - для построения и экспортирования отчета используется JavaScript ядро генератора, которое работает на стороне клиента, а для работы с данными используется серверный Python код. Эти две составляющие не имеет прямого доступа друг к другу, поэтому события работают раздельно, а передачу данных обеспечивает обработчик событий. В описании каждого события будет указано, какой именно тип может быть использован. Подробное описание обработчика событий и примеры использования находится в разделе Обработчик событий.

 

Информация

 

Все события, работающие на стороне JavaScript клиента, в равной степени работают на стороне Node.js сервера, т.к. в этом случае так же используется JavaScript ядро отчетов.

 

 

 

Некоторые аргументы событий принимают значения из перечислений, которые находятся в определенных пространствах имен. Все используемые в событиях генератора отчетов перечисления указаны в блоке кода ниже:

 

app.py

 

from stimulsoft_reports.enums import StiDataCommand, StiDatabaseType, StiEventType

 

 

 

Генератор отчетов поддерживает следующие события:

 

•onDatabaseConnect
•onBeforeRender
•onAfterRender
•onBeginProcessData
•onEndProcessData
•onPrepareVariables

 

 

onDatabaseConnect

[-] JavaScript  [+] Python

 

Событие вызывается перед подключением к базе данных после получения всех параметров. Подробное описание и примеры использования находятся в разделе и Подключение SQL адаптеров данных. В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне Python сервера:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.DATABASE_CONNECT

sender

Компонент, который инициировал данное событие, может иметь следующие типы:

•StiViewer
•StiDesigner

database

Тип базы данных, может принимать одно из значений перечисления StiDatabaseType.

driver

Название используемого Python драйвера базы данных.

info

Параметры подключения к базе данных, полученные из строки подключения.

link

Идентификатор подключения к базе данных. По умолчанию имеет значение None, в этом случае подключение будет создано адаптером данных.

 

 

onBeforeRender

[+] JavaScript  [+] Python

 

Событие вызывается перед построением отчета. Подробное описание и примеры использования находятся в разделе и Построение отчета.

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "BeforeRender".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Report"

report

Текущий объект отчета.

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне Python сервера:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.BEFORE_RENDER

sender

Компонент, который инициировал данное событие, может иметь следующие типы:

•StiReport

report

Текущий объект отчета.

regReportData(name, data, synchronize = False)

Метод, позволяющий передать данные в отчет. В качестве аргументов может принимать следующие значения:

name – имя источника данных в отчете;

data – данные в виде XML либо JSON строки, либо в виде Python объекта или словаря;

synchronize – флаг, указывающий на необходимость синхронизации данных, по умолчанию False.

 

 

onAfterRender

[+] JavaScript  [-] Python

 

Событие вызывается после построения отчета. Подробное описание и примеры использования находятся в разделе и Построение отчета.

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "AfterRender".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Report"

report

Текущий объект отчета.

 

 

onBeginProcessData

[+] JavaScript  [+] Python

 

Событие вызывается перед запросом данных, необходимых для построения отчета. Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "BeginProcessData".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Report"
•"Viewer"
•"Designer"

report

Текущий объект отчета.

command

Идентификатор текущей команды, может принимать следующие значения:

•"TestConnection" - выполняется проверка соединения;
•"ExecuteQuery" - выполняется запрос данных из указанного SQL источника;
•"GetSchema" - выполняется чтение XSD схемы из файлового источника;
•"GetData" - выполняется чтение данных из файлового источника.

connection

Имя текущего подключения к источнику данных, заданное в шаблоне отчета.

database

Наименование текущей базы данных. Может принимать следующие значения:

•"XML"
•"JSON"
•"Excel"
•"CSV"
•"MySQL"
•"MS SQL"
•"PostgreSQL"
•"Firebird"
•"Oracle"
•"MongoDB"
•"ODBC"

dataSource

Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных.

connectionString

Строка подключения к SQL источнику данных.

queryString

SQL запрос на получение данных. Используется только с командой ExecuteQuery.

pathData

Путь к файлу источника данных, заданный в шаблоне отчета. Устанавливается только для XML и JSON источников данных.

pathSchema

Путь к файлу схемы данных, заданный в шаблоне отчета. Устанавливается только для XML источника данных.

parameters

Коллекция параметров и их значений, заданная в SQL источнике данных.

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события генератором отчетов. По умолчанию установлено значение false.

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне Python сервера:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.BEGIN_PROCESS_DATA

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiHandler
•StiReport
•StiViewer
•StiDesigner

command

Идентификатор текущей команды. Может принимать следующие значения:

•StiDataCommand.TEST_CONNECTION - выполняется проверка соединения;
•StiDataCommand.RETRIEVE_SCHEMA - выполняется запрос схемы базы данных для NoSQL источников данных;
•StiDataCommand.EXECUTE_QUERY - выполняется запрос данных из указанного SQL или NoSQL источника;
•StiDataCommand.EXECUTE - выполняется хранимая процедура указанного SQL источника.

connection

Имя текущего подключения к источнику данных, заданное в шаблоне отчета.

database

Наименование текущей базы данных. Может принимать следующие значения:

•StiDatabaseType.XML
•StiDatabaseType.JSON
•StiDatabaseType.CSV
•StiDatabaseType.MYSQL
•StiDatabaseType.MSSQL
•StiDatabaseType.POSTGRESQL
•StiDatabaseType.FIREBIRD
•StiDatabaseType.ORACLE
•StiDatabaseType.MONGODB
•StiDatabaseType.ODBC

dataSource

Имя текущего источника данных, заданное в шаблоне отчета.

connectionString

Строка подключения к SQL источнику данных.

queryString

SQL запрос на получение данных. Используется только с командой StiDataCommand.EXECUTE_QUERY.

pathData

Путь к файлу источника данных, заданный в шаблоне отчета.

pathSchema

Путь к файлу схемы данных, заданный в шаблоне отчета. Устанавливается только для XML источника данных.

parameters

Коллекция параметров и их значений, заданная в SQL источнике данных. Значения параметров всегда передаются в первоначальном (не экранированном) виде.

 

 

onEndProcessData

[+] JavaScript  [+] Python

 

Событие вызывается после загрузки данных перед построением отчета. Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "EndProcessData".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Report"
•"Viewer"
•"Designer"

report

Текущий объект отчета.

command

Идентификатор текущей команды, может принимать следующие значения:

•"ExecuteQuery" - данные получены из указанного SQL источника.
•"GetData" - данные получены из файлового источника.

database

Наименование текущей базы данных. Может принимать следующие значения:

•"XML"
•"JSON"
•"Excel"
•"CSV"
•"MySQL"
•"MS SQL"
•"PostgreSQL"
•"Firebird"
•"Oracle"
•"MongoDB"
•"ODBC"

connection

Имя текущего подключения к источнику данных, заданное в шаблоне отчета.

dataSource

Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных.

dataSet

Подготовленный объект Stimulsoft.System.Data.DataSet, содержащий таблицы и строки данных, полученных из файлового источника.

result

Коллекция колонок и их типов, а также строк данных, полученных из SQL источника.

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне Python сервера:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.END_PROCESS_DATA

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiHandler
•StiReport
•StiViewer
•StiDesigner

command

Идентификатор текущей команды, может принимать следующие значения:

•StiDataCommand.TEST_CONNECTION - выполняется проверка соединения;
•StiDataCommand.RETRIEVE_SCHEMA - выполняется запрос схемы базы данных для NoSQL источников данных;
•StiDataCommand.EXECUTE_QUERY - выполняется запрос данных из указанного SQL или NoSQL источника;
•StiDataCommand.EXECUTE - выполняется хранимая процедура указанного SQL источника.

connection

Имя текущего подключения к источнику данных, заданное в шаблоне отчета.

database

Наименование текущей базы данных. Может принимать следующие значения:

•StiDatabaseType.XML
•StiDatabaseType.JSON
•StiDatabaseType.CSV
•StiDatabaseType.MYSQL
•StiDatabaseType.MSSQL
•StiDatabaseType.POSTGRESQL
•StiDatabaseType.FIREBIRD
•StiDatabaseType.ORACLE
•StiDatabaseType.MONGODB
•StiDatabaseType.ODBC

dataSource

Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных.

queryString

Итоговый SQL запрос со всеми параметрами, который был использован на получение данных. Используется только с командой StiDataCommand.EXECUTE_QUERY

result

Коллекция колонок и их типов, а также строк данных, полученных из SQL источника, либо строковые данные, полученные из файлового источника.

 

 

onPrepareVariables

[+] JavaScript  [+] Python

 

Событие вызывается перед построением отчета после подготовки переменных отчета. Подробное описание и примеры использования находятся в разделе Работа с переменными отчета.

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "PrepareVariables".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Report"
•"Viewer"
•"Designer"

report

Текущий объект отчета.

variables

Коллекция переменных отчета и их значений.

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события генератором отчетов. По умолчанию установлено значение false.

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне Python сервера:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.PREPARE_VARIABLES

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiHandler
•StiReport
•StiViewer
•StiDesigner

variables

Коллекция переменных отчета и их значений.