Class: Highlighter

Highlighter

The Highlighter object controls highlighting and popovers of features, plots and other elements on the Viewer when the mouse hovers over them.

Attributes

Option Default Description
feature HighlighterElement Describes the highlightling options for features
plot HighlighterElement Describes the highlightling options for plots
contig HighlighterElement Describes the highlightling options for contigs
backbone HighlighterElement Describes the highlightling options for the backbone
showMetaData true Should meta data be shown in popovers

new Highlighter(viewer, options)

Highlighter.js, line 34

Create a Highlighter

Name Type Description
viewer Viewer

The viewer
options Object

Attributes used to create the highlighter.

Extends

Members

backboneHighlighterElement

Get the backbone HighlighterElement

canvasCanvas

Get the canvas.

contigHighlighterElement

Get the contig HighlighterElement

featureHighlighterElement

Get the feature HighlighterElement

layoutLayout

Get the layout.

metaBoolean

Get or Set the meta data of this object. See the meta data tutorial for details.

plotHighlighterElement

Get the plot HighlighterElement

sequenceSequence

Get the sequence.

viewerViewer

Get the viewer.

visibleBoolean

Get or Set the visibility of this object.

Methods

inherited deleteFromObjects()

CGObject.js, line 120

Remove the object from Viewer.objects

inherited toString(){String}

CGObject.js, line 59

Return the class name as a string.

Returns:
Type Description
String
  • 'CGObject'