A view port for scrolling containers that extend BaseScrollContainer.

Available since

1.0.0

.

See:

Variables

maxVisibleHeight:Null<Float>

The maximum height of the view port. This value may be different from the maximum height of the view port's content.

To access the maximum height of the view port's content, use the maxHeight property.

Available since

1.0.0

.

maxVisibleWidth:Null<Float>

The maximum width of the view port. This value may be different from the maximum width of the view port's content.

To access the maximum width of the view port's content, use the maxWidth property.

Available since

1.0.0

.

minVisibleHeight:Null<Float>

The minimum height of the view port. This value may be different from the minimum height of the view port's content.

To access the minimum height of the view port's content, use the minHeight property.

Available since

1.0.0

.

minVisibleWidth:Null<Float>

The minimum width of the view port. This value may be different from the minimum width of the view port's content.

To access the minimum width of the view port's content, use the minWidth property.

Available since

1.0.0

.

read onlyrequiresMeasurementOnScroll:Bool

Indicates if the content of the view port must be re-measured when scrolling. Typically used by "virtualized" layouts.

Available since

1.0.0

.

scrollX:Float

The current horizontal scroll position (on the x-axis).

Available since

1.0.0

.

scrollY:Float

The current vertical scroll position (on the y-axis).

Available since

1.0.0

.

visibleHeight:Null<Float>

The height of the view port. This value may be smaller than the height of the view port's content, which indicates that scrolling is required.

To access the height of the view port's content, use the height property.

Available since

1.0.0

.

visibleWidth:Null<Float>

The width of the view port. This value may be smaller than the width of the view port's content, which indicates that scrolling is required.

To access the width of the view port's content, use the width property.

Available since

1.0.0

.

Inherited Variables

Defined by IUIControl

enabled:Bool

Indicates whether the control should respond when a user attempts to interact with it. The appearance of the control may also be affected by whether the control is enabled or disabled.

The following example disables a component:

component.enabled = false;
Available since

1.0.0

.

Inherited Methods

Defined by IUIControl

initializeNow ():Void

If the component has not yet initialized, initializes immediately. The FeathersEvent.INITIALIZE event will be dispatched. To both initialize and validate immediately, call validateNow() instead.

Available since

1.0.0

.