Кастомизация Scheduler

Scheduler это комплексный виджет, разработанный с помощью MV* фреймворка Webix Jet. Это готовое приложение с минимальной конфигурацией и специальным API для переопределения логики внутренних модулей.

Кастомизация компонентов и моделей подразумевает работу с исходным кодом.

Jet приложение и внутренние модули

Scheduler построен как Jet приложение в обёртке Webix компонента, поэтому вы можете инициализировать его любым из двух способов.

Компоненты

Интерфейс Scheduler разбит по частям (компонентам). Каждый компонент, это класс, который наследуется от класса JetView и имеет свои методы и конфигурацию.

Исходный код частей интерфейса (компонентов Jet) находится в папке sources/views.

views
  events
  bars
    nav.js
    date.js
  ...

На странице карты классов представлен список используемых компонентов, а также их расположение в интерфейсе.

Модели/Сервисы

В моделях Scheduler описана логика для работы с календарями и событиями. В Webix Jet модели называются сервисами.

Исходный код для моделей (сервисов Jet) находятся в папке sources/models.

models
  LocalData.js
  Operations.js
  Backend.js

Методы сервисов вызываются самим интерфейсом, но также могут быть вызваны программистом напрямую:

$$('scheduler').getService('operations').addCalendar(obj);

Кастомизация компонентов

  • вы можете переопределять метод config() для изменений в UI
  • вы можете переопределять метод init() для изменений в UI и поведении компонентов
  • вы можете переопределять любой метод, но с осторожностью
  • вы можете создавать и вызывать свои методы

Для начала создайте класс и наследуйте его от класса по умолчанию или от scheduler.views.JetView:

class CustomHours extends scheduler.views["modes/common/hourscale"] {
  config(){
    // получаем JSON объект с конфигурацией
    const ui = super.config();
    // изменения конкретного компонента
    ui.width = 60;
    return ui;
  }
  init() {
    // вызываем логику по умолчанию 
    super.init();
    // а это уже пользовательский метод
    this.doSomething();
  }
  doSomething(){
    // делаем что-то при инициализации
  }
}

Затем переопределите компонент (класс) по умолчанию с помощью свойства override:

webix.ui({
    view: 'scheduler',
    url: 'https://docs.webix.com/calendar-backend/',
    override: new Map([[scheduler.views['modes/common/hourscale'], CustomHours]]),
});

Как убрать режимы работы с панели

Чтобы убрать какие-либо вкладки (контролы для переключения режима работы) с верхнего тулбара, вам необходимо переопределить опции для NavBarView. Обратите внимание, что ID вкладок должны совпадать с названиями режимов работы.

class CustomBarsView extends scheduler.views['bars/nav'] {
    config() {
        const ui = super.config();
        ui.options = [
            { id: 'week', value: 'Week' },
            { id: 'month', value: 'Month' },
        ];
        return ui;
    }
}

Related sample:  Scheduler: Limited Tabs

Больше примеров кастомизации смотрите в практических руководствах.

Рекомендации

1. Мы не рекомендуем удалять компоненты из интерфейса, т.к. внутренняя логика может всё ещё обращаться к ним. Вы можете скрывать компоненты.

class CustomBar extends scheduler.views["bars/add"] {
  init(view) {
    // логика по умолчанию 
    super.init(view);
    // прячем календарь на боковой панели
    view.queryView("calendar").hide();
  }
}

2. Получить экземпляр компонента внутри Jet можно следующими способами:

  • с помощью метода $$(id) у JetView.

Метод работает для внутреннего компонента, у которого определён локальный ID (localId).

init() {
    // исходная логика
    super.init();
    // получаем экземпляр компонента с localId = "form"
    const form = this.$$("form");
}
  • с помощью queryView, если localId не определён.
init(view) {
    // исходная логика
    super.init();
    // получаем экземпляр первой кнопки 
    const button = view.queryView("button");
}

3. С помощью кода ниже можно определить, в компактном ли режиме приложение в данный момент:

const compact = this.getParam('compact', true);

Метод доступен из любого компонента или сервиса.

4. Чтобы получить текущее состояние приложения и его реактивные свойства воспользуйтесь одним из способов ниже:

const state = this.app.getState();
// или 
const state = this.getParam("state");

Метод доступен из любого компонента или сервиса.

Кастомизация сервисов Jet

  • вы можете добавлять и вызывать свои методы
  • вы можете переопределять любые существующие методы, но с осторожностью

Прежде всего создайте свой класс сервиса и наследуйте его от класса сервиса по умолчанию:

class MyBackend extends scheduler.services.backend {
  calendars(){
    // клиентские данные
    return webix.promise.resolve(calendars);
  }
}

Затем переопределите класс по умолчанию вашим с помощью свойства override:

webix.ui({
    view: 'scheduler',
    url: 'http://localhost:3200/',
    override: new Map([[scheduler.services.Backend, MyBackend]]),
});

Related sample:  Scheduler: Local Data

Обратная совместимость

Scheduler - это очень гибкий виджет в отношении кастомизаций: вы можете менять в нём практически всё, что угодно. Однако следует помнить о следующих моментах:

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

Обратите внимание, что у кода для IE11 и Edge должен быть другой синтаксис.

Наверх