Кастомизация 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();
 
        // adding new column for progress
        ui.columns.splice(compact ? 3 : 2, 0, {
            id: 'progress',
            header: '~',
            template: '#progress#%',
            width: 40,
        });
 
        return ui;
    }
}

Related sample:  Gantt: Adding an Extra Column

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

Скрытие компонентов

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

class CustomInfo extends gantt.views["task/info"] {
  init(view) {
    // логика по умолчанию 
    super.init(view);
    // прячем кнопку "Delete"
    view.queryView("button", "all")[1].hide();
  }
}

Доступ к экземплярам компонентов

Внутри Jet-компонента получить экземпляр компонента можно двумя способами.

Метод $$(id) у JetView работает для внутреннего компонента, у которого задана настройка localId:

init() {
    // исходная логика
    super.init();
    // получаем экземпляр компонента с localId = "form"
    const form = this.$$("form");
}

Если localId не задан, используйте queryView:

init(view) {
    // исходная логика
    super.init();
    // получаем экземпляр первой кнопки 
    const button = view.queryView("button");
}

Проверка компактного режима

Определить, в компактном ли режиме находится приложение, можно из любого компонента или сервиса:

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

Получение свойств состояния

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

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 может меняться в последующих релизах.
• Мы сделаем всё, чтобы оставить сигнатуры методов без изменений, но в случае необходимости возможны критические изменения.

Наверх