LabKey's JavaScript client library makes it easy to write custom pages and utilities on LabKey Server. A few examples of ways you might use the JavaScript API to access and/or update data:

• Add JavaScript to a LabKey HTML page to create a custom renderer for your data, transforming and presenting the data to match your vision.
• Upload an externally-authored HTML page that uses rich UI elements such as editable grids, dynamically trees, and special purpose data entry controls for LabKey Server tables.
• Create a series of HTML/JavaScript pages that provide a custom workflow packaged as a module.

JavaScript API

The JavaScript API has evolved and expanded to provide new functionality related to endpoints and Domain operations. The latest version of the TypeScript-based API is available here:

• Installation
• JavaScript API Reference

Original JS API

In addition, the original JS API can still be used for the operations not included in the newer version, including classes that concern the DOM and user interface. Some examples are:

• LABKEY.QueryWebPart
• LABKEY.DataRegion
• LABKEY.FileSystem.WebdavFileSystem
• Click for the full listing of classes in the original API

To access any original API classes from a TypeScript client, add one of the following at the top of a .tsx file (just under the imports), then use the LABKEY namespace as usual.

• If using TypeScript, use:

  declare const LABKEY: any;

• Otherwise, use:

  declare const LABKEY;

Topics

• API Resources
• Tutorial: Create Applications with the JavaScript API
• Tutorial: Use URLs to Pass Data and Filter Grids
• Tutorial: Hello World Module - Create a simple file-based module.
• JavaScript API Examples
• JavaScript Reports
• Export Data Grid as a Script
• Tutorial: Visualizations in JavaScript
• Custom Button Bars
• Insert into Audit Table via API
• Declare Dependencies
• Using ExtJS with LabKey
• Naming & Documenting JavaScript APIs

Additional Resources:

• Recommended JavaScript Textbook
• Mozilla JavaScript Guide
• Example HTML/JS Application