Customizing Scheduler

Scheduler is a complex widget created with Webix Jet, the MV* framework for Webix Library. It is a ready-to-use application with minimum configuration settings taht has API for redefining the logic of inner modules.

You will need to study the source code to customize views and models.

Jet App and Inner Modlues

Scheduler is built as a Jet App and wrapped into a Webix view, so you can initialize it in either of the ways.

Views

The interface of Scheduler is split into parts (views). Each view is a class that extends the JetView class and has own handlers for setting the configuration and logic.

The sources for interface parts (Jet Views) are located in the sources/views folder.

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

Go to the Class Map page to see the list of all Jet views in Scheduler and where they are in the interface.

Models/Services

Scheduler models contain the logic for working with scales and data. They are defined as Jet Services.

The sources for models (Jet Services) are located in the sources/models folder.

models
  LocalData.js
  Operations.js
  Backend.js

Service methods are called by the UI and can be called by a programmer as:

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

Customizing Views

  • you can override the config() method for changes in the UI
  • you can override the init() for changes in the UI and behavior
  • you can override any existing method but with a caution
  • you can add and call your own methods

Firstly, create you own view class and inherit it from one of the default views or from scheduler.views.JetView:

class CustomHours extends scheduler.views["modes/common/hourscale"] {
  config(){
    // get JSON object with configuration
    const ui = super.config();
    // exact changes depend on a particular view
    ui.width = 60;
    return ui;
  }
  init() {
    // call default logic
    super.init();
    // custom logic below
    this.doSomething();
  }
  doSomething(){
    // do something on init
  }
}

Secondly, replace the default view via the override map:

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

How to limit app tabs

To limit the tabs on a toolbar, you need to redefine options for the NavBarView. Keep in mind that tab IDs must coincide with the possible display modes.

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

You can find more use cases in the How-tos article.

Notes

1. We do not recommend to remove any component from the interface as the inner logic might still try accessing it. Instead, hide the components.

class CustomBar extends scheduler.views["bars/add"] {
  init(view) {
    // default logic
    super.init(view);
    // hide calendar from sidebar
    view.queryView("calendar").hide();
  }
}

2. You can access component instances within a Jet view by:

  • using the $$(id) method of JetView.

It works for an inner component that is assigned the localId setting.

init() {
    // default logic
    super.init();
    // get instance of the component with "form" localId
    const form = this.$$("form");
}
init(view) {
    // default logic
    super.init();
    // get instance of the first button
    const button = view.queryView("button");
}

3. You can find out whether the app is currently compact from any view or service method as:

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

4. You can get state properties from any view or service method as:

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

Customizing Jet Services

  • you can add and call your own methods
  • you can override any existing method but with a caution

Firstly, create you own service class and inherit it from one of the default services:

class MyBackend extends scheduler.services.backend {
  calendars(){
    // client-side data 
    return webix.promise.resolve(calendars);
  }
}

Secondly, replace the default service via the override map:

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

Related sample:  Scheduler: Local Data

Backward Compatibility

Scheduler is extremely flexible when it comes to customizations: you can change almost anything in it. However, keep in mind the following:

  • The inner logic of Scheduler modules may change in future releases.
  • We will try to maintain method signatures, but breaking changes might happen if they are necessary for further development of the widget.

Code for IE11 and Edge must be with different syntax.

Back to top