Skip to content
Simon Brent edited this page Mar 8, 2022 · 1 revision

The Genoverse.Plugins namespace contains a set of plugins to extend the core functionality of Genoverse.

These plugins, located in the src/js/plugins directory, are as follows:

controlPanel

Adds

  • a "Tracks" button to the top left of the genome browser, which when clicked displays a list of enabled and available tracks, to be added or removed.
  • a suite of buttons to the right of the genome browser, for scrolling, zooming and selecting regions of the genome
  • the karyotype plugin

Configuration

tracksLibraryCategoryOrder (default [])

An array of strings matching the category of tracks available in the instance.

If the array is empty, the tracks menu will not be grouped by category.

If the array has items, tracks will be grouped under headings matching these items. Any tracks without a category, or whose category is not present in tracksLibraryCategoryOrder will appear under the heading "Other".

karyotype

Adds an ideogram of the chromosome being used by the genome browser, with a marker showing the currently viewed region. The marker and be dragged and resized to change region, and chromosome bands can be jumped to by clicked on them.

Configuration

karyotypeLabel (default undefined)

If false, the chromsome label (e.g. "Chr 1") will not be shown to the left of the ideogram.

showAssembly (default undefined)

If true, an attempt will be made to show the assembly in the chromosome label (e.g. "GRCh38: Chr 1").

This will only be possible if either genoverse.assembly is set, or genoverse.genome is a string.

trackControls

Adds a toggleable pop-out menu on the right side of the track, containing buttons to view track information, remove the track, toggle the track between fixed height and auto resizing, and change track filters/configuration settings, if there are any.

resizer

Adds a draggable handle to the bottom of each track, to allow the user to resize it to their desired height. If this plugin is not in use, tracks can only be resized to show all features currently in view.

focusRegion

Adds a button to the control panel to move the viewpoint to a particular region of the genome. The controlPanel plugin will be added if not already in use.

fullscreen

Adds a button to the control panel to enable the toggling of a full screen view of the genome browser. The controlPanel plugin will be added if not already in use.

tooltips

Adds a button to the control panel to enable the toggling of a help tooltips for the genome browser. The controlPanel plugin will be added if not already in use.

fileDrop

Adds the ability to drag and drop a local data file onto the genome browser, and have its data displayed as a track.