События генератора отчетов
Генератор отчетов поддерживает события, которые предоставляют возможность выполнить необходимые операции перед определенными действиями - как на стороне JavaScript клиента, так и на стороне PHP сервера. Для работы событий на стороне клиента, никаких дополнительных настроек не требуется. Для работы событий на стороне сервера, необходимо добавить на страницу специальный обработчик событий. Подробное описание подключения и настройки PHP обработчика событий находится в разделе Обработчик событий PHP.
Генератор отчетов поддерживает следующие события:
Событие вызывается перед построением отчета. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:
Наименование |
Описание |
||
event |
Идентификатор текущего события, имеет значение "BeforeRender". |
||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||
report |
Текущий объект отчета. |
Событие вызывается перед запросом данных, необходимых для построения отчета. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:
Наименование |
Описание |
||||||||||||||||||||
event |
Идентификатор текущего события, имеет значение "BeginProcessData". |
||||||||||||||||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||||||||||||||||
report |
Текущий объект отчета. |
||||||||||||||||||||
command |
Идентификатор текущей команды, может принимать следующие значения:
|
||||||||||||||||||||
connection |
Имя текущего подключения к источнику данных, заданное в шаблоне отчета. |
||||||||||||||||||||
connectionString |
Строка подключения к SQL источнику данных. |
||||||||||||||||||||
queryString |
SQL запрос на получение данных. Используется только с командой ExecuteQuery. |
||||||||||||||||||||
database |
Наименование текущей базы данных. Может принимать следующие значения:
|
||||||||||||||||||||
pathData |
Путь к файлу источника данных, заданный в шаблоне отчета. Устанавливается только для XML и JSON источников данных. |
||||||||||||||||||||
pathSchema |
Путь к файлу схемы данных, заданный в шаблоне отчета. Устанавливается только для XML источника данных. |
||||||||||||||||||||
dataSource |
Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных. |
||||||||||||||||||||
parameters |
Коллекция параметров и их значений, заданная в SQL источнике данных. |
||||||||||||||||||||
preventDefault |
Данный флаг предоставляет возможность остановить дальнейшую обработку события генератором отчетов. По умолчанию установлено значение false. |
В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:
Наименование |
Описание |
||||||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||||||
command |
Идентификатор текущей команды, может принимать следующие значения:
|
||||||||||
connection |
Имя текущего подключения к источнику данных, заданное в шаблоне отчета. |
||||||||||
connectionString |
Строка подключения к SQL источнику данных. |
||||||||||
queryString |
SQL запрос на получение данных. Используется только с командой StiDataCommand::ExecuteQuery. |
||||||||||
database |
Наименование текущей базы данных. Может принимать следующие значения:
|
||||||||||
dataSource |
Имя текущего источника данных, заданное в шаблоне отчета. |
Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.
Событие вызывается после загрузки данных перед построением отчета. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:
Наименование |
Описание |
||||||||||||||||||||
event |
Идентификатор текущего события, имеет значение "EndProcessData". |
||||||||||||||||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||||||||||||||||
report |
Текущий объект отчета. |
||||||||||||||||||||
command |
Идентификатор текущей команды, может принимать следующие значения:
|
||||||||||||||||||||
connection |
Имя текущего подключения к источнику данных, заданное в шаблоне отчета. |
||||||||||||||||||||
database |
Наименование текущей базы данных. Может принимать следующие значения:
|
||||||||||||||||||||
dataSource |
Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных. |
||||||||||||||||||||
dataSet |
Подготовленный объект Stimulsoft.System.Data.DataSet, содержащий таблицы и строки данных, полученных из файлового источника. |
||||||||||||||||||||
result |
Коллекция колонок и их типов, а также строк данных, полученных из SQL источника. |
В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:
Наименование |
Описание |
||||||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||||||
command |
Идентификатор текущей команды, может принимать следующие значения:
|
||||||||||
connection |
Имя текущего подключения к источнику данных, заданное в шаблоне отчета. |
||||||||||
database |
Наименование текущей базы данных. Может принимать следующие значения:
|
||||||||||
dataSource |
Имя текущего источника данных, заданное в шаблоне отчета. Устанавливается только для SQL источников данных. |
||||||||||
result |
Коллекция колонок и их типов, а также строк данных, полученных из SQL источника. |
Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.
Событие вызывается перед построением отчета после подготовки переменных отчета. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:
Наименование |
Описание |
||||||
event |
Идентификатор текущего события, имеет значение "PrepareVariables". |
||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||
report |
Текущий объект отчета. |
||||||
variables |
Коллекция переменных отчета и их значений. |
||||||
preventDefault |
Данный флаг предоставляет возможность остановить дальнейшую обработку события генератором отчетов. По умолчанию установлено значение false. |
В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:
Наименование |
Описание |
||||||
sender |
Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:
|
||||||
variables |
Коллекция переменных отчета и их значений. |
Подробное описание и примеры использования находятся в разделе Работа с переменными отчета.