Customizing Gantt

Gantt is a complex widget created with Webix Jet, the MV* framework for Webix Library.

Jet App Nature

Gantt is built as a Jet app. Each Jet app is created as a class that extends the JetApp class.
Read more about JetApp:

The interface of Gantt is split in parts. Each part is a module (class) that extends the JetView class.
Read more about JetView:

Jet Views in Gantt

You can go to this page to see the list of all Jet views and where they are in the interface.

Advantages of Jet-based Approach

  • you can customize any part of Gantt without the need to change the source
  • you can reuse any module (a view or a service) of Gantt in your apps
  • customization is simple due to OOP
  • customization allows you to keep the UI and the logic of components together

Code for IE11 and Edge must be with different syntax.

How to Customize Jet Views in Query

How to Make Changes to Views

First, you need to create you own view class and inherit it from one of the default views or from JetView:

class CustomTree extends gantt.views.tree {
    /* your logic that will override or extend the default one */
}

There are two JetView methods that you can safely override to customize views:

  • config() for changes in the UI,
  • init() for changes in the UI and behavior,
  • you can also add and call your own methods.
class CustomTree extends gantt.views.tree {
  init() {
    // default logic
  super.init();
    // custom logic below
    this.doSomething();
  }
  doSomething(){
    // do something on init
  }
}

Second, replace the default view with the new one:

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

Defining Custom Behavior

You can change the behavior of a view by adding methods to view classes. Follow these steps:

  1. Create a view class.
  2. Define the method.
  3. Call it.
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
    });
 
    if (!compact) ui.width += 40;
 
    return ui;
  }
}

Related sample:  Gantt: Custom View

Back to top