buildUniformCumX

Builds cumulative horizontal positions for equally sized items

Available since @roku-sdk/flex-grid 3.3.0

import { buildUniformCumX } from "@roku-sdk/flex-grid/geometry";

Also exported as buildUniformCumX from @roku-sdk/flex-grid (deprecated).

Deprecated: buildUniformCumX. Import from @roku-sdk/flex-grid/geometry instead. The root export will be removed in the next major version.

buildUniformCumX(itemWidth: number, itemGap: number, numCols: number): number[]

Description

Builds cumulative horizontal positions for equally sized items.

The final entry includes the trailing gap. Zero columns returns [0]. Sizes must be non-negative and the column count must be a non-negative integer.

Parameters

NameTypeDescription
itemWidthnumberItem width in pixels.
itemGapnumberGap after each item in pixels.
numColsnumberNumber of columns, as a non-negative integer.

Return values

The item start positions in pixels followed by the total width including the trailing gap.

Example

buildUniformCumX(100, 10, 2); // [0, 110, 220]

What’s Next

Did this page help you?