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

 

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

onBeginProcessData
onEndProcessData
onPrepareVariables
onCreateReport
onOpenReport
onSaveReport
onSaveAsReport
onPreviewReport
onExit

 

 

onBeginProcessData

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

 

 

onEndProcessData

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

 

 

onPrepareVariables

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

 

 

onCreateReport

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

 

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

Описание

event

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

sender

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

Designer

report

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

isWizardUsed

Флаг указывает на то, что создание нового отчета осуществляется при помощи мастера (значение true), либо создается пустой отчет (значение false).

 

 

В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:

 

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

Описание

sender

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

StiComponentType::Designer

report

Текущий отчет, представленный в виде объекта.

isWizardUsed

Флаг указывает на то, что создание нового отчета осуществляется при помощи мастера (значение true), либо создается пустой отчет (значение false).

 

 

onOpenReport

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

 

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

Описание

event

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

sender

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

Designer

preventDefault

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

 

 

onSaveReport

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

 

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

Описание

event

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

sender

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

Designer

report

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

fileName

Имя файла отчета для сохранения.

preventDefault

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

 

 

В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:

 

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

Описание

sender

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

StiComponentType::Designer

report

Текущий отчет, представленный в виде объекта.

reportJson

Текущий отчет, представленный в виде JSON строки.

fileName

Имя файла отчета для сохранения.

 

 

onSaveAsReport

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

 

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

Описание

event

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

sender

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

Designer

report

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

fileName

Имя файла отчета для сохранения.

preventDefault

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

 

 

В таблице ниже представлен список аргументов обработчика событий на стороне PHP сервера:

 

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

Описание

sender

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

StiComponentType::Designer

report

Текущий отчет, представленный в виде объекта.

reportJson

Текущий отчет, представленный в виде JSON строки.

fileName

Имя файла отчета для сохранения.

 

 

onPreviewReport

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

 

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

Описание

event

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

sender

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

Designer

report

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

viewer

Текущий объект встроенного в дизайнер компонента вьвера.

preventDefault

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

 

 

onExit

Событие вызывается при нажатии на кнопку Выход (Exit) в главном меню дизайнера. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:

 

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

Описание

event

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

sender

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

Designer