computeVirtualX
Computes a horizontal position for a column in a looping row
Available since @roku-sdk/flex-grid 3.3.0
import { computeVirtualX } from "@roku-sdk/flex-grid/geometry";Also exported as computeVirtualX from @roku-sdk/flex-grid (deprecated).
Deprecated: computeVirtualX. Import from @roku-sdk/flex-grid/geometry instead. The root export will be removed in the next major version.
computeVirtualX(virtualCol: number, numCols: number, cumX: number[], loopWidth: number): numberDescription
Computes a horizontal position for a column in a looping row.
Negative and out-of-range column indices resolve into a loop and a column within that loop. The column count must be a positive integer; zero columns produces NaN. Missing cumulative positions contribute zero.
Parameters
| Name | Type | Description |
|---|---|---|
virtualCol | number | Virtual column index, as an integer that may be negative. |
numCols | number | Number of columns in each loop, as a positive integer. |
cumX | number[] | Column start positions in pixels, indexed within one loop. |
loopWidth | number | Width of one complete loop in pixels. |
Return values
The continuous horizontal position in pixels across loops.
Example
computeVirtualX(-1, 3, [0, 100, 200], 300); // -100Updated about 3 hours ago
What’s Next
Did this page help you?