adaptableblotter-react-aggrid

Adaptable Blotter React ag-Grid

Repository for the Adaptable Blotter React ag-Grid Wrapper.

This allows you to install, instantiate and reference the Adaptable Blotter using ag-Grid in a "React-friendly" manner.

Installation

To install Adaptable Blotter React ag-Grid via npm, run:

npm install adaptableblotter-react-aggrid

Usage

import AdaptableBlotterReact from 'adaptableblotter-react-aggrid';

import 'adaptableblotter-react-aggrid/base.css';
import 'adaptableblotter-react-aggrid/themes/light.css'

import 'ag-grid-community/dist/styles/ag-grid.css';
import 'ag-grid-community/dist/styles/ag-theme-balham.css';

const adaptableBlotterOptions: AdaptableBlotterOptions = {
  primaryKey: 'tradeId',
  userName: 'demo user',
  blotterId: 'react demo',
};

export default () => <AdaptableBlotterReact
  style={{ height: '100vh' }}
  gridOptions={ ... }
  blotterOptions={adaptableBlotterOptions}
  onBlotterReady={(blotterApi) => { ... }}
/>

Props

Mandatory:

• gridOptions: ag-Grid GridOptions object
• blotterOptions: AdaptableBlotterOptions object

Optional

• onBlotterReady: (blotterApi: IBlotterApi) - gives you access to the blotter api object
• render|children: ({ grid, blotter}) => ReactNode - can specify a custom render function that is called with the rendered grid and blotter, and can be used to change the layout of the component, and render additional elements or change blotter/grid order
• onThemeChanged: (blotter, arg: ThemeChangedEventArgs)
• onSearchChanged: (blotter, arg: SearchChangedEventArgs)
• onColumnStateChanged: (blotter, arg: ColumnStateChangedEventArgs)
• onAlertFired: (blotter, arg: AlertFiredEventArgs)
• onActionColumnClicked: (blotter, arg: ActionColumnClickedEventArgs)
• onSelectionChanged: (blotter, arg: SelectionChangedEventArgs)

Licences

The Adaptable Blotter is a commercial product and requires a purchased licence for use.

The Adaptable Blotter licence covers both AdaptableBlotter.NET and AdaptableBlotter.JS versions, and offers regular updates and full support.

If you wish to evaluate the Adaptable Blotter before purchase, please contact us requesting a Trial Licence.

Licences are sold to end-users typically in 'bands' so the price per user falls as volumne increases. There is also a Universal option which gives unlimited usage to unlimited users.

Note: The Adaptable Blotter licence does not include the licence for the underlying grid - if you use a vendor grid that requires a commerical licence, you must purchase that separately.

Please contact the Adaptable Tools Sales Team at [e-mail] for more information.

Demo

To see AdaptableBlotter.JS in action visit https://demo.adaptableblotter.com where you can see the Adaptable Blotter running againt a number of different dummy data sets using various underlying DataGrids.

Help

Further information about AdaptableBlotter.JS is available at www.adaptabletools.com. And there is detailed Help at https://adaptabletools.zendesk.com/hc/en-us.

Developers can see how to access the Adaptable Blotter programmatically at https://api.adaptableblotter.com

For all enquiries please email the Adaptable Tools Support Team at [e-mail].