Skip to main content

GridBookmarkWidgetModel

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Provided by the grid-bookmark plugin. View source.

Properties

MemberDescription
label
label: types.optional(types.string, '')
highlight
highlight: types.optional(types.string, DEFAULT_HIGHLIGHT)
id
id: ElementId
type
type: types.literal('GridBookmarkWidget')
bookmarks
bookmarks: types.optional(types.array(LabeledRegionModel), () =>
        localStorageGetJSON(localStorageKeyF(), []),
      )
loaded from localStorage when not present in snapshot; sharedBookmarks from a shared URL are merged in via preProcessSnapshot

Volatiles

MemberDescription
selectedBookmarks
selectedBookmarks: [] as IExtendedLabeledRegionModel[]
gridView
gridView: 'bookmarks'		which grid tab is visible: bookmarks or highlights

Getters

MemberDescription
assembliesInViews
Set<string>		assemblies currently displayed in any open view; the grids only show bookmarks/highlights belonging to these
visibleBookmarks
(ModelInstanceTypeProps<_OverrideProps<_OverrideProps<…>, { ...; }>> & { ...; } & { ...; } & IStateTreeNode<...>)[]
bookmarks belonging to an assembly currently open in a view

Actions

MemberDescription
setLabel
(label: string) => void
setHighlight
(color: string) => void
setGridView
(arg: "bookmarks" | "both" | "highlights") => void
importBookmarks
(regions: Region[]) => void
addBookmark
(region: Region) => void
updateBookmarkLabel
(bookmark: IExtendedLabeledRegionModel, label: string) => void
updateBookmarkHighlight
(bookmark: IExtendedLabeledRegionModel, color: string) => void
updateBulkBookmarkHighlights
(color: string) => void
setSelectedBookmarks
(bookmarks: IExtendedLabeledRegionModel[]) => void
setBookmarkedRegions
(regions: ModelCreationType<ExtractCFromProps<_OverrideProps<_OverrideProps<…>, { ...; }>>>[]) => void
clearSelectedBookmarks
() => void
removeBookmarkObject
(arg: ModelInstanceTypeProps<_OverrideProps<_OverrideProps<…>, { ...; }>> & { ...; } & { ...; } & IStateTreeNode<...>) => void