AdaptableBlotter.JS is a powerful, data-agnostic, HTML5 DataGrid add-on that provides you with a wide range of advanced tools for searching, filtering, sorting, styling, editing, exporting, analysing, validating and auditing your data. These will enable you to work more quickly, efficiently and productively.
This help contains the following sections:
Blotter Basics - this section on how to use the Blotter
Column Management Functions - functions like Calculated Columns, Column Information,Column Chooser, Column Category and Free Text Columns will help you to manage your columns and create 'special' columns.
Predefined Config - how to populate the Blotter with your own objects and preferences.
Blotter API - how to call Adaptable Blotter functions through code.
AdaptableBlotter.JS sits on top of an underlying DataGrid component and provides an extra layer of functionality that contains all the additional searching, editing, sorting, exporting and auditing functionality that advanced users have come to expect, and which is normally provided by in-house developers.
AdaptableBlotter.JS provides one set of screens irrespective of which underlying gird is used and one set of functionality, but a different internal implementation for each underlying grid.
AdaptableBlotter.JS does NOT provide any data, nor data adaptors. Its your job to populate the data however you wish and from whichever source you want (e.g. table, database, spreadsheet, streaming data etc), and likewise its your responsibility to take care of what happens to the data after its edited. The purpose of the Adaptable Blotter is to give you a superior and powerful experience of handling your data while its in front of you.
AdaptableBlotter.JS can be used in any industry or sector. Although the initial marketing was aimed at financial services, the data-agnostic nature of the blotter, means it can be used anywhere. And increasingly its being used by clients in legal, media, retail and other sectors.
AdaptableBlotter.JS runs in a browser but does not require internet access.
AdaptableBlotter.JS supports DataGrids from the leading vendors - both commercial and open-source - including Telerik Kendo, OpenFin Hypergrid and the ag-Grid. More supported grids are being included all the time. It additionally supports the Adaptable Grid, a grid control that we have developed to work closely with the Adaptable Blotter.
Each development team will decide which underlying grid to use for each deployment. Whichever grid is used the same Adaptable Blotter Objects (e.g. searches, filters, layouts etc) will be created, meaning that it is trivial to move from one underlying grid to another. These objects can be edited, saved and shared according to each user's Settings.
AdaptableBlotter.JS contains a number of Functions that are designed to help you to work more quickly and efficiently. Each function has its own screen to help you manage it, and many have associated Toolbars also. All functions can be accessed from the Dashboard .
AdaptableBlotter.JS allows you to create your own Adaptable Blotter Objects based on your data and requirements. For more information see Adaptable Blotter Objects. Many of these objects include powerful, custom cross-column Queries that you will create.
Additionally it includes powerful Filters to enable you to find your data easily.
We advise you to take some time to familiarise yourself with these as they will save you a lot of time.
AdaptableBlotter.JS provides a Dashboard which is used to display quick access buttons for frequently used functions and a series of toolbars.
You can choose which items are available in the dashboard area in the Dashboard function.
The Dashboard contains 2 elements:
Function Toolbars - small controls contains buttons and dropdowns relevant to a single function, often avoiding the need to access the function popup directly.
Home Toolbar - a 'specialised' toolbar on the left hand side of the dashboard. It includes the Functions Dropdown that contains an entry for each function and as many Function Buttons as you specify. Both open the popup for the relevant function when clicked. It also contains the Column Dropdown which lists all columns in the grid, an About button providing information about the Blotter, and the System Status button used for showing the health of the system / server.
By default the Home Toolbar title contains the value of the blotterID property. However you can set a different value via the Home Toolbar Title property of the Dashboard Config.
Unlike with Function Toolbars, the Home Toolbar cannot be closed.
To change which Function Toolbars and Function Buttons are displayed in the Dashboard, click the Configure Dashboard button which will open the Dashboard Configuration screen allowing you to hide, show and sort elements according to your precise requirements. For more information see Dashboard.
You can minimise the Dashboard at any time by clicking the Up chevron in Home Toolbar. This is particularly useful if screen estate is at a premium. Additionally you can hide the Dashboard altogether by selecting Hide Dashboard in the Column Header menu.
Many of the screens in the AdaptableBlotter.JS have context-sensitive help, where appropriate, displaying a blue information icon . If you hover the cursor over the icon, the help information appears in a pop-up dialog.