Развертывание
Примеры |
Полный код примера можно найти на GitHub по данной ссылке.
|
Для использования продукта, достаточно загрузить ZIP архив продукта со страницы Downloads нашего сайта, распаковать его, и скопировать содержимое папки /PHP на ваш Web сервер. Данная папка представляет собой Web проект, который содержит все необходимые файлы и ресурсы для работы продукта, а также примеры по работе с вьювером и дизайнером.
Для установки продукта в уже существующий проект, достаточно из папки /PHP скопировать папку /vendor в корневую директорию проекта, либо воспользоваться менеджером зависимостей Composer, выполнив следующую консольную команду:
console |
composer require stimulsoft/reports-php
|
При работе с продуктом, в большинстве случаев достаточно использовать только PHP код, который обеспечивает работу всех основных возможностей. Для более детальной настройки продукта и использования всех возможностей, необходимо использовать JavaScript код. Далее будет описано два варианта использования тех или иных возможностей – при помощи PHP функций и при помощи JavaScript функций. Можно использовать либо первый, либо второй вариант в зависимости от потребностей.
Для использования компонента HTML5 Viewer (StiViewer) в проекте, необходимо добавить скрипты в блок <head> на PHP странице. Это можно сделать при помощи PHP класса StiJavaScript, в конструкторе нужно указать тип компонента для развёртывания:
viewer.php |
<head> <?php $js = new \Stimulsoft\StiJavaScript(\Stimulsoft\StiComponentType::Viewer); $js->renderHtml(); ?> </head>
|
Также предусмотрена возможность подключения всех необходимых скриптов при помощи <script> блока. Все скрипты продукта нахотятся в директории vendor/stimulsoft/reports-php/scripts/:
viewer.php |
<head> <script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.reports.js" type="text/javascript"></script> <script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.viewer.js" type="text/javascript"></script> </head>
|
Для работы дашбордов понадобится подключить следующий пакет:
console |
composer require stimulsoft/dashboards-php
|
В случае использования PHP кода все необходимые скрипты будут подключены автоматически, изменение кода не требуется. В случае использования JavaScript кода понадобится добавить соответствующий файл скрипта, содержащий всё необходимое для работы с аналитическими панелями:
index.php |
<head> <script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.reports.js" type="text/javascript"></script> <script src="vendor/stimulsoft/dashboards-php/scripts/stimulsoft.dashboards.js" type="text/javascript"></script> <script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.viewer.js" type="text/javascript"></script> </head>
|
Информация |
Возможные варианты оптимизаций по развертыванию находятся в разделе Уменьшение времени загрузки скриптов.
|
После этого, можно использовать PHP классы и функции для работы со вьювером, которые необходимо разместить внутри <script> блока. Для отображения вьювера на странице, достаточно создать объект компонента HTML5 Viewer (StiViewer), визуальная часть компонента будет развернута в том месте, где будет вызван данный скрипт:
viewer.php |
<script type="text/javascript"> <?php $viewer = new \Stimulsoft\Viewer\StiViewer(); $viewer->renderHtml(); ?> </script>
|
Аргументы конструктора вьювера
Конструктор объекта StiViewer может может принимать на вход необязательные аргументы, влияющие на его работу. Всего предусмотрено два аргумента:
viewer.php |
<script type="text/javascript"> <?php $viewer = new \Stimulsoft\Viewer\StiViewer($options, $viewerId); $viewer->renderHtml(); ?> </script>
|
Наименование |
Описание |
options |
Представляет собой набор опций, находящихся в классе StiViewerOptions. Опции разделены на категории и содержат всё необходимое для настройки поведения и внешнего вида вьювера. Подробное описание категорий и опций находится в разделе Настройки вьювера. |
viewerId |
Строковый идентификатор HTML элемента вьювера, по умолчанию используется значение "StiViewer". |
Существует два варианта отображения вьювера: немедленно в месте расположения скрипта, и внутри указанного HTML элемента страницы. Второй вариант может быть полезен, если, к примеру, необходимо заранее создать и выполнить скрипты вьювера, отобразить вьювер по нажатию кнопки, отобразить вьювер на динамически строящейся странице, и в других случаях.
Для отображения вьювера необходимо вызвать у созданного объекта специальную функцию renderHtml():
viewer.php |
<script type="text/javascript"> <?php $viewer = new \Stimulsoft\Viewer\StiViewer(); $viewer->renderHtml(); ?> </script>
|
При вызове функции renderHtml(), будет выполнено построение визуальной части вьювера в том месте HTML страницы, где вызвана данная функция. При необходимости, вьювер можно отобразить внутри определенного HTML элемента. В этом случае, в качестве аргумента функции достаточно передать ID этого элемента:
viewer.php |
<script type="text/javascript"> <?php $viewer = new \Stimulsoft\Viewer\StiViewer(); $viewer->renderHtml('viewerContent'); ?> </script>
<body> <div id="viewerContent"></div> </body>
|