Cocos Creator API


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


Module: cc

The Label Component.


string String

Content string of label.

horizontalAlign Label.HorizontalAlign

Horizontal Alignment of label.

verticalAlign Label.VerticalAlign

Vertical Alignment of label.

actualFontSize Number

The actual rendering font size in shrink mode

fontSize Number

Font size of label.

lineHeight Number

Line Height of label.

overflow Label.Overflow

Overflow of label.

enableWrapText Boolean

Whether auto wrap label when string width is large than label width.

font Font

The font of label.

isSystemFontUsed Boolean

Whether use system font name or not.

_sgNode _ccsg.Node private

Reference to the instance of _ccsg.Node If it is possible to return null from your overloaded _createSgNode, then you should always check for null before using this property and reimplement __preload.

__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.



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.


comp.enabled = true;

enabledInHierarchy Boolean readOnly

Inherited from Component:

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



_isOnLoadCalled Boolean readOnly

Inherited from Component:




_name String private

_objFlags Number private

name String

The name of the object.

examples: = "New Obj";

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


_createSgNode ( ) _ccsg.Node private

Create and returns your new scene graph node (SGNode) to add to scene graph. You should call the setContentSize of the SGNode if its size should be the same with the node's.


type: _ccsg.Node

_initSgNode ( ) private

_removeSgNode ( ) private

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.