Настройка вьювера выполняется при помощи свойств, находящихся в классе StiViewerOptions. Все свойства разделены на группы для удобства использования. Все классы и перечисления вьювера находятся в пространстве имен \Stimulsoft\Viewer.  Для настройки вьювера необходимо создать класс опций, установить требуемые свойства и передать объект опций в качестве первого аргумента конструктору вьювера:

 

viewer.php

 

<?php

$options = new \Stimulsoft\Viewer\StiViewerOptions();

 

$options->appearance->theme = \Stimulsoft\Viewer\StiViewerTheme::Office2022WhiteBlue;

$options->appearance->reportDisplayMode = \Stimulsoft\Viewer\StiHtmlExportMode::FromReport;

$options->width = '1000px';

$options->height = '1000px';

$options->toolbar->displayMode = \Stimulsoft\Viewer\StiToolbarDisplayMode::Separated;

$options->appearance->fullScreenMode = true;

$options->appearance->scrollbarsMode = true;

$options->exports->ShowExportToWord = false;

$options->exports->showExportToCsv = false;

 

$viewer = new \Stimulsoft\Viewer\StiViewer($options);

$viewer->renderHtml();

?>

 

 

 

Главная (без группы)

 

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

Описание

width

Задает ширину компонента в "px" или "%". По умолчанию установлено значение "100%".

height

Задает высоту компонента в "px" или "%". По умолчанию установлено значение "100%" для стандартного режима, и "650px" для режима отображения с полосами прокрутки.

localization

Устанавливает выбранную локализацию компонента. По умолчанию установлена английская локализация, которая встроена в сам компонент.

 

 

Оформление (Appearance)

 

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

Описание

theme

Задает тему оформления вьювера. Список доступных тем оформления находится в перечислении StiViewerTheme. По умолчанию установлено значение Office2022WhiteBlue.

iconSet

Предоставляет возможность установить набор иконок:

 

•StiWebUIIconSet::Auto (значение по умолчанию) -  устанавливает набор иконок автоматически. Для тем Office2022 - используется набор иконок в стиле Monoline, для тем Office2013 - используется набор иконок в стиле Regular.
•StiWebUIIconSet::Monoline - устанавливает набор иконок в стиле Monoline;
•StiWebUIIconSet::Regular - устанавливает набор иконок в стиле Regular.

backgroundColor

Устанавливает цвет фона вьювера. По умолчанию, установлено значение 'white'.

pageBorderColor

Устанавливает цвет границы страниц отчета. По умолчанию, установлено значение 'gray'.

rightToLeft

Устанавливает режим отображения Right to Left для элементов управления вьювера. По умолчанию, установлено значение false

fullScreenMode

Устанавливает полноэкранный режим отображения вьювера. Если свойство установлено в значение true, то значения свойств width и height игнорируются. По умолчанию, установлено значение false.

scrollbarsMode

Устанавливает режим отображения отчета с полосами прокрутки. По умолчанию, установлено значение false.

openLinksWindow

Устанавливает целевое окно или фрэйм для открытия гиперссылок из отчета. По умолчанию, установлено значение '_blank' (новая вкладка браузера). Может принимать одно из стандартных значений '_blank', '_self', '_top', a так же имя окна либо фрэйма.

showTooltips

Включает или выключает отображение подсказок при наведении курсора на инструмент вьювера. По умолчанию, установлено значение true.

showTooltipsHelp

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

showDialogsHelp

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

pageAlignment

Устанавливает выравнивание страниц отчета во вьювере.

•StiContentAlignmen::DefaultValue – выравнивание страниц определяется из настроек шаблона (значение по умолчанию);
•StiContentAlignment::Left – выравнивание страниц по левому краю;
•StiContentAlignment::Center – выравнивание страниц по центру;
•StiContentAlignment::Right – выравнивание страниц по правому краю.

showPageShadow

Включает или выключает отображение тени страниц отчета. По умолчанию, установлено значение false.

bookmarksPrint

Включает печать закладок в отчете. По умолчанию, установлено значение false.

bookmarksTreeWidth

Устанавливает ширину панели закладок в пикселях. По умолчанию, установлено значение 180.

parametersPanelPosition

Устанавливает расположение панели параметров во вьювере:

•StiParametersPanelPosition::FromReport – расположение панели определяется из настроек шаблона (значение по умолчанию);
•StiParametersPanelPosition::Top - панель располагается вверху над страницей отчета;
•StiParametersPanelPosition::Left - панель располагается слева от страницы отчета.

parametersPanelMaxHeight

Устанавливает максимальную высоту панели параметров в пикселях. По умолчанию, установлено значение 300.

parametersPanelColumnsCount

Устанавливает количество колонок на панели параметров. По умолчанию, установлено значение 2.

parametersPanelDateFormat

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

parametersPanelSortDataItems

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

interfaceType

Устанавливает тип интерфейса вьювера. Могут использоваться следующие значения:

•StiInterfaceType::Auto – тип интерфейса вьювера будет выбран автоматически в зависимости от используемого устройства (значение по умолчанию);
•StiInterfaceType::Mouse – принудительное использование стандартного интерфейса для управления вьювером при помощи мыши;
•StiInterfaceType::Touch – принудительное использование Touch интерфейса для управления вьювером при помощи сенсорного экрана монитора, в этом режиме элементы интерфейса вьювера имеют увеличенные размеры для удобства управления;
•StiInterfaceType::Mobile – принудительное использование Mobile интерфейса для управления вьювером при помощи экрана смартфона, в этом режиме интерфейс вьювера имеет упрощенный вид и адаптирован для управления при помощи мобильного устройства.

allowMobileMode

Включает или выключает возможность отображения отчета или дашборда в мобильном режиме. Если опция установлена в значение false, то мобильный режим просмотра не будет использоваться ни при каких обстоятельства. Если опция установлена в значение true, то мобильный режим просмотра будет использоваться запуске вьювера на мобильных устройствах. По умолчанию, опция установлена в значение true.

chartRenderType

Устанавливает тип отрисовки диаграмм в отчете:

•StiChartRenderType::AnimatedVector – диаграммы будут отрисованы в векторном режиме с анимацией (значение по умолчанию);
•StiChartRenderType::Vector – диаграммы будут отрисованы как векторное изображение без анимации.

reportDisplayMode

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

•StiHtmlExportMode::FromReport - режим экспорта элементов отчета определяется из настроек шаблона - Div или Table (значение по умолчанию);
•StiHtmlExportMode::Table – элементы отчета экспортируются с использованием таблиц HTML;
•StiHtmlExportMode::Div – элементы отчета экспортируются с использованием разметки DIV;

datePickerFirstDayOfWeek

Предоставляет возможность установить первый день недели для инструмента Выбор даты (Date picker).

•StiFirstDayOfWeek::Auto - Будет установлен понедельник или воскресенье как первый день недели, в зависимости от культуры браузера.
•StiFirstDayOfWeek::Monday - Понедельник будет установлен как первый день недели.
•StiFirstDayOfWeek::Sunday - Воскресенье будет установлен как первый день недели.

datePickerIncludeCurrentDayForRanges

Предоставляет возможность включать или не включать текущий день в диапазон значений элемента Выбор даты (Date Picker). По умолчанию, опция установлена в значение false, т.е. текущий день не включается в диапазон значений элемента.

allowTouchZoom

Предоставляется возможность изменять масштаб вьювера касанием. По умолчанию, опция установлена в значение true.

combineReportPages

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

 

 

Панель инструментов (Toolbar)

 

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

Описание

visible

Предоставляет возможность отображать или не отображать панель инструментов вьювера. По умолчанию, установлено значение true.

displayMode

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

•StiToolbarDisplayMode::Simple – простой режим отображения, все элементы управления расположены на одной панели управления (значение по умолчанию);
•StiToolbarDisplayMode::Separated – раздельный режим отображения, панель управления разделена на верхнюю и нижнюю.

backgroundColor

Предоставляет возможность изменить цвет панели инструментов. По умолчанию, установлено значение 'transparent'.

borderColor

Предоставляет возможность изменить цвет границы панели инструментов. По умолчанию, установлено значение 'transparent'.

fontColor

Предоставляет возможность изменить цвет шрифта для всех элементов на панели инструментов и во всех меню этой панели. По умолчанию, установлено значение 'transparent'.

fontFamily

Предоставляет возможность изменить шрифт для всех элементов на панели инструментов и во всех меню этой панели. По умолчанию, установлено значение 'Arial'.

alignment

Устанавливает выравнивание элементов на панели управления.

•StiContentAlignment::Default – выравнивание элементов зависит от опции RightToLeft (значение по умолчанию); 
•StiContentAlignment::Left – все элементы будут выровнены по левому краю панели инструментов;
•StiContentAlignment::Center – все элементы будут выровнены по центру панели инструментов;
•StiContentAlignment::Right – все элементы будут выровнены по правой стороне панели инструментов.

showButtonCaptions

Включает или выключает отображение текста кнопок панели инструментов вьювера. По умолчанию, установлено значение true.

showPrintButton

Предоставляет возможность отображать или не отображать кнопку Печать (Print) на панели инструментов. По умолчанию, установлено значение true.

showOpenButton

Включает отображение кнопки Открыть (Open) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

showSaveButton

Включает отображение кнопки Сохранить (Save) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

showSendEmailButton

Предоставляет возможность отображать или не отображать кнопку Отправить по Email (Send Email) на панели инструментов. По умолчанию, установлено значение false. Также, необходимо добавить обработчик события onEmailReport.

showFindButton

Предоставляет возможность отображать или не отображать кнопку Поиск (Find) на панели инструментов. По умолчанию, установлено значение true.

showBookmarksButton

Предоставляет возможность отображать или не отображать кнопку Закладки (Bookmarks) на панели инструментов. Если эта кнопка не отображается, то и панель закладок в отчете отображаться не будет. По умолчанию, установлено значение true.

showParametersButton

Предоставляет возможность отображать или не отображать кнопку Параметры (Parameters) на панели инструментов. Если эта кнопка не отображается, то и панель параметров в отчете отображаться не будет. По умолчанию, установлено значение true.

showResourcesButton

Предоставляет возможность отображать или не отображать кнопку Ресурсы (Resources) на панели инструментов. Если эта кнопка не отображается, то и панель ресурсов в отчете отображаться не будет. По умолчанию, установлено значение true.

showEditorButton

Предоставляет возможность отображать или не отображать кнопку Редактировать (Editor) на панели инструментов. Если эта кнопка не отображается, то невозможно будет изменить редактируемые элементы. По умолчанию, установлено значение true.

showFullScreenButton

Включает отображение кнопки Полноэкранный просмотр (Full Screen) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

showRefreshButton

Предоставляет возможность отображать или не отображать кнопку Обновить (Refresh) на панели инструментов вьювера при просмотре панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

showFirstPageButton

Предоставляет возможность отображать или не отображать кнопку Первая страница (First Page) на панели инструментов. По умолчанию, установлено значение true.

showPreviousPageButton

Предоставляет возможность отображать или не отображать кнопку Последняя страница (Previous Page) на панели инструментов. По умолчанию, установлено значение true.

showCurrentPageControl

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

showNextPageButton

Предоставляет возможность отображать или не отображать кнопку Следующая страница (Next Page) на панели инструментов. По умолчанию, установлено значение true.

showLastPageButton

Предоставляет возможность отображать или не отображать кнопку Предыдущая страница (Last Page) на панели инструментов. По умолчанию, установлено значение true.

showZoomButton

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

showViewModeButton

Предоставляет возможность отображать или не отображать кнопку выбора режимов отображения страниц отчета. По умолчанию, установлено значение true.

showDesignButton

Включает отображение кнопки Дизайн (Design) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение false.

showAboutButton

Предоставляет возможность отображать или не отображать кнопку О программе (About) на панели инструментов. По умолчанию, установлено значение true.

showPinToolbarButton

Предоставляет возможность отображать или не отображать кнопку Закрепить (Pin) в мобильном режиме просмотра отчета. По умолчанию, установлено значение true.

printDestination

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

•StiPrintDestination::Default – будет отображено меню с предоставлением выбора режима печати (значение по умолчанию);
•StiPrintDestination::Pdf – печать будет осуществлена в формате PDF;
•StiPrintDestination::Direct – печать будет осуществлена в формате HTML непосредственно на принтер, будет отображен системный диалог печати;
•StiPrintDestination::PopupWindow – печать будет осуществлена в формате HTML через всплывающее окно предварительного просмотра отчета.

viewMode

Устанавливает режим отображения страниц отчета:

•StiWebViewMode::OnePage – отображается одна страница, выбранная на панели инструментов (значение по умолчанию);
•StiWebViewMode::Stimulsoft.Viewer.StiWebViewMode.Continuous – отображаются все страницы отчета в виде ленты;
•StiWebViewMode::Stimulsoft.Viewer.StiWebViewMode.MultiplePages – отображаются все страницы отчета в виде таблицы.

zoom

Предоставляет возможность установить масштаб страниц отчета при загрузке вьювера. По умолчанию, установлено значение 100 процентов. Максимальное значение 500 процентов. Дополнительно, можно установить одно из следующих значений для масштаба:

•StiZoomMode::PageWidth – масштаб страниц отчета по ширине страницы.
•StiZoomMode::PageHeight – масштаб страниц отчета по высоте страницы.

menuAnimation

Предоставляет возможность включить или выключить анимацию отображения и закрытия различных меню во вьювере. По умолчанию, установлено значение true.

showMenuMode

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

•StiShowMenuMode::Click – режим раскрытия меню по щелчку (значение по умолчанию);
•StiShowMenuMode::Hover – режим раскрытия меню при наведении курсора.

autoHide

Устанавливает режим автоматического сворачивания панели инструментов при просмотре отчета в мобильном режиме. По умолчанию, установлено значение false.

 

 

Экспорт (Exports)

 

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

Описание

storeExportSettings

Предоставляет возможность сохранять настройки экспорта в cookies. По умолчанию, установлено значение true.

showExportDialog

Предоставляет возможность отображать или не отображать меню настроек экспорта. Если меню спрятано, экспорт будет выполнен со значениями по умолчанию. По умолчанию, установлено значение true.

showExportToDocument

Предоставляет возможность отображать или не отображать элемент Document File в меню Сохранить (Save). По умолчанию, установлено значение true.

showExportToPdf

Включает отображение пункта меню экспорта Adobe PDF файл (Adobe PDF File) при просмотре отчетов, и пункт Adobe PDF при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

showExportToXps

Включает отображение пункта меню экспорта XPS файл (XPS File). По умолчанию свойство имеет значение true.

showExportToPowerPoint

Включает отображение пункта меню экспорта Microsoft PowerPoint 2007/2010 файл (Microsoft PowerPoint 2007/2010 File). По умолчанию свойство имеет значение true.

showExportToHtml

Предоставляет возможность отображать или не отображать элемент HTML File в меню Настройки экспорта (Export Settings). По умолчанию, установлено значение true.

showExportToHtml5

Предоставляет возможность отображать или не отображать элемент HTML5 File в меню Настройки экспорта (Export Settings). По умолчанию, установлено значение true.

showExportToText

Включает отображение пункта меню экспорта Text файл (Text File). По умолчанию свойство имеет значение true.

showExportToWord

Предоставляет возможность отображать или не отображать элемент Microsoft Word 2007/2010 File в меню Сохранить (Save). По умолчанию, установлено значение true.

showExportToOpenDocumentWriter

Включает отображение пункта меню экспорта OpenDocument Writer файл (OpenDocument Writer File). По умолчанию свойство имеет значение true.

showExportToExcel

Включает отображение пункта меню экспорта Microsoft Excel 2007/2010 файл (Microsoft Excel 2007/2010 File) при просмотре отчетов, и пункт Microsoft Excel при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

showExportToOpenDocumentCalc

Включает отображение пункта меню экспорта OpenDocument Calc файл (OpenDocument Calc File). По умолчанию свойство имеет значение true.

showExportToCsv

Включает отображение пункта меню экспорта CSV файл (CSV File). По умолчанию свойство имеет значение true.

showExportToJson

Включает отображение пункта меню экспорта JSON файл (JSON File). По умолчанию свойство имеет значение false.

showExportToImageSvg

Включает отображение пункта меню экспорта Изображение (Image), с возможность экспорта отчета в SVG файл. По умолчанию свойство имеет значение true.

 

 

Отправить по Email (Email)

 

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

Описание

showEmailDialog

Включает отображение диалогового окна параметров отправки отчета по Email. Если диалоговое окно отключено, то отправка по Email будет производиться с настройками, заданными по умолчанию onEmailReport. По умолчанию, установлено значение true.

showExportDialog

Включает отображение диалогового окна параметров экспорта при отправке Email. Если свойство имеет значение false, то экспортирование будет производиться с заданными по умолчанию настройками. По умолчанию, установлено значение true.

defaultEmailAddress

Устанавливает Email получателя по умолчанию, т.е. адрес на который будет отправлено письмо с вложенным отчетом. По умолчанию, значение не задано.

defaultEmailSubject

Устанавливает тему (заголовок) электронного письма по умолчанию. По умолчанию, значение не задано.

defaultEmailMessage

Устанавливает сообщение (текст) электронного письма по умолчанию. По умолчанию, значение не задано.