DistanceMatrixProps
Defined in: packages/components/src/components/DistanceMatrix/types.ts:80
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Default value | Description | Inherited from |
|---|---|---|---|---|
labels |
string[] |
undefined |
Row/column ids, in matrix order. |
SimpleDistanceMatrixProps.labels |
matrix |
readonly readonly number[][] |
undefined |
Symmetric labels.length × labels.length distances. |
SimpleDistanceMatrixProps.matrix |
labelNames? |
Record<string, string> |
undefined |
Display text for a label id, where it differs from the id (e.g. a renamed sequence). | SimpleDistanceMatrixProps.labelNames |
width? |
number |
650 |
Width in pixels. | SimpleDistanceMatrixProps.width |
height? |
number |
500 |
Maximum height in pixels; a small matrix takes less. | SimpleDistanceMatrixProps.height |
options? |
DistanceMatrixOptions |
undefined |
- | SimpleDistanceMatrixProps.options |
viewport? |
Viewport |
the top-left corner at the default cell size |
The visible window, in cells (x: columns, y: rows). | SimpleDistanceMatrixProps.viewport |
onViewportChange? |
(next) => void |
undefined |
Called with the next window on every pan/zoom. | SimpleDistanceMatrixProps.onViewportChange |
rowOrder? |
string[] |
labels order |
Display order of rows and columns, as label ids. Unknown ids are ignored and unlisted rows follow in labels order — the same shape as the MSA’s rowOrder, so one store can order both. |
SimpleDistanceMatrixProps.rowOrder |
onRowOrderChange? |
(next) => void |
undefined |
Called with the new order when a row name is dragged. | SimpleDistanceMatrixProps.onRowOrderChange |
panelSizes? |
DistanceMatrixPanelSizes |
a 160px label column |
Panel sizes. | SimpleDistanceMatrixProps.panelSizes |
onPanelSizesChange? |
(next) => void |
undefined |
Called while a panel divider is dragged. | SimpleDistanceMatrixProps.onPanelSizesChange |
onHoverChange? |
(hover) => void |
undefined |
Called as the pointer moves over the cells (null when it leaves). |
SimpleDistanceMatrixProps.onHoverChange |
defaultViewport? |
Viewport |
undefined |
Seeds the visible window when uncontrolled. | - |
viewportStore? |
StoreController<Viewport> |
undefined |
Keeps the visible window 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 an alignment. | - |
defaultPanelSizes? |
Partial<DistanceMatrixPanelSizes> |
undefined |
Seeds the panel sizes when uncontrolled; omitted sizes take their defaults. | - |
panelSizesStore? |
StoreController<DistanceMatrixPanelSizes> |
undefined |
Keeps the panel sizes in an external store. | - |