MCPcopy Create free account
hub / github.com/bvaughn/react-virtualized / MultiGridImperativeAPI

Interface MultiGridImperativeAPI

lib/components/MultiGrid/types.ts:125–170  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

123
124/** Public (imperative) methods of a `MultiGrid` instance. */
125export interface MultiGridImperativeAPI {
126 /**
127 * Pass-thru that calls `forceUpdate` on all child `Grid`s.
128 */
129 forceUpdateGrids(): void;
130
131 /**
132 * Invalidate the size of a cell (after the current render has been committed); see `Grid#invalidateCellSizeAfterRender`.
133 * The invalidated cells (of all child `Grid`s) are recomputed, and the `MultiGrid` re-rendered, once the current render has been committed.
134 * This method is intended for `CellMeasurer`.
135 */
136 invalidateCellSizeAfterRender(params?: Partial<CellPosition>): void;
137
138 /**
139 * Pass-thru that calls `measureAllCells` on all child `Grid`s.
140 */
141 measureAllCells(): void;
142
143 /**
144 * Pass-thru that calls `recomputeGridSize` on all child `Grid`s
145 * (adjusting the specified indices for fixed rows and columns).
146 * Both indices default to 0.
147 *
148 * This also recomputes the `MultiGrid`'s own layout (the height of the fixed rows and the width of the fixed columns)
149 * and re-renders it.
150 */
151 recomputeGridSize(params?: { columnIndex?: number; rowIndex?: number }): void;
152
153 /**
154 * Ensure the specified column and/or row is visible (scrolling if necessary); see `Grid#scrollToCell`.
155 * Indices include the fixed columns and rows (which are always visible, so they are not scrolled to).
156 * The fixed rows and columns are kept in sync with the scrolled section.
157 */
158 scrollToCell(params: {
159 align?: Alignment;
160 columnIndex?: number;
161 rowIndex?: number;
162 }): void;
163
164 /**
165 * Scroll to the specified offset(s) of the scrollable (bottom-right) section; see `Grid#scrollToPosition`.
166 * The fixed rows and columns are kept in sync with it.
167 * This allows a `MultiGrid` to be used with `ScrollSync`.
168 */
169 scrollToPosition(params: ScrollPosition): void;
170}

Callers 16

getInnerSizesFunction · 0.80
MultiGrid.test.tsxFile · 0.80
MultiGrid.test.tsxFile · 0.65
getInnerSizesFunction · 0.65
MultiGrid.test.tsxFile · 0.65
measureAllCellsFunction · 0.65
MultiGrid.test.tsxFile · 0.65
recomputeGridsFunction · 0.65
onCommitFunction · 0.65
MultiGrid.test.tsxFile · 0.65
scrollToCellFunction · 0.65
MultiGrid.test.tsxFile · 0.65

Calls

no outgoing calls

Tested by

no test coverage detected