Введение

Создание отчетов и дашбордов – это не только визуализация данных, но также обработка и анализ сложных выражений с использованием колонок данных и функций. Например, выражения часто повторяются в различных местах, и, если нужно внести изменения, приходится редактировать эти выражения в нескольких местах, что увеличивает риск ошибок и, соответственно, время их редактирования.

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

Как это работает?

Функции создаются в словаре данных отчета. Их можно настроить, добавив описание, категорию, возвращаемое значение и аргументы. Функции можно описать с использованием визуального средства программирования Blockly или на одном из языков программирования: JS, C#, VB.NET:

• Blockly – визуальный инструмент программирования, не требующий написания кода.


• Скриптовые языки – языки программирования, такие как JS, C# или VB.NET, которые используются в отчете.

Преимущества пользовательских функций

1. Удобство создания сценариев без кода

• Визуальный интерфейс Blockly позволяет создавать сценарии без необходимости написания кода.


• Универсальность сценариев Blockly обеспечивает совместимость функций с любой платформой Stimulsoft.

2. Повторное использование

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

3. Легкость изменения выражения

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

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

• Режим вычислений: В .NET и .NET Framework выполнение функции доступно только в режиме компиляции. Более подробно об этом можно узнать в данной статье. Для .NET и .NET Framework можно выбрать скриптовый язык C# или VB.NET, на котором будет выполняться описание функции. Для других платформ (JS, PHP, Python) важен доступ к событиям, выполняющим описание функции.


• Параметры доступа: Убедитесь, что настройки к компиляции или интерпретации включены, иначе функции работать не будут.


• Script language choice: Функции работают на том языке, который указан в свойствах отчета (например, JS, C#, VB.NET).

Настройка функции

Функции настраиваются в редакторе, ниже подробно рассмотрим его опции. Для начала нужно открыть редактор – для этого в словаре данных в меню Создать (New) необходимо выбрать команду Новая функция (New Function) и определить ее параметры.

• Наименование функции (Name): Все обращения к функции осуществляются по её наименованию, которое можно указать в этом поле.


• Описание функции (Description): Позволяет добавить дополнительную информацию о функции, которая отображается на панели описаний в словаре данных.


• Категория функции (Category): Предоставляет возможность определить, в какую категорию словаря данных будет добавлена функция. Вы можете выбрать одну из предустановленных категорий или установить значение По выбору (Custom). При установке По выбору появится поле для создания пользовательской категории.


• Пользовательская категория (Custom Category): Если выбран параметр По выбору (Custom), вы можете указать название новой категории. Если поле останется пустым, функция будет помещена в корневую категорию Функции (Functions).


• Тип возвращаемого значения (Return Type): Указывает тип данных, который возвращает функция.


• Добавление аргументов функции: С помощью кнопки Добавить (Add) можно добавить до 10 аргументов. Для каждого аргумента настраиваются:
  
  
  1. Тип аргумента (Argument Type): Устанавливает тип данных аргумента.
  
  
  2. Наименование аргумента (Argument Name): Имя аргумента, используемое для обращения к нему в коде.


• Режим сценария (Script Mode): Предоставляет выбор между двумя способами реализации:
  
  
  1. Блоки (Blocks): Использование визуального конструктора Blockly, универсального для всех платформ Stimulsoft.
  
  
  2. Код (Code): Написание функции с использованием кода одного из скриптовых языков отчета (JS, C#, VB.NET).

Заключение

Пользовательские функции — это опция, которая помогает упростить переиспользование сложных выражений, сократить время на разработку и минимизировать ошибки. Создание сценариев функций при помощи Blockly делает процесс доступным и простым, а также обеспечивает возможность интеграции на всех платформах Stimulsoft. Рекомендуем применять пользовательские функции, чтобы ускорить работу по созданию отчетов и дашбордов, повысить точность расчетов и сделать документы более простыми с точки зрения их изменения.