Class: Bookmark

Bookmark

Bookmarks are saved map locations. Bookmarks store the base pair (bp), the zoomFactor (zoom) and map format (e.g. linear or circular). By default the map backbone at the provided bp will be centered in the middle of the canvas. The bbOffset attribute can be used to move the map backbone away from the center. Bookmarks can have shortcut key associated with them. If the key is typed, while not in a input field, the map will move to the bookmark position.

Action and Events

Action	Viewer Method	Bookmark Method	Event
Add	addBookmarks()	-	bookmarks-add
Update	updateBookmarks()	update()	bookmarks-update
Remove	removeBookmarks()	remove()	bookmarks-remove
Read	bookmarks()	-	-

Attributes

Attribute	Type	Description
name	String	Name of bookmark [Default: "Bookmark-N" where N is the number of the bookmark]
bp	Number	Base pair to center the map position [Default: Current bp]
zoom	Number	Zoom factor [Default: Current zoomFactor]
format	String	Map format [Default: Current map format]
bbOffset	Number	Distance from the backbone to the center of the canvas [Default: 0]
shortcut	Character	Single character shortcut that when pressed moves the map to this position [Default: N (see name) up to 9]
favorite	Boolean	Bookmark is a favorite [Default: false]
meta	Object	Meta data for Bookmark

Examples

// Create a new bookmark for the current map postion
let bookmark = cgv.addBookmarks();
// => Bookmark {name: 'Bookmark-1', bp: 1, zoom: 1, format: 'linear', bbOffset: 0, shortcut: 1}
cgv.bookmarks().length;
// => 1

// Edit the bookmark
bookmark.update({name: 'my gene'});
// => Bookmark {name: 'my gene', bp: 1, zoom: 1, format: 'linear', bbOffset: 0, shortcut: 1}

// Move to the bookmark position
bookmark.moveTo()

// Remove the bookmark
bookmark.remove();
cgv.bookmarks().length;
// => 0