MSADrawOptions

Defined in: packages/components/src/components/MultipleSequenceAlignment/types.ts:55

Rendering options for MultipleSequenceAlignment.

Properties

Property	Type	Default value	Description
cellSize?	number	16	Pixel size of each residue cell at the default zoom.
colorStyle?	ColorStyle	undefined	Residue or column-analysis color scheme. Defaults to "DNA" or "AA ClustalX" depending on what the alignment’s alphabet looks like — see detectSequenceType in @react-bio-viz/core.
showLetters?	boolean	true	Draw the residue letter inside each cell (only once cells are large enough to read).
showLabels?	boolean	true	Show the sequence-name column.
labelWidth?	number	undefined	:::caution[Deprecated] Use defaultPanelSizes.labelWidth (MultipleSequenceAlignment only). :::
showConsensus?	boolean	true	Show a majority-vote consensus row above the alignment.
showMinimap?	boolean	true	Show an overview above the alignment: click to jump, drag to pan, drag an edge to zoom.
showScalebar?	boolean	true	Show a column-position ruler above the alignment.
showToolbar?	boolean	true	Show the pan/zoom toolbar (MultipleSequenceAlignment only).
showCursorBadge?	boolean	true	Show the one-line readout of the hovered cell above the alignment.
showCursorTooltip?	boolean	true	Show a tooltip next to the pointer describing the hovered cell.
highlightPattern?	string	undefined	Highlight the residues matching this text (case-insensitively) — or, with highlightUseRegex, this regular expression — and dim the rest. An invalid regex matches nothing.
highlightUseRegex?	boolean	false	Treat highlightPattern as a regular expression instead of a plain substring.
showOnlyDifferences?	boolean	false	Draw residues that match the consensus as ·, so only the differences stand out.
conservationThreshold?	number	0.9	Identity threshold (0–1) for the "% Conserved" color style.
columnScores?	readonly number[]	undefined	Per-column 0–1 scores for the "Column score" color style.
cellScores?	readonly readonly number[][]	undefined	Per-residue 0–1 scores for the "Cell score" color style, indexed [row][column] in msa order.
tracks?	MSATrack[]	[]	Tracks drawn below the alignment, top to bottom. Clicking a track selects columns.
interactionMode?	"select" | "pan"	"pan"	What a plain drag on the alignment does. In "pan" mode, Shift-drag (add) and Cmd/Ctrl-drag (toggle) still select; in "select" mode a plain drag replaces the selection.
selectionAxis?	"rows" | "columns"	"columns"	Which axis a drag/click on the alignment selects.
zoomAxes?	"both" | "columns"	"both"	Axes that Ctrl/⌘-scroll (and trackpad pinch) zoom. "columns" keeps rows at a readable height while zooming along the sequence. A plain scroll always pans.
reorderableRows?	boolean	true	Let rows be reordered by dragging their labels (writes rowOrder).
darkMode?	boolean	whether <html> has the dark class	Render for a dark background.