getState

возвращает объект реактивного состояния Report Manager

object getState();

Returns

objectобъект состояния

Example

// // возвращает текущее состояние Report Manager
const state = $$("myReports").getState();

Related samples

Details

Возвращаемый объект содержит следующие свойства и методы:

{
  mode: "edit",
  module: null,
  moduleId: 20,
  saved: true,
  readonly:false,
  toolbar: false 
}

Свойства

  • moduleId (string) - ID просматриваемого отчёта;
  • mode (string) - режим просмотра. Возможные значения:
    • "list" - список отчётов;
    • "view" - отчёт открыт, список "list" закрыт;
    • "edit" - открыта форма для редактирования отчёта;
  • toolbar (boolean) - если false прячет тулбар. По умолчанию true;
  • readonly (boolean) - переключает Report Manager в режим только для чтения. По умолчанию false;
  • module (object) - JSON с настройками отчёта (источники данных, столбцы, ...);
  • saved (boolean) - если true выбранный модуль сохранён. В случае false настройки отчёта изменены, но не сохранены.

Методы

  • $observe (function) - отслеживает изменения в текущем состоянии Report Manager. Принимает два параметра:
    • prop (string) - реактивное свойство, которое изменяется
    • handler (function) - функция для выполнения, когда изменения произошли. Принимает только один аргумент:
      • value (any) - текущее значение реактивного свойства. Тип значения (строка, массив, и т.д.) зависит от реактивного свойства.
  • batch (function)- позволяет изменять несколько свойств сразу. Принимает один параметр:
    • props (object) - объект, который содержит пары "имя свойства: значение".
Наверх