Customizing Query

Query 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.

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

Views

The interface of Query 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
    actions.js
    bar.js
    filter.js
    ...

Models/Services

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

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

models
  Backend.js

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

$$('query').getService('backend').data(field);

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 query.views.JetView:

class CustomBar extends query.views.bar {
    config() {
        //get JSON object with configuration
        const ui = super.config();
        //exact changes depend on a particular view
        ui.height = 200;
 
        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: 'query',
    override: new Map([[query.views.bar, CustomBar]]),
    // other properties
});

To add a new button into the Bar, you need to change its JSON configuration:

class CustomBar extends query.views.bar {
    config() {
        // default logic
        const ui = super.config();
 
        // add new button
        ui.cols.push({
            view: 'button',
            value: 'Clear',
            width: 70,
            // clear value upon clicking the button
            click: () => {
                this.getParam('state').value = null;
            },
        });
 
        return ui;
    }
}

Related sample:  Query: Adding a Button

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 query.views.base {
    init(view) {
        // default logic
        super.init();
        // hide "Add filter" button
        view.queryView('button').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 "button" localId
    const button = this.$$("button");
}

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");

Query is flexible: you can change almost anything in it. However, keep in mind the following:

• The inner logic of Query 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.