LocusZoom.js Documentation

Quickstart

The README file provided with LocusZoom.js provides a quick introduction and overview of how to get started.

Guides

Guides provide help with specific tasks, organized around frequently asked questions. These are intended to be used by people who want to customize LocusZoom.js beyond the built-in layouts, with pointers to more exhaustive developer documentation where needed.

• Introduction to LocusZoom.js (see Getting Started)
• How to load data (see: Working with data)
• How to render the data (see: Layouts and visualization options)
• Advanced interactive features (see: Mechanisms for Interactivity)

Detailed Documentation

• UMich PortalDev REST API docs - Describes the field name and format conventions used by the UMich PortalDev API. This is the data format that the builtin LocusZoom data adapters and layouts were originally designed to work with.
• LocusZoom.js code internals - A (mostly) exhaustive list of all configuration options, events, template rules, and available plugin features. Describes the meaning of each option in the nested layout object syntax used to create and customize LocusZoom.js. We recommend starting with the built-in layouts and guides first, to get a sense of how the pieces are connected.