Customizing Query

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

Jet App Nature and Class Map

Query is built as a Jet app. A Jet app is an application module that can be used standalone or as a Webix widget. Each Jet app is created as a class that extends the JetApp class. You can read more about JetApp and its API on these pages of Jet docs:

The interface of Query is split in parts. In code, this means that the app module is built from smaller modules called Jet views. One Jet view is one interface part. A Jet view is created as a class that extends the JetView class. You can read more about JetView and its API on these pages of Jet docs:

Jet Views in Query

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 Query without the need to change the source
  • you can reuse any module (a view or a service) of Query 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 CustomBar extends query.views.bar {
    /* 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 CustomBar extends query.views.bar {
    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: "query",
    override: new Map([[query.views.bar, CustomBar]]),
});

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 CustomBar extends query.views.bar {
    config(){
        // get the original ui
        const ui = super.config();
 
        // add a button that will be used to call the custom method
        ui.cols.push({
          view: "button",
          value: "Clear",
          width: 70,
          click: () => this.clearRules()
        });
 
        return ui;
    }
    // custom method
    clearRules() {
        this.getParam("state").value = null;
    }
}
webix.ui({
    view: "query",
    override: new Map([[query.views.bar, CustomBar]]),
});

Related sample:  Query: Custom View

Back to top