Cocos Creator API

1.4.x

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

PageView

Extends ScrollView
Module: cc

The PageView control

Properties

sizeMode PageView.SizeMode

Specify the size type of each page in PageView.

direction PageView.Direction

The page view direction

scrollThreshold Number

The scroll threshold value, when drag exceeds this value, release the next page will automatically scroll, less than the restore

autoPageTurningThreshold Number

Auto page turning velocity threshold. When users swipe the PageView quickly, it will calculate a velocity based on the scroll distance and time, if the calculated velocity is larger than the threshold, then it will trigger page turning.

pageTurningEventTiming Number

Change the PageTurning event timing of PageView.

indicator PageViewIndicator

The Page View Indicator

pageEvents Component.EventHandler[]

PageView events callback

content Node

Inherited from ScrollView:

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

horizontal Boolean

Inherited from ScrollView:

Enable horizontal scroll.

vertical Boolean

Inherited from ScrollView:

Enable vertical scroll.

inertia Boolean

Inherited from ScrollView:

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

brake Number

Inherited from ScrollView:

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

Inherited from ScrollView:

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

bounceDuration Number

Inherited from ScrollView:

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

horizontalScrollBar Scrollbar

Inherited from ScrollView:

The horizontal scrollbar reference.

verticalScrollBar Scrollbar

Inherited from ScrollView:

The vertical scrollbar reference.

scrollEvents Component.EventHandler[]

Inherited from ScrollView:

Scrollview events callback

cancelInnerEvents Boolean

Inherited from ScrollView:

If cancelInnerEvents is set to true, the scroll behavior will cancel touch events on inner content nodes It's set to true by default.

__eventTargets Array private

Inherited from Component:

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

node Node

Inherited from Component:

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

examples:

cc.log(comp.node);

uuid String readOnly

Inherited from Component:

The uuid for editor.

examples:

cc.log(comp.uuid);

_enabled Boolean private

Inherited from Component:

enabled Boolean

Inherited from Component:

indicates whether this component is enabled or not.

examples:

comp.enabled = true;
cc.log(comp.enabled);

enabledInHierarchy Boolean readOnly

Inherited from Component:

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

examples:

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled Boolean readOnly

Inherited from Component:

TODO

examples:

cc.log(_isOnLoadCalled);

_name String private

_objFlags Number private

name String

The name of the object.

examples:

obj.name = "New Obj";

isValid Boolean readOnly

Indicates whether the object is not yet destroyed.

examples:

cc.log(obj.isValid);

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

getCurrentPageIndex ( ) Number

Returns current page index

returns:

type: Number

setCurrentPageIndex
(
  • index
)

Set current page index

name type description
index Number

getPages ( ) Node[]

Returns all pages of pageview

returns:

type: Node[]

addPage
(
  • page
)

At the end of the current page view to insert a new view

name type description
page Node

insertPage
(
  • page
  • index
)

Inserts a page in the specified location

name type description
page Node
index Number

removePage
(
  • page
)

Removes a page from PageView.

name type description
page Node

removePageAtIndex
(
  • index
)

Removes a page at index of PageView.

name type description
index Number

removeAllPages ( )

Removes all pages from PageView

scrollToPage
(
  • idx
  • timeInSecond
)

Scroll PageView to index.

name type description
idx Number

index of page.
timeInSecond Number

scrolling time

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

Inherited from ScrollView:

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.

examples:

// Scroll to the bottom of the view.
scrollView.scrollToBottom(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the top of the view.
scrollView.scrollToTop(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the left of the view.
scrollView.scrollToLeft(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the right of the view.
scrollView.scrollToRight(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the upper left corner of the view.
scrollView.scrollToTopLeft(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the top right corner of the view.
scrollView.scrollToTopRight(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the lower left corner of the view.
scrollView.scrollToBottomLeft(0.1);

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

Inherited from ScrollView:

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.

examples:

// Scroll to the lower right corner of the view.
scrollView.scrollToBottomRight(0.1);

scrollToOffset
(
  • offset
  • [timeInSecond =0]
  • [attenuated =true]
)

Inherited from ScrollView:

Scroll with an offset related to the ScrollView's top left origin, if timeInSecond is omitted, then it will jump to the specific offset immediately.

name type description
offset Vec2

A Vec2, the value of which each axis between 0 and maxScrollOffset
timeInSecond optional Number 0

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

Whether the scroll acceleration attenuated, default is true.

examples:

// Scroll to middle position in 0.1 second in x-axis
var maxScrollOffset = this.getMaxScrollOffset();
scrollView.scrollToOffset(cc.p(maxScrollOffset.x / 2, 0), 0.1);

getScrollOffset ( ) Vec2

Inherited from ScrollView:

Get the positive offset value corresponds to the content's top left boundary.

returns:

type: Vec2

A Vec2 value indicate the current scroll offset.

getMaxScrollOffset ( ) Vec2

Inherited from ScrollView:

Get the maximize available scroll offset

returns:

type: Vec2

A Vec2 value indicate the maximize scroll offset in x and y axis.

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

Inherited from ScrollView:

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.

examples:

// Scroll to middle position.
scrollView.scrollToBottomRight(0.5, 0.1);

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

Inherited from ScrollView:

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

name type description
anchor Vec2

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.

examples:

// Vertical scroll to the bottom of the view.
scrollView.scrollTo(cc.p(0, 1), 0.1);

// Horizontal scroll to view right.
scrollView.scrollTo(cc.p(1, 0), 0.1);

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

Inherited from ScrollView:

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. // Scroll to middle position. scrollView.scrollToPercentVertical(0.5, 0.1);

stopAutoScroll ( )

Inherited from ScrollView:

Stop auto scroll immediately

setContentPosition
(
  • position
)

Inherited from ScrollView:

Modify the content position.

name type description
position Vec2

The position in content's parent space.

getContentPosition ( ) Position

Inherited from ScrollView:

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.

__preload ( ) private

Inherited from Component:

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

onLoad ( )

Inherited from Component:

When attaching to an active node or its node first activated.

start ( )

Inherited from Component:

Called before all scripts' update if the Component is enabled the first time.

onEnable ( )

Inherited from Component:

Called when this component becomes enabled and its node is active.

onDisable ( )

Inherited from Component:

Called when this component becomes disabled or its node becomes inactive.

onDestroy ( )

Inherited from Component:

Called when this component will be destroyed.

onFocusInEditor ( )

Inherited from Component:

onLostFocusInEditor ( )

Inherited from Component:

resetInEditor ( )

Inherited from Component:

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

addComponent
(
  • typeOrTypename
)
Component

Inherited from Component:

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

name type description
typeOrTypename Function | String

the constructor or the class name of the component to add

returns:

type: Component

the newly added component

examples:

var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");

getComponent
(
  • typeOrClassName
)
Component

Inherited from Component:

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

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");

getComponents
(
  • typeOrClassName
)
Component[]

Inherited from Component:

Returns all components of supplied Type in the node.

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");

getComponentInChildren
(
  • typeOrClassName
)
Component

Inherited from Component:

Returns the component of supplied type in any of its children using depth first search.

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");

getComponentsInChildren
(
  • typeOrClassName
)
Component[]

Inherited from Component:

Returns the components of supplied type in self or any of its children using depth first search.

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");

_getLocalBounds
(
  • out_rect
)

Inherited from Component:

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

name type description
out_rect Rect

the Rect to receive the bounding box

onRestore ( )

Inherited from Component:

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

schedule
(
  • callback
  • [interval =0]
  • [repeat =cc.macro.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.macro.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.

examples:

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

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.

examples:

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

unschedule
(
  • callback_fn
)

Inherited from Component:

Unschedules a custom callback function.

name type description
callback_fn function

A function wrapped as a selector

examples:

this.unschedule(_callback);

unscheduleAllCallbacks ( )

Inherited from Component:

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

examples:

this.unscheduleAllCallbacks();

destroy ( ) Boolean

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering.
After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

returns:

type: Boolean

whether it is the first time the destroy being called

examples:

obj.destroy();

_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, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

_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

Events

page-turning

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail PageView
      The PageView component.

scroll-to-top

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

scroll-to-bottom

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

scroll-to-left

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

scroll-to-right

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

scrolling

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

bounce-bottom

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

bounce-top

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

bounce-left

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

bounce-right

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

scroll-ended

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

touch-up

Inherited from ScrollView:

Note: This event is emitted from the node to which the component belongs.

Event Payload:

  • event Event
    • type String

      The name of the event (case-sensitive), e.g. "click", "fire", or "submit"

    • bubbles Boolean

      A boolean indicating whether the event bubbles up through the tree or not

    • detail ScrollView
      The ScrollView component.

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