Cocos Creator API

0.7.1

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

ScrollView

Extends Component
Module: cc

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display.

Properties

content cc.Node

This is a reference to the UI element to be scrolled.

horizontal Boolean

Enable horizontal scroll.

vertical Boolean

Enable vertical scroll.

inertia Boolean

When inertia is set, the content will continue to move when touch ended.

brake Float

It determines how quickly the content stop moving. A value of 1 will stop the movement immediately. A value of 0 will never stop the movement until it reaches to the boundary of scrollview.

elastic Boolean

When elastic is set, the content will be bounce back when move out of boundary.

bounceDuration Float

The elapse time of bouncing back. A value of 0 will bounce back immediately.

horizontalScrollBar cc.Scrollbar

The horizontal scrollbar reference.

verticalScrollBar cc.Scrollbar

The vertical scrollbar reference.

node Node

Inherited from Component:

The node this component is attached to. A component is always attached to a node.

uuid String readOnly

Inherited from Component:

The uuid for editor

_enabled Boolean private

Inherited from Component:

enabled Boolean

Inherited from Component:

indicates whether this component is enabled or not.

enabledInHierarchy Boolean readOnly

Inherited from Component:

indicates whether this component is enabled and its entity is also active in the hierarchy.

_isOnLoadCalled Boolean readOnly

Inherited from Component:

__eventTargets Array private

Inherited from Component:

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

_name String private

_objFlags Number private

name String

The name of the object.

isValid Boolean readOnly

Indicates whether the object is not yet destroyed

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

scrollToBottom
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the bottom boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToTop
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the top boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the top boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToLeft
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the left boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the left boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToRight
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the right boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the right boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToTopLeft
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the top left boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the top left boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToTopRight
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the top right boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the top right boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToBottomLeft
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the bottom left boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom left boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToBottomRight
(
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the bottom right boundary of ScrollView.

name type description
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom right boundary immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToPercentHorizontal
(
  • percent
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the horizontal percent position of ScrollView.

name type description
percent Number

A value between 0 and 1.
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the horizontal percent position of ScrollView immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollTo
(
  • anchor
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the percent position of ScrollView in any direction.

name type description
anchor Point

A point which will be clamp between cc.p(0,0) and cc.p(1,1).
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the percent position of ScrollView immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

scrollToPercentVertical
(
  • percent
  • [timeInSecond =0]
  • [attenuated =true]
)

Scroll the content to the vertical percent position of ScrollView.

name type description
percent Number

A value between 0 and 1.
timeInSecond optional Number 0

Scroll time in second, if you don't pass timeInSecond, the content will jump to the vertical percent position of ScrollView immediately.
attenuated optional Boolean true

Whether the scroll acceleration attenuated, default is true.

setContentPosition
(
  • position
)

Modify the content position.

name type description
position Point

The position in content's parent space.

getContentPosition ( ) Position

Query the content's position in its parent space.

returns:

type: Position

The content's position in its parent space.

update ( )

Inherited from Component:

Update is called every frame, if the Component is enabled.

lateUpdate ( )

Inherited from Component:

LateUpdate is called every frame, if the Component is enabled.

onLoad ( )

Inherited from Component:

When attaching to an active entity or its entity first activated

start ( )

Inherited from Component:

Called before all scripts' update if the Component is enabled

onEnable ( )

Inherited from Component:

Called when this component becomes enabled and its entity becomes active

onDisable ( )

Inherited from Component:

Called when this component becomes disabled or its entity becomes inactive

onDestroy ( )

Inherited from Component:

Called when this component will be destroyed.

onFocusInEditMode ( )

Inherited from Component:

onLostFocusInEditMode ( )

Inherited from Component:

addComponent
(
  • typeOrName
)
Component

Inherited from Component:

Adds a component class to the entity. You can also add component to entity by passing in the name of the script.

name type description
typeOrName Function | String

the constructor or the class name of the component to add

returns:

type: Component

the newly added component

getComponent
(
  • typeOrName
)
Component

Inherited from Component:

Returns the component of supplied type if the entity has one attached, null if it doesn't. You can also get component in the entity by passing in the name of the script.

name type description
typeOrName Function | String

returns:

type: Component

schedule
(
  • callback
  • [interval =0]
  • [repeat =cc.REPEAT_FOREVER]
  • [delay =0]
)

Inherited from Component:

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

name type description
callback function

The callback function
interval optional Number 0

Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.
repeat optional Number cc.REPEAT_FOREVER

The selector will be executed (repeat + 1) times, you can use kCCRepeatForever for tick infinitely.
delay optional Number 0

The amount of time that the first tick will wait before execution.

scheduleOnce
(
  • callback
  • [delay =0]
)

Inherited from Component:

Schedules a callback function that runs only once, with a delay of 0 or larger

name type description
callback function

A function wrapped as a selector
delay optional Number 0

The amount of time that the first tick will wait before execution.

unschedule
(
  • callback_fn
)

Inherited from Component:

Unschedules a custom callback function.

name type description
callback_fn function

A function wrapped as a selector

unscheduleAllCallbacks ( )

Inherited from Component:

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

destroy ( ) Boolean

Destroy this Object, and release all its own references to other objects.

After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) (or obj.isValid if obj is non-nil) to check whether the object is destroyed before accessing it.

returns:

type: Boolean

whether it is the first time the destroy being called

realDestroyInEditor ( )

In fact, Object's "destroy" will not trigger the destruct operation in Firebal Editor. The destruct operation will be executed by Undo system later.

_destruct ( ) private

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the INSTANCE of CCObject. You can override the _destruct method if you need.

_onPreDestroy ( ) private

Called before the object being destroyed.

_serialize
(
  • exporting
)
object private

The customized serialization for this object. (Editor Only)

name type description
exporting Boolean

returns:

type: object

the serialized json data object

_deserialize
(
  • data
  • ctx
)
private

Init this object from the custom serialized data.

name type description
data Object

the serialized json data
ctx _Deserializer

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index