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

 

Пример изменения некоторых настроек дизайнера:

 

app.py

 

from flask import Flask, request

from stimulsoft_reports.designer import StiDesigner

from stimulsoft_reports.designer.enums import StiReportUnitType, StiDesignerTheme

 

@app.route('/designer', methods = ['GET', 'POST'])

def designer():

   designer = StiDesigner()

   designer.options.appearance.theme = StiDesignerTheme.OFFICE_2022_DARKGRAY_BLUE

   designer.options.appearance.defaultUnit = StiReportUnitType.CENTIMETERS

   designer.options.appearance.showReportTree = False

   designer.options.appearance.showTooltips = False

   designer.options.bands.showChildBand = False

   designer.options.components.showPanel = False

   designer.options.toolbar.showFileMenuExit = False

   designer.options.toolbar.showFileMenuOptions = False

 

  if designer.processRequest(request):

      return designer.getFrameworkResponse()

 

  # Here is the code for working with the report

 

  return designer.getFrameworkResponse()

 

 

 

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

 

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

Описание

width

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

height

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

localization

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

 

 

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

 

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

Описание

theme

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

iconSet

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

 

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

defaultUnit

Устанавливает единицы измерения размеров для отчета и всех его компонентов:

•StiReportUnitType.CENTIMETERS (значение по уомлчанию);
•StiReportUnitType.HUNDREDTHS_OF_INCH;
•StiReportUnitType.INCHES;
•StiReportUnitType.MILLIMETERS.

zoom

Задает масштаб отображения страниц отчета. По умолчанию установлен масштаб 100 процентов. Допускаются значения от 10 до 200 процентов. Может принимать одно из указанных ниже значений перечисления StiZoomMode:

 

•StiZoomMode.PAGE_WIDTH – масштаб страниц отчета по ширине страницы;
•StiZoomMode.PAGE_HEIGHT – масштаб страниц отчета по высоте страницы.

interfaceType

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

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

showAnimation

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

showSaveDialog

Включает отображение диалога ввода имени отчета при его сохранении. Имя отчета будет передано в параметрах дизайнера. По умолчанию свойство имеет значение True.

showTooltips

Включает отображение подсказок для элементов управления дизайнера при наведении мыши. По умолчанию свойство имеет значение True.

showTooltipsHelp

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

showDialogsHelp

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

fullScreenMode

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

maximizeAfterCreating

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

showLocalization

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

allowChangeWindowTitle

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

showPropertiesGrid

Включает отображение панели свойств в дизайнере отчетов. По умолчанию свойство имеет значение True.

showReportTree

Включает отображение дерева компонентов отчета. По умолчанию свойство имеет значение True.

propertiesGridPosition

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

•StiPropertiesGridPosition.LEFT – панель свойств будет отображаться слева (значение по умолчанию);
•StiPropertiesGridPosition.RIGHT  – панель свойств будет отображаться справа.

showSystemFonts

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

datePickerFirstDayOfWeek

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

•StiFirstDayOfWeek.AUTO - Будет установлен понедельник или воскресенье как первый день недели, в зависимости от культуры браузера (значение по умолчанию);
•StiFirstDayOfWeek.MONDAY - Понедельник будет установлен как первый день недели;
•StiFirstDayOfWeek.SUNDAY - Воскресенье будет установлен как первый день недели.

undoMaxLevel

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

wizardTypeRunningAfterLoad

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

•StiWizardType.NONE - дизайнер отчетов будет запущен без вызова мастера создания отчета (значение по умолчанию);
•StiWizardType.STANDARD_REPORT - дизайнер отчетов будет запущен с вызовом стандартного мастера создания отчета;
•StiWizardType.MASTER_DETAIL_REPORT - дизайнер отчетов будет запущен с вызовом master-detail мастера создания отчета;
•StiWizardType.LABEL_REPORT - дизайнер отчетов будет запущен с вызовом мастера создания отчета с этикетками;
•StiWizardType.INVOICES_REPORT - дизайнер отчетов будет запущен с вызовом мастера создания инвойса;
•StiWizardType.ORDERS_REPORT - дизайнер отчетов будет запущен с вызовом мастера создания ордера;
•StiWizardType.QUOTATION_REPORT - дизайнер отчетов будет запущен с вызовом мастера создания квоты.

allowWordWrapTextEditors

Включает или выключает перенос строк в редакторах текста в дизайнере. По умолчанию свойство имеет значение True.

 

 

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

 

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

Описание

visible

Включает отображение панели инструментов в дизайнере отчетов. По умолчанию свойство имеет значение True.

showPreviewButton

Включает или выключает отображение кнопки Просмотр (Preview) на панели инструментов дизайнера. По умолчанию свойство имеет значение True.

showSaveButton

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

showAboutButton

Включает отображение кнопки О программе (About) на панели инструментов дизайнера. По умолчанию свойство имеет значение False.

showFileMenu

Включает отображение главного меню дизайнера отчетов. По умолчанию свойство имеет значение True.

showFileMenuNew

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

showFileMenuOpen

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

showFileMenuSave

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

showFileMenuSaveAs

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

showFileMenuClose

Включает отображение пункта главного меню Закрыть (Close). По умолчанию свойство имеет значение True.

showFileMenuExit

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

showFileMenuReportSetup

Включает отображение пункта главного меню Свойства отчета (Report Setup). По умолчанию свойство имеет значение True.

showFileMenuOptions

Включает отображение пункта главного меню Параметры (Options). По умолчанию свойство имеет значение True.

showFileMenuInfo

Включает отображение пункта главного меню Сведения (Info). По умолчанию свойство имеет значение True.

showFileMenuAbout

Включает отображение пункта главного меню О программе (About). По умолчанию свойство имеет значение True.

showFileMenuNewReport

Включает или выключает отображение пункта главного меню Новая страница (New Page). По умолчанию свойство имеет значение True.

showFileMenuNewDashboard

Включает или выключает отображение пункта главного меню Новая панель индикаторов (New Dashboard). По умолчанию свойство имеет значение True.

showSetupToolboxButton

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

showNewPageButton

Включает или выключает отображение кнопки Новая страница (New Page) на панели инструментов. По умолчанию свойство имеет значение True.

showNewDashboardButton

Включает или выключает отображение кнопки Новая панель индикаторов (New Dashboard) на панели инструментов. По умолчанию свойство имеет значение True.

 

 

Секции (Bands)

 

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

Описание

showReportTitleBand

Включает отображение секции Заголовок отчета (Report Title) в списке меню Секции. По умолчанию свойство имеет значение True.

showReportSummaryBand

Включает отображение секции Итог отчета (Report Summary) в списке меню Секции. По умолчанию свойство имеет значение True.

showPageHeaderBand

Включает отображение секции Заголовок страницы (Page Header) в списке меню Секции. По умолчанию свойство имеет значение True.

showPageFooterBand

Включает отображение секции Итог страницы (Page Footer) в списке меню Секции. По умолчанию свойство имеет значение True.

showGroupHeaderBand

Включает отображение секции Заголовок группы (Group Header) в списке меню Секции. По умолчанию свойство имеет значение True.

showGroupFooterBand

Включает отображение секции Итог группы (Group Footer) в списке меню Секции. По умолчанию свойство имеет значение True.

showHeaderBand

Включает отображение секции Заголовок данных (Header) в списке меню Секции. По умолчанию свойство имеет значение True.

showFooterBand

Включает отображение секции Итог данных (Footer) в списке меню Секции. По умолчанию свойство имеет значение True.

showColumnHeaderBand

Включает отображение секции Заголовок колонки (Column Header) в списке меню Секции. По умолчанию свойство имеет значение True.

showColumnFooterBand

Включает отображение секции Итог колонки (Column Footer) в списке меню Секции. По умолчанию свойство имеет значение True.

showDataBand

Включает отображение секции Данные (Data) в списке меню Секции. По умолчанию свойство имеет значение True.

showHierarchicalBand

Включает отображение секции Дерево (Hierarchical) в списке меню Секции. По умолчанию свойство имеет значение True.

showChildBand

Включает отображение секции Подчиненный (Child) в списке меню Секции. По умолчанию свойство имеет значение True.

showEmptyBand

Включает отображение секции Пустые данные (Empty) в списке меню Секции. По умолчанию свойство имеет значение True.

showOverlayBand

Включает отображение секции Водяной знак (Overlay) в списке меню Секции. По умолчанию свойство имеет значение True.

showTable

Включает отображение компонента Таблица (Table) в списке меню Секции. По умолчанию свойство имеет значение True.

showTableOfContents

Включает или выключает отображение компонента Оглавление (Table of Contents) в списке меню Секции. По умолчанию свойство имеет значение True.

 

 

Кросс секции (Cross-Bands)

 

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

Описание

showCrossTab

Включает отображение компонента Кросс-таблица (Cross-Tab) в списке меню Кросс. По умолчанию свойство имеет значение True.

showCrossGroupHeaderBand

Включает отображение секции Кросс-заголовок группы (Cross Group Header) в списке меню Кросс. По умолчанию свойство имеет значение True.

showCrossGroupFooterBand

Включает отображение секции Кросс-итог группы (Cross Group Footer) в списке меню Кросс. По умолчанию свойство имеет значение True.

showCrossHeaderBand

Включает отображение секции Кросс-заголовок данных (Cross Header) в списке меню Кросс. По умолчанию свойство имеет значение True.

showCrossFooterBand

Включает отображение секции Кросс-итог данных (Cross Footer) в списке меню Кросс. По умолчанию свойство имеет значение True.

showCrossDataBand

Включает отображение секции Кросс- данные (Cross Data)в списке меню Кросс. По умолчанию свойство имеет значение True.

 

 

Элементы дашборда (dashboardElements)

 

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

Описание

showTableElement

Включает отображение элемента панели индикаторов Таблица (Table) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showCardsElement

Включает отображение элемента панели индикаторов Карточки (Cards) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showChartElement

Включает отображение элемента панели индикаторов Диаграмма (Chart) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showGaugeElement

Включает отображение элемента панели индикаторов Измерительный прибор (Gauge) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showPivotTableElement

Включает отображение элемента панели индикаторов Сводная таблица (Pivot) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showIndicatorElement

Включает отображение элемента панели индикаторов Индикатор (Indicator) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showProgressElement

Включает отображение элемента панели индикаторов Прогресс (Progress) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showRegionMapElement

Включает отображение элемента панели индикаторов Региональная карта (Region Map) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showOnlineMapElement

Включает отображение элемента панели индикаторов Онлайн карта (Online Map) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showImageElement

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

showTextElement

Включает отображение элемента панели индикаторов Текст (Text) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showPanelElement

Включает отображение элемента панели индикаторов Панель (Panel) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showShapeElement

Включает отображение элемента панели индикаторов Геометрия (Shape) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showButtonElement

Включает отображение элемента панели индикаторов Кнопка (Button) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showListBoxElement

Включает отображение элемента панели индикаторов Список (ListBox) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showComboBoxElement

Включает отображение элемента панели индикаторов Выпадающий список (ComboBox) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showTreeViewElement

Включает отображение элемента панели индикаторов Иерархический список (TreeView) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showTreeViewBoxElement

Включает отображение элемента панели индикаторов Выпадающий иерархический список (TreeViewBox) на инструментарии или вкладке Вставить (Insert) в дизайнере. По умолчанию свойство имеет значение True.

showDatePickerElement

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

 

 

Компоненты (Components)

 

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

Описание

showText

Включает отображение компонента Текст (Text) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showTextInCells

Включает отображение компонента Текст в ячейках (Text in Cells) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showRichText

Включает отображение компонента Rich текст (Rich Text) в списке меню Компоненты. По умолчанию свойство имеет значение False.

showImage

Включает отображение компонента Картинка (Image) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showBarCode

Включает отображение компонента Штрих-код (Bar Code) на инструментарии или вкладке Вставить в дизайнере. По умолчанию свойство имеет значение True.

showShape

Включает отображение компонента Геометрия (Shape) на инструментарии или вкладке Вставить в дизайнере. По умолчанию свойство имеет значение True.

showPanel

Включает отображение компонента Панель (Panel) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showClone

Включает отображение компонента Клон (Clone) в списке меню Компоненты. По умолчанию свойство имеет значение False.

showCheckBox

Включает отображение компонента Флажок (Check Box) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showSubReport

Включает отображение компонента Вложенный отчет (Sub Report) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showZipCode

Включает отображение компонента Почтовый индекс (Zip Code) в списке меню Компоненты. По умолчанию свойство имеет значение False.

showChart

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

showGauge

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

showSparkline

Включает отображение компонента Спарклайн (Sparkline) в списке меню Компоненты. По умолчанию свойство имеет значение True.

showMathFormula

Включает или выключает отображение компонента Математическая формула (Math Formula) в списке меню Компоненты. По умолчанию свойство имеет значение False.

showMap

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

 

 

Словарь данных (Dictionary)

 

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

Описание

showAdaptersInNewConnectionForm

Включает отображение категории Объекты (Object) в окне создания нового соединения. По умолчанию свойство имеет значение True.

showDictionary

Включает отображение словаря данных отчета. По умолчанию свойство имеет значение True.

newReportDictionary

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

 

strel11 StiNewReportDictionary.AUTO - определяет режим создания или объединения словаря данных из сохраненного значения в файлах cookies (значение по умолчанию);

strel11 StiNewReportDictionary.DICTIONARY_NEW - устанавливает режим создания нового словаря данных, при создании нового отчета;

strel11 StiNewReportDictionary.DICTIONARY_MERGE - устанавливает режим объединения существующего словаря данных с новым, при создании нового отчета в дизайнере.

useAliases

Предоставляет возможность использовать псевдонимы в словаре данных. Может принимать одно из указанных ниже значений:
 
strel11 StiUseAliases.AUTO - определяет режим использования псевдонимов из сохраненного значения в файлах cookies (значение по умолчанию);

strel11 StiUseAliases.True - устанавливает режим использования псевдонимов в словаре данных;

strel11 StiUseAliases.False - выключает режим использования псевдонимов в словаре данных.

showDictionaryContextMenuProperties

Устанавливает видимость пункта Свойства (Properties) в контекстном меню словаря данных. По умолчанию свойство имеет значение True.

showDictionaryActions

Устанавливает отображение меню Действия (Actions) на панели инструментов словаря данных. По умолчанию свойство имеет значение True.

dataSourcesPermissions

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

dataConnectionsPermissions

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

dataColumnsPermissions

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

dataRelationsPermissions

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

businessObjectsPermissions

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

variablesPermissions

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

resourcesPermissions

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

dataTransformationsPermissions

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

 

 

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

 

Значение

Описание

StiDesignerPermissions.NONE

Запрещает любое действие над элементом словаря данных.

StiDesignerPermissions.CREATE

Разрешает создавать определенный элемент словаря данных.

StiDesignerPermissions.DELETE

Разрешает удалять определенный элемент словаря данных.

StiDesignerPermissions.MODIFY

Разрешает редактировать определенный элемент словаря данных.

StiDesignerPermissions.VIEW

Разрешает просматривать определенный элемент словаря данных.

StiDesignerPermissions.MODIFY_VIEW

Разрешает редактировать и просматривать определенный элемент словаря данных.

StiDesignerPermissions.ALL

Разрешает любые действия над элементом словаря данных (установлено по умолчанию для всех свойств, использующих данное перечисление).

 

 

Предусмотрена настройка встроенного компонента StiViewer, используемого для предварительного просмотра отчета. Для доступа ко всем его настройкам предназначено свойство viewerOptions, которое представляет собой объект опций вьювера. Все его свойства описаны в разделе Настройки вьювера. Например, требуется изменить режим отображения отчета и отключить ненужные форматы экспорта:

 

app.py

 

from flask import Flask, request

from stimulsoft_reports.designer import StiDesigner

from stimulsoft_reports.designer.enums import StiReportUnitType, StiDesignerTheme

 

@app.route('/designer', methods = ['GET', 'POST'])

def designer():

   designer = StiDesigner()

   designer.options.viewerOptions.exports.showExportToWord = False

   designer.options.viewerOptions.exports.showExportToCsv = False

 

  if designer.processRequest(request):

      return designer.getFrameworkResponse()

 

  # Here is the code for working with the report

 

  return designer.getFrameworkResponse()