FocusOrder
Description
Initializes the focus order manager with the merged cell getter and row and column index mappers used to navigate focus through merged regions.
Methods
buildFocusOrder
focusOrder.buildFocusOrder(selectedRanges)
Rebuilds the focus order based on the provided selection. Only the layers’ geometry is captured — the focus stops themselves are computed lazily during navigation.
| Param | Type | Description |
|---|---|---|
| selectedRanges | Array<CellRange> | The selected ranges to build the focus order for. |
getCurrentHorizontalNode
focusOrder.getCurrentHorizontalNode() ⇒ FocusNodeData | undefined
Gets the currently selected node data from the horizontal focus order.
getCurrentVerticalNode
focusOrder.getCurrentVerticalNode() ⇒ FocusNodeData | undefined
Gets the currently selected node data from the vertical focus order.
getFirstHorizontalNode
focusOrder.getFirstHorizontalNode() ⇒ FocusNodeData | undefined
Gets the first node data from the horizontal focus order.
getFirstVerticalNode
focusOrder.getFirstVerticalNode() ⇒ FocusNodeData | undefined
Gets the first node data from the vertical focus order.
getNextHorizontalNode
focusOrder.getNextHorizontalNode() ⇒ FocusNodeData
Gets the next selected node data from the horizontal focus order.
getNextVerticalNode
focusOrder.getNextVerticalNode() ⇒ FocusNodeData
Gets the next selected node data from the vertical focus order.
getPrevHorizontalNode
focusOrder.getPrevHorizontalNode() ⇒ FocusNodeData
Gets the previous selected node data from the horizontal focus order.
getPrevVerticalNode
focusOrder.getPrevVerticalNode() ⇒ FocusNodeData
Gets the previous selected node data from the vertical focus order.
setActiveNode
focusOrder.setActiveNode(row, column, selectionLayerIndex) ⇒ FocusOrder
Sets the active node based on the provided row and column.
| Param | Type | Description |
|---|---|---|
| row | number | The visual row index. |
| column | number | The visual column index. |
| selectionLayerIndex | number | The index of the selection layer to which the focus should be marked as active. |
setNextNodeAsActive
focusOrder.setNextNodeAsActive()
Sets the next node in both focus orders as active.
setPrevNodeAsActive
focusOrder.setPrevNodeAsActive()
Sets the previous node in both focus orders as active.