OXBOX Help

Виджеты

Модуль используется для вывода сводной информации, как правило по спискам (нативным или динамическим).

Модуль имеет следующую структуру:

{ type: "analytic_wdigets", size: number, settings: { filters: {...}, widgets_group: string, linked_filter?: string }, components: { filters: Array<{...}>, buttons: Array<{...}> } }
  • filters - инициализационные значения фильтров.

  • widgets_group - свойство command в запросе на получение списка виджетов.

  • linked_filter - свойство для фильтрации данных модуля на основе фильтрации в другом модуле. Используется при комбинации нескольких модулей в отображении одного типа информации.

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

{ value: string | number, description?: string, prefix?: string, postfix?: { value: string, icon?: string, background?: string }, detail?: { type: "char" | "details_char" | "progress_bar", ... }, size?: number }
  • value - основное значение виджета.

  • description - дополнительное описание для виджета.

  • prefix - спецсимвол перед значением виджета.

  • postfix - спецсимвол после значения виджета. Имеется возможность изменения базового фона, отображения икноки.

  • detail - объект настроек графической части виджета. Подробнее об этом ниже:

    • type - тип графической части виджета:

      • char - кривая данных.

      • details_char - аналог char, но с более детализированными плоскостями.

      • progress_bar - отображение прогресса в виде заполняемой шкалы.

  • size - размер виджета. Допустимые значения от 1 до 4.

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

{ type: "char" | "details_char", settings: { char: { x: Array<string>, lines: Array<{title: string, values: {...}}> }, value_title?: string } }
  • char - объект основных настроек линий:

    • x - горизонтальная ось, представленная в виде списка точек.

    • lines - список линий для графической части, каждая линия представлена в виде следующего объекта:

      • title - заголовок линии

      • values - объект, представляющий из себя значения для точек горизонтальной оси графической части модуля.

  • value_title - возможность настройки заголовка значений, отображаемого при наведении на точку горизонтальной оси.

{ type: "progress_bar", settings: { title: string, percent: number } }
  • title - заголовок над полосой прогресса.

  • percent - степень заполнения полосы прогресса.

15 мая 2025