A layout that is affected by changes to scroll position.

Available since

1.0.0

.

Variables

read onlyprimaryDirection:Direction

The primary direction that this layout is expected to scroll. Not all layouts will necessarily have a primary direction.

Available since

1.0.0

.

read onlyrequiresLayoutOnScroll:Bool

Determines if the container calls layout() when the scroll position changes. Useful for transforming items as the view port scrolls. This alue should typically be true for layouts that implement the IVirtualLayout interface and the useVirtualLayout property is set to true. May also be used by layouts that toggle item visibility as the items scroll into and out of the view port.

Available since

1.0.0

.

scrollX:Float

The horizontal scroll position of the container using this layout.

Available since

1.0.0

.

scrollY:Float

The vertical scroll position of the container using this layout.

Available since

1.0.0

.

Inherited Variables

Inherited Methods

Defined by ILayout

layout (items:Array<DisplayObject>, measurements:Measurements, ?result:LayoutBoundsResult):LayoutBoundsResult

Positions and sizes an array of display objects based on their parent container's measurements. Returns new measurements, if the parent does not have explicit measurements.

Available since

1.0.0

.