For internal usage.
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.
The elapse time of bouncing back. A value of 0 will bounce back immediately.
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.
When elastic is set, the content will be bounce back when move out of boundary.
When inertia is set, the content will continue to move when touch ended.
The node this component is attached to. A component is always attached to a node.
PageView events callback
The time required to turn over a page. unit: second
Returns a value which used to indicate the onLoad get called or not.
Indicates whether this component is enabled or not.
Indicates whether this component is enabled or not.
Indicates whether this component is enabled and its node is also active in the hierarchy.
The Page View Indicator.
The Page View Indicator.
Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame.
So isValid will return false from the next frame, while isValid in the current frame will still be true.
If you want to determine whether the current frame has called destroy, use isValid(obj, true),
but this is often caused by a particular logical requirements, which is not normally required.
Change the PageTurning event timing of PageView.
Change the PageTurning event timing of PageView.
The scroll threshold value, when drag exceeds this value, release the next page will automatically scroll, less than the restore.
The scroll threshold value, when drag exceeds this value, release the next page will automatically scroll, less than the restore.
The uuid for editor.
__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.
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; } } }
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.
The rect to store the result bounding rect
Adds a component class to the node. You can also add component to node by passing in the name of the script.
The class of component to be retrieved or to be created
Adds a component class to the node. You can also add component to node by passing in the name of the script.
A string for the class name of the component
At the end of the current page view to insert a new view.
新视图。
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.
The class of component to be retrieved or to be created
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.
A string for the class name of the component
Returns the component of supplied type in any of its children using depth first search.
The class of component to be retrieved
Returns the component of supplied type in any of its children using depth first search.
A string for the class name of the component
Returns all components of supplied type in the node.
The class of components to be retrieved
Returns all components of supplied type in the node.
A string for the class name of the components
Returns all components of supplied type in self or any of its children.
The class of components to be retrieved
Returns all components of supplied type in self or any of its children.
A string for the class name of the components
Query the content's position in its parent space.
Returns current page index.
当前页面索引。
Get the maximize available scroll offset.
Returns all pages of pageview.
输=视图所有页面。
Get the positive offset value corresponds to the content's top left boundary.
Inserts a page in the specified location.
新视图。
指定位置。
Query whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.
Query whether the user is currently dragging the ScrollView to scroll it.
LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.
the delta time in seconds it took to complete the last frame
Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.
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.
Removes all pages from PageView.
Removes a page from PageView.
指定页面。
Removes a page at index of PageView.
页面下标。
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.
Schedules a custom task.
If the task is already scheduled, then the interval parameter will be updated without scheduling it again.
The callback function of the task
The time interval between each invocation
The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever
The delay time for the first invocation, Unit: s
Schedules a task that runs only once, with a delay of 0 or larger.
The callback function of the task
The delay time for the first invocation, Unit: s
Scroll the content to the percent position of ScrollView in any direction.
在 new Vec2(0,0) and new Vec2(1,1) 上取差值的一个点。
滚动时间（s）。 如果超时，内容将立即跳到指定水平或垂直百分比位置。
滚动加速是否衰减，默认为 true。
Scroll the content to the bottom boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到底部边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the bottom left boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到左下边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the bottom right boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到右边下边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the left boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到左边边界。
滚动加速是否衰减，默认为 true。
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.
指定移动偏移量。
滚动时间（s）。 如果超时，内容将立即跳到指定偏移量处。
滚动加速是否衰减，默认为 true。
Scroll PageView to index.
index of page.
scrolling time.
Scroll the content to the horizontal percent position of ScrollView.
0 - 之间的百分比。
滚动时间（s）。 如果超时，内容将立即跳到指定水平百分比位置。
滚动加速是否衰减，默认为 true。
Scroll the content to the vertical percent position of ScrollView.
0 - 1 之间的百分比。
滚动时间（s）。 如果超时，内容将立即跳到指定垂直百分比位置。
滚动加速是否衰减，默认为 true。
Scroll the content to the right boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到右边边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the top boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到顶部边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the top left boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到左上边边界。
滚动加速是否衰减，默认为 true。
Scroll the content to the top right boundary of ScrollView.
滚动时间（s）。 如果超时，内容将立即跳到右上边界。
滚动加速是否衰减，默认为 true。
Modify the content position.
当前视图坐标点.
Set current page index.
索引。
Stop auto scroll immediately.
Un-schedules a custom task.
The callback function of the task
unschedule all scheduled tasks.
Generated using TypeDoc
The PageView control.