API Reference

Class List

pc.ScrollViewComponent

Extends: pc.Component

A ScrollViewComponent enables a group of entities to behave like a masked scrolling area, with optional horizontal and vertical scroll bars.

Summary

Properties

bounceAmountControls how far the content should move before bouncing back.
contentEntityThe entity which contains the scrolling content itself.
frictionControls how freely the content should move if thrown, i.
horizontalWhether to enable horizontal scrolling.
horizontalScrollbarEntityThe entity to be used as the vertical scrollbar.
horizontalScrollbarVisibilityControls whether the horizontal scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.
scrollModeSpecifies how the scroll view should behave when the user scrolls past the end of the content.
verticalWhether to enable vertical scrolling.
verticalScrollbarEntityThe entity to be used as the vertical scrollbar.
verticalScrollbarVisibilityControls whether the vertical scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.
viewportEntityThe entity to be used as the masked viewport area, within which the content will scroll.

Events

set:scrollFired whenever the scroll position changes.

Inherited

Properties

enabledEnables or disables the component.

Details

Constructor

ScrollViewComponent(system, entity)

Create a new ScrollViewComponent.

Parameters

systempc.ScrollViewComponentSystemThe ComponentSystem that created this Component
entitypc.EntityThe Entity that this Component is attached to.

Properties

NumberbounceAmount

Controls how far the content should move before bouncing back.

pc.EntitycontentEntity

The entity which contains the scrolling content itself. This entity must have an Element component.

Numberfriction

Controls how freely the content should move if thrown, i.e. by flicking on a phone or by flinging the scroll wheel on a mouse. A value of 1 means that content will stop immediately; 0 means that content will continue moving forever (or until the bounds of the content are reached, depending on the scrollMode).

Booleanhorizontal

Whether to enable horizontal scrolling.

pc.EntityhorizontalScrollbarEntity

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

pc.SCROLLBAR_VISIBILITYhorizontalScrollbarVisibility

Controls whether the horizontal scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

pc.SCROLL_MODEscrollMode

Specifies how the scroll view should behave when the user scrolls past the end of the content. Modes are defined as follows:

Booleanvertical

Whether to enable vertical scrolling.

pc.EntityverticalScrollbarEntity

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

pc.SCROLLBAR_VISIBILITYverticalScrollbarVisibility

Controls whether the vertical scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

pc.EntityviewportEntity

The entity to be used as the masked viewport area, within which the content will scroll. This entity must have an ElementGroup component.

Events

set:scroll

Fired whenever the scroll position changes.

Parameters

scrollPositionpc.Vec2Horizontal and vertical scroll values in the range 0...1.

Inherited

Properties

Booleanenabled

Enables or disables the component.