Skip to content

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

Source code

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.

ParamTypeDescription
selectedRangesArray<CellRange>The selected ranges to build the focus order for.

getCurrentHorizontalNode

Source code

focusOrder.getCurrentHorizontalNode() ⇒ FocusNodeData | undefined

Gets the currently selected node data from the horizontal focus order.

getCurrentVerticalNode

Source code

focusOrder.getCurrentVerticalNode() ⇒ FocusNodeData | undefined

Gets the currently selected node data from the vertical focus order.

getFirstHorizontalNode

Source code

focusOrder.getFirstHorizontalNode() ⇒ FocusNodeData | undefined

Gets the first node data from the horizontal focus order.

getFirstVerticalNode

Source code

focusOrder.getFirstVerticalNode() ⇒ FocusNodeData | undefined

Gets the first node data from the vertical focus order.

getNextHorizontalNode

Source code

focusOrder.getNextHorizontalNode() ⇒ FocusNodeData

Gets the next selected node data from the horizontal focus order.

getNextVerticalNode

Source code

focusOrder.getNextVerticalNode() ⇒ FocusNodeData

Gets the next selected node data from the vertical focus order.

getPrevHorizontalNode

Source code

focusOrder.getPrevHorizontalNode() ⇒ FocusNodeData

Gets the previous selected node data from the horizontal focus order.

getPrevVerticalNode

Source code

focusOrder.getPrevVerticalNode() ⇒ FocusNodeData

Gets the previous selected node data from the vertical focus order.

setActiveNode

Source code

focusOrder.setActiveNode(row, column, selectionLayerIndex) ⇒ FocusOrder

Sets the active node based on the provided row and column.

ParamTypeDescription
rownumberThe visual row index.
columnnumberThe visual column index.
selectionLayerIndexnumberThe index of the selection layer to which the focus should be marked as active.

setNextNodeAsActive

Source code

focusOrder.setNextNodeAsActive()

Sets the next node in both focus orders as active.

setPrevNodeAsActive

Source code

focusOrder.setPrevNodeAsActive()

Sets the previous node in both focus orders as active.