Active Query Builder support area

AQB.Web namespace

The main Active Query Builder namespace.

Modules

Name	Description
Enum	Different enumerations, such as DataSourceType, AffectedColumns and so on.
Dto	Data transfer model constructors to exchange data between server and client.
Core	The module to work with the internal query object model and the events which fired on model changes.
UI	The module to work with the client controls.

Properties

theme

Allows the definition of a custom styling scheme. Styles will be applied to all HTML elements constituting the component's UI.

Following fields accept a space-separated list of CSS class names to be applied to appropriate HTML elements:

widget
header
content
button
buttonEnabled
buttonDisabled
active
hover
cornerAll
cornerTop
cornerBottom

host

Redirects requests to Active Query Builder handlers to a different host.

Note that you must allow cross-origin queries in your application. See the "CrossOrigin" demo project for details.

virtualDirectory

Redirects requests to Active Query Builder handlers to the custom path in the case of a custom routing table.

You must specify it manually running the component in the client-side rendering mode.

In the case of server-side rendering, Active Query Builder automatically detects IIS virtual directory in a Classic ASP.NET MVC or WebForms app and configures the client accordingly, but it can't detect it in the ASP.NET Core. In this case, you can specify it server-side to the BaseHandler.VirtualDirectory property instead.

useRelativePaths

Bool. Treats paths to the Active Query Builder handler and the necessary resources as relative to the current web page location. I.e. adds "./" to all URLs.

Note: Setting this property to True negates the settings of the host and virtualDirectory properties.

In the case of server-side rendering, use the BaseHandler.UseRelativePaths property instead.

Methods

dispose

Frees all allocated resources and deletes the AQB namespace. The only way to re-initialize AQB after that is to re-load the script.

If you want to free a specific QueryBuilder client instance and/or free the associated server resources, use the AQB.Web.QueryBuilder.dispose method described below.

onQueryBuilderReady

Allows subscribing to the QueryBuilder events. It is called after the first data exchange with the server.

Updating the list of query columns on changing the query in the QueryBuilder

AQB.Web.onQueryBuilderReady(function (qb) {
    qb.on(qb.Events.SqlChanged, function () {
        AQB.Web.CriteriaBuilder.loadColumns();
    });
});

onCriteriaBuilderReady

Allows subscribing to the CriteriaBuilder events.

Loading query columns on the CriteriaBuilder initialization

AQB.Web.onCriteriaBuilderReady(function (cb) {
    cb.loadColumns();
});

beforeSend

Allows pre-processing of requests to Active Query Builder handlers.

It might be needed to organize token-based client authentication in the case of making cross-domain requests.

Objects

QueryBuilder

The main object in which all other visual query building controls exist.

CriteriaBuilder

The control which allows applying additional filters to the query. Usually used as a part of the data browsing interface.

AQB.Web.QueryBuilder object

Properties:

Name	Description
SessionID	Session identifier
SQL	Full text of the query.
activeSubQuerySQL	Text of the currently active sub-query.
activeUnionSubQuerySQL	Text of the currently active single SELECT statement.
clientSQL	Text in the SQL editor.
lastGoodSQL	Text of the last successfully parsed query from the SQL editor. Used to revert user changes on parsing error.
SQLError	SQL parsing error. Hold the error description and position.
SyntaxProviderName	Name of the syntax provider being used.
SyntaxProviderData	Information about the peculiarities of the syntax provider being used.
QueryStructure	Tree of sub-queries of the query.
disableSessionKeeper	Prescribes to ping or not to ping the server to avoid HTTP session expiration.
Events	List of available events. Subscription to the QueryBuilder events is possible in the AQB.Web.onQueryBuilderReady method using the AQB.Web.QueryBuilder.on method.

User interface components:

GridComponent
NavBarComponent
CanvasComponent
TreeViewComponent
StatusBarComponent
UserQueriesComponent
EditorComponent

Each of the aforementioned components has the element property. This is a reference to a jQuery object. With this object you can perform any manipulations with the DOM elements constituting the component, particularly:

change size
remove/add classes
relocate element on the page
hide
use other libraries to change their behavior, i.e. make it resizable, draggable, etc.

You can find the example of such usage in this article: How to make resizable, change the layout of controls on the web page?.

Events:

SQLUpdated

Fired on changing the query in the visual UI.

SQLError

Fired on SQL parsing error.

OnError

Fired on notifying the user about an internal error.

SQLTextChanged

Fired on changing the query text in the SQL text editor.

RefreshSQLClick

Fired on user click the Refresh button in the SQL text editor.

SessionExpired

Fired when the server refuses the client request due to the session expiration. Automatic session restoring is initiated then.

ActiveUnionSubQueryChanging

Occurs when the user issues a command to change the currently active Union Sub-Query (the SELECT statement displayed on the Canvas)

ActiveUnionSubQueryChanged

Occurs when the currently active Union Sub-Query (the displayed SELECT statement) has just been changed.

DataSourceAdding

Fired when the user commands to add a new datasource (database object, derived table, named sub-query from CTE, reusable query) to the Canvas.