Skip to content

MultipleSequenceAlignmentProps

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

Property Type Default value Description Inherited from
msa AlignedSequences undefined The alignment. All sequences must have the same length. SimpleMultipleSequenceAlignmentProps.msa
width? number 650 Width in pixels. SimpleMultipleSequenceAlignmentProps.width
height? number 400 Maximum height in pixels; an alignment with few rows takes less. SimpleMultipleSequenceAlignmentProps.height
options? MSADrawOptions undefined Rendering options — see MSADrawOptions. SimpleMultipleSequenceAlignmentProps.options
viewport? Viewport the top-left corner at cellSize pixels per cell The visible window, in columns and rows. SimpleMultipleSequenceAlignmentProps.viewport
onViewportChange? (next) => void undefined Called with the next window on every pan/zoom. SimpleMultipleSequenceAlignmentProps.onViewportChange
selection? MSASelection nothing selected Selected rows and columns. SimpleMultipleSequenceAlignmentProps.selection
onSelectionChange? (next) => void undefined Called on every selection change: a drag or click on the alignment, labels or tracks; Escape. SimpleMultipleSequenceAlignmentProps.onSelectionChange
rowOrder? string[] msa order Display order of the rows, as row ids. Unknown ids are ignored and unlisted rows follow in msa order, so a tree’s leaf order can be passed as is. SimpleMultipleSequenceAlignmentProps.rowOrder
onRowOrderChange? (next) => void undefined Called with the new order when a label is dragged. SimpleMultipleSequenceAlignmentProps.onRowOrderChange
panelSizes? MSAPanelSizes 150, 48 and 50 pixels Sizes of the label column, tracks and minimap. SimpleMultipleSequenceAlignmentProps.panelSizes
onPanelSizesChange? (next) => void undefined Called while a panel divider is dragged. SimpleMultipleSequenceAlignmentProps.onPanelSizesChange
onRenameRow? (rowId, name) => void undefined Enables renaming a row (double-click its label, or the pencil on hover). The alignment isn’t edited: apply the rename to your data and pass it back. SimpleMultipleSequenceAlignmentProps.onRenameRow
onRemoveRows? (rowIds) => void undefined Enables removing rows: the × on a hovered label, and Delete on selected rows. Never called with every row. SimpleMultipleSequenceAlignmentProps.onRemoveRows
onRemoveColumns? (columns) => void undefined Enables removing selected columns with Delete. Never called with every column. SimpleMultipleSequenceAlignmentProps.onRemoveColumns
onHoverChange? (hover) => void undefined Called as the pointer moves over the alignment (null when it leaves). SimpleMultipleSequenceAlignmentProps.onHoverChange
defaultViewport? Viewport undefined Seeds the visible window when uncontrolled. -
viewportStore? StoreController<Viewport> undefined Keeps the visible window in an external store. -
defaultSelection? MSASelection undefined Seeds the selection when uncontrolled. -
selectionStore? StoreController<MSASelection> undefined Keeps the selection in an external store. -
defaultRowOrder? string[] undefined Seeds the row order when uncontrolled. -
rowOrderStore? StoreController<string[]> undefined Keeps the row order in an external store — e.g. one shared with a tree’s leaf order. -
defaultPanelSizes? Partial<MSAPanelSizes> undefined Seeds the panel sizes when uncontrolled; omitted sizes take their defaults. -
panelSizesStore? StoreController<MSAPanelSizes> undefined Keeps the panel sizes in an external store. -