DataGridXL - API

API Reference

Welcome to the DataGridXL API reference. This guide is designed to help you get up and running quickly, while offering the depth you need to build advanced integrations.

Although DataGridXL is easy to get started with, it is also a complex and powerful grid engine. We assume you're comfortable with JavaScript and general front-end development. If you're looking for a place to begin, check out the interactive demos or usage examples.

What can you do with this API?

The API lets you fully control the grid via JavaScript. You can:

  • Configure the grid using flexible options
  • Control behavior using core methods
  • Listen to internal events via hooks
  • Integrate custom editors, menus, overlays, and renderers
  • Build your own advanced grid features

API Structure

This documentation is divided into several core areas:

Core

The core methods control the grid's primary behavior. You can use them to update config, change selection, scroll, insert data, and much more. See the Core API for a full overview.

Hooks

Hooks are custom events emitted by the grid. Use them to run your own code when the user edits a cell, scrolls, or triggers any grid lifecycle change. View all available hooks.

Configuration Options

All available configuration keys that you can pass to new DataGridXL(...) or update dynamically. Browse all options here.

Supporting Classes

DataGridXL includes several internal classes that you can use directly or extend:

You can find them grouped under sections like UI Helpers, Rendering, and Data Management.

Need help?

If you run into any issues or have questions about the API, feel free to contact support or check out our demos and guides.

---

Happy coding!