Class Browser

Object
   |
   +--Browser

class Browser

This class is the main interface between JBrowse and embedders
Defined in Browser.js

Field Detail

dataRoot

Object dataRoot

deferredFunctions

Object deferredFunctions

names

Object names

tracks

Object tracks

Browser

Browser(params)

Construct a new Browser object.

Parameters:
params - a dictionary with the following keys:

• containerID - ID of the HTML element that contains the browser
• refSeqs - list of reference sequence information items (usually from refSeqs.js)
• trackData - list of track data items (usually from trackInfo.js)
• dataRoot - (optional) URL prefix for the data directory
• browserRoot - (optional) URL prefix for the browser code
• tracks - (optional) comma-delimited string containing initial list of tracks to view
• location - (optional) string describing the initial location
• defaultTracks - (optional) comma-delimited string containing initial list of tracks to view if there are no cookies and no "tracks" parameter
• defaultLocation - (optional) string describing the initial location if there are no cookies and no "location" parameter

addTracks

void addTracks(trackList, replace)

add new tracks to the track list

Parameters:
trackList - list of track information items
replace - true if this list of tracks should replace any existing tracks, false to merge with the existing list of tracks

navigateTo

void navigateTo(loc)

navigate to a given location

Parameters:
loc - can be either:
<chromosome>:<start> .. <end>
<start> .. <end>
<center base>
<feature name/ID>

showTracks

void showTracks(trackNameList)

load and display the given tracks

Parameters:
trackNameList - {String} comma-delimited string containing track names, each of which should correspond to the "label" element of the track information dictionaries

visibleRegion

String visibleRegion()

Returns:
string representation of the current location
(suitable for passing to navigateTo)

visibleTracks

String visibleTracks()

Returns:
containing comma-separated list of currently-viewed tracks
(suitable for passing to showTracks)