API Reference

Class List

ScrollViewComponent

Extends: Component

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

Summary

Properties

bounceAmount

Controls how far the content should move before bouncing back.

contentEntity

The entity which contains the scrolling content itself.

friction

Controls how freely the content should move if thrown, i.

horizontal

Whether to enable horizontal scrolling.

horizontalScrollbarEntity

The entity to be used as the vertical scrollbar.

horizontalScrollbarVisibility

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

mouseWheelSensitivity

Mouse wheel horizontal and vertical sensitivity.

scrollMode

Specifies how the scroll view should behave when the user scrolls past the end of the content.

useMouseWheel

Whether to use mouse wheel for scrolling (horizontally and vertically).

vertical

Whether to enable vertical scrolling.

verticalScrollbarEntity

The entity to be used as the vertical scrollbar.

verticalScrollbarVisibility

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

viewportEntity

The entity to be used as the masked viewport area, within which the content will scroll.

Inherited

Properties

enabled

Enables or disables the component.

Methods

fire

Fire an event, all additional arguments are passed on to the event listener.

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Constructor

ScrollViewComponent(system, entity)

Create a new ScrollViewComponent.

Parameters

systemScrollViewComponentSystem

The ComponentSystem that created this Component.

entityEntity

The Entity that this Component is attached to.

Properties

numberbounceAmount

Controls how far the content should move before bouncing back.

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.

EntityhorizontalScrollbarEntity

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

numberhorizontalScrollbarVisibility

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

Vec2mouseWheelSensitivity

Mouse wheel horizontal and vertical sensitivity. Only used if useMouseWheel is set. Setting a direction to 0 will disable mouse wheel scrolling in that direction. 1 is a default sensitivity that is considered to feel good. The values can be set higher or lower than 1 to tune the sensitivity. Defaults to [1, 1].

numberscrollMode

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

booleanuseMouseWheel

Whether to use mouse wheel for scrolling (horizontally and vertically).

booleanvertical

Whether to enable vertical scrolling.

EntityverticalScrollbarEntity

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

numberverticalScrollbarVisibility

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

EntityviewportEntity

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

Inherited

Properties

booleanenabled

Enables or disables the component.

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

namestring

Name of event to fire.

arg1*

First argument that is passed to the event handler.

arg2*

Second argument that is passed to the event handler.

arg3*

Third argument that is passed to the event handler.

arg4*

Fourth argument that is passed to the event handler.

arg5*

Fifth argument that is passed to the event handler.

arg6*

Sixth argument that is passed to the event handler.

arg7*

Seventh argument that is passed to the event handler.

arg8*

Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

namestring

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

namestring

Name of the event to unbind.

callbackHandleEventCallback

Function to be unbound.

scopeobject

Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

namestring

Name of the event to bind the callback to.

callbackHandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

namestring

Name of the event to bind the callback to.

callbackHandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.