locationBoxLength | The desired size, in characters of the location search box. If not set, the size of the location box is calculated to fit the largest location string that is likely to be produced, based on the length of the reference sequences and the length of their names. Added in JBrowse 1.7.0. |
css | Used to add additional CSS code to the browser at runtime. Can be an array of either strings containing CSS statements, or URLs for CSS stylesheets to load (as json:{url: "/path/to/my.css"}). CSS can of course also be added outside of JBrowse, at the level of the HTML page where JBrowse runs. Added in JBrowse 1.6.2. |
theme | Allows changing the graphical theme from the default Dijit "tundra" theme. Added in JBrowse 1.7.0. Intended primarily for use by plugin implementors or developers integrating JBrowse into a larger system. |
defaultTracks | Comma-separated list of track *labels* to show on initial load if a user has never visited this browser before. Example: "snps,genes,alignments". |
forceTracks | Comma-separated list of track *labels* to show on initial load, regardless of the user's saved settings, but which is overridden by the URL list. Example: "snps,genes,alignments". |
defaultLocation | Initial location to be shown for users who have never visited the browser before. Example: "ctgA:1234..5678". |
view→trackPadding | Spacing between tracks in the genome view, in pixels. Default 20. Added in JBrowse 1.10.10. |
include | Imports one or more other configuration files and merges their data with the file in which this appears. Can be either a string URL of a single file, or an array of string URLs. |
initialHighlight | If set, the given region will be highlighted when the browser loads. Example: "ctgA:1234..5678". |
highResoutionMode | Enable high-resolution canvas rendering. Can be "auto", "disabled", or a numeric specifying a scaling factor. Default "disabled". Added in JBrowse 1.11.4. |
documentDomain | Set the document.domain property which can assist when JBrowse is in embedded mode and needs to set the same-origin policy. Added in JBrowse 1.11.3. |
shareLink | Enable or disable the share link button. Default: true. Can be 0 or false. |
shareURL | A customized shareURL for the share link button. This can be helpful for an iframe embedding to have the share link point to the page embedding the iframe. A customized example could be "function(browser){ return 'http://myinstance.com/?loc='+browser.view.visibleRegionLocString(); }" |
aboutThisBrowser→title | Title for the "About" popup. |
aboutThisBrowser→description | Custom content for the "About" popup. |
maxRecentTracks | Max length of the recent tracks menu. Default: 10 |
show_tracklist | Optionally turn off tracklist. &tracklist=0 in the URL also works. Default: true |
show_nav | Optionally turn off navigation bar. &nav=0 in the URL also works. Default: true |
show_tracklabels | Optionally turn off the track labels. Works when HideTrackLabels plugin is enables. Set &tracklabels=0 in the URL also works. Default: true |
show_fullviewlink | Optionally turn off the "Full-view" link in embedded mode. Set &fullviewlink=0 in the URL. Default: true |
show_overview | Optionally turn off the overview bar. &overview=0 in the URL also works. Default: true |
show_menu | Optionally turn off the menu bar. &menu=0 in the URL also works. Added in 1.11.6. Default: true. |
containerID | Set a prefix on cookies and identify the ID of the div holding JBrowse. Default: GenomeBrowser. |
cookieSizeLimit | Default: 1200 |
updateBrowserURL | Enable updating the URL with current view. If you encounter security exceptions from cross domain updating the URL, try disabling. Default: true |
view→maxPxPerBp | Sets the maximum zoom level in pixels per basepair units. Default: 20 |
quickHelp→content | Sets the content of the help dialog. |
quickHelp→href | Sets the content of the help dialog using XHR to retrieve content. |
quickHelp→title | Sets the title of the help dialog. Note: other dijit Dialog parameter can also be passed to quickHelp, these are just the basics. |
exactReferenceSequenceNames | Disables the regularizeReferenceSequence routine. Default: false |
refSeqs | A custom URL for your refSeqs.json file (or a webservice returning something in refSeqs.json format). Example: "http://mysite/refseqs.json". Can also be a URL for a FASTA index file in 1.12.0+. Can also be a full JSON object with storeClass and faiUrlTemplate or urlTemplate, this reduces the need for JBrowse to depend on checking the file extension of the refSeqs config, so instead you can supply refSeqs=json:{"storeClass": "JBrowse/Store/SeqFeature/IndexedFasta", "faiUrlTemplate": "path/to/file.fa.fai"}. Object notation added in JBrowse 1.16.7 |
alwaysOnTracks | Comma-separated list of track *labels* to always show when the browser is opened. Example: "snps,genes,alignments". |
classicMenu | Boolean to use classic menu style (File) menu. Added in 1.12.0 |
hideGenomeOptions | Boolean - Hide the options for opening a sequence file. Added in 1.12.0 |
noPluginsForAboutDialog | Boolean - Hide the plugins from the about box. Added in 1.12.3 |
trackLabels | Set "trackLabels": "no-block" to enable the trackLabels to be out of the way of the features. Added in 1.12.5 |
allowCrossOriginDataRoot | Allows dataRoot or the ?data= url parameter to point to a remote directory. Default false. This can introduce XSS so it is not recommended on sites that have logins. Note this is set through index.html with the data-config attribute on the GenomeBrowser div |
cacheBuster | Sets a randomized value ?v= on requests to configuration files to avoid aggressive browser caching. Default true. Note this is set through index.html with the data-config attribute on the GenomeBrowser div |
alwaysStopScrollBubble | Since JBrowse 1.16.5 the scroll event can bubble the vertical scroll event instead of capturing and stopping it. This can allow for a more intuitive scrolling in a larger embedded page. If this is unwanted, add alwaysStopScrollBubble: true |
disableSearch | Disables the 'Search features' menu item |
disableReset | Disables the 'Reset to defaults' menu item |
customRefRename | Adds an extra step to the default ref name renaming that jbrowse does (smoothing over chr1 vs 1 type names). Example: rename a specific reference function(ref) { return ref==='chloroplast'? 'chrC':ref } |
replaceRefRename | Replaces the jbrowse ref renaming completely to just use your config callback and not it's additional steps. Example function(ref) { return ref.toLowerCase().replace('chr','') } |