Skip to main content

HighlightsMixin

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.

The view.highlight band state shared verbatim by the LinearGenomeView and DotplotView: an array of translucent highlight regions plus the showHighlightChips toggle for their interactive chips. Both views compose this so the props and actions stay identical by construction rather than by two hand-kept copies. Visibility across all views is the session-wide highlightsVisible flag (on BaseSession), not a prop here.

Properties

MemberDescription
highlight
highlight: types.stripDefault(
        types.array(types.frozen<HighlightType>()),
        [],
      )
translucent highlight bands, seeded from URL params or session JSON and added interactively via the rubber-band menu
showHighlightChips
showHighlightChips: types.stripDefault(types.boolean, false)		pins the interactive highlight chip (link icon + context menu) to every highlight band; off by default, where a band instead reveals its chip while the pointer is in it. This is what a screenshot needs, since nothing hovers in one

Actions

MemberDescription
addToHighlights
(highlight: HighlightType) => void
setHighlight
(highlight?: HighlightType[] | undefined) => void
removeHighlight
(highlight: HighlightType) => void
updateHighlight
(old: HighlightType, updates: Partial<HighlightType>) => void
setShowHighlightChips
(arg: boolean) => void