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

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

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

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

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

Компоненты

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

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

views
  top.js
  chart
     index.js
   ...

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

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

В моделях Gantt описана логика для загрузки, хранения и кэширования данных, скачивания файлов, визуализации прогресса операций сохранения и др. В Webix Jet модели называются сервисами.

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

models
  Backend.js
  Local.js
  Operations.js
  Helpers.js
  Grouping.js

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

$$("gantt").getService("operations").addTask(obj);

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

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

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

class CustomTree extends gantt.views.tree {
  config(){
    // получаем JSON объект с конфигурацией
    const ui = super.config();
    // изменения конкретного компонента
    ui.width = 200;
    return ui;
  }
  init() {
    // вызываем логику по умолчанию 
    super.init();
    // а это уже пользовательский метод
    this.doSomething();
  }
  doSomething(){
    // делаем что-то при инициализации
  }
}

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

webix.ui({
    view: "gantt",
    url:"https://docs.webix.com/gantt-backend/",
    override: new Map([
      [gantt.views.tree, CustomTree]
    ])
});

Добавляем столбец в дерево задач

Чтобы добавить дополнительный столбец в дерево задач, вам необходимо изменить его конфигурацию:

class CustomTree extends gantt.views.tree {
  config() {
    const compact = this.getParam("compact", true);
    const ui = super.config();
 
    // добавляем столбце для прогресса
    ui.columns.splice(compact ? 3 : 2, 0, {
      id: "progress",
      header: "~",
      template: "#progress#%",
      width: 40
    });
 
    if (!compact) ui.width += 40;
 
    return ui;
  }
}

Related sample:  Gantt: Adding an Extra Column

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

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

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

class CustomInfo extends gantt.views["task/info"] {
  init(view) {
    // логика по умолчанию 
    super.init(view);
    // прячем кнопку "Delete"
    view.queryView("button", "all")[1].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 gantt.services.backend {
  tasks(){
    // клиентские данные
    return webix.promise.resolve(tasks);
  }
}

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

webix.ui({
    view: "gantt",
    url:"https://docs.webix.com/gantt-backend/",
    override: new Map([
      [gantt.services.backend, MyBackend]
    ])
});

Related sample:  Gantt: Local Data

Больше информации о сервисе Backend в Gantt читайте в этой статье.

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

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

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

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

Наверх