Customizing Scheduler

Scheduler is a complex widget created with Webix Jet, the MV* framework for Webix Library. It is a ready-to-use application that needs minimal configuration and has an API for redefining the logic of inner modules.

Jet App and Inner Modules

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

Views

The interface of Scheduler is split into parts (views). Each view is a class that extends the JetView class and has its 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
  ...

Models/Services

Scheduler models contain the logic for working with calendars and events. 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

The UI calls service methods, and you can call them yourself:

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

Customizing Views

When you customize a view, you can:

• override the config() method to change the UI
• override the init() method to change the UI and behavior
• override any existing method, but do it with caution
• add and call your own methods

Check the Class Map to find which view renders the part you want to modify.

First, create your own view class by inheriting 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
  }
}

Then, 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, 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

Notes

Hiding Components

We do not recommend removing 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();
    }
}

Accessing Component Instances

Within a Jet view, you can access component instances in two ways.

Use the $$(id) method of JetView for an inner component that has the localId setting:

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

Use queryView if localId is not defined:

init(view) {
    // default logic
    super.init();
    // get instance of the first button
    const button = view.queryView("button");
}

Checking the Compact Mode

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

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

Getting State Properties

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

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

Customizing Jet Services

When you customize a service, you can:

• add and call your own methods
• override any existing method, but do it with caution

First, create your 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);
    }
}

Then, 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 flexible: 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.

Back to top