Class: PIXI.DisplayObjectContainer

Constructor

new DisplayObjectContainer()

Source code: pixi/display/DisplayObjectContainer.js (Line 5)

Extends

• DisplayObject

Public Properties

[readonly] children : Array.<DisplayObject>

[read-only] The array of children of this container.

Type

• Array.<DisplayObject>

Source code: pixi/display/DisplayObjectContainer.js (Line 17)

height : number

The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Source code: pixi/display/DisplayObjectContainer.js (Line 600)

ignoreChildInput : boolean

If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.

If this property is true then the children will not be considered as valid for Input events.

Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.

Source code: pixi/display/DisplayObjectContainer.js (Line 26)

width : number

The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Source code: pixi/display/DisplayObjectContainer.js (Line 571)

Public Methods

addChild(child) → {DisplayObject}

Adds a child to the container.

Parameters

Name	Type	Description
child	DisplayObject	The DisplayObject to add to the container

Returns

DisplayObject -

The child that was added.

Source code: pixi/display/DisplayObjectContainer.js (Line 42)

addChildAt(child, index) → {DisplayObject}

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters

Name	Type	Description
child	DisplayObject	The child to add
index	Number	The index to place the child in

Returns

DisplayObject -

The child that was added.

Source code: pixi/display/DisplayObjectContainer.js (Line 55)

contains(child) → {Boolean}

Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.

Parameters

Name	Type	Description
child	DisplayObject	-

Returns

Boolean -

Source code: pixi/display/DisplayObjectContainer.js (Line 449)

getBounds(targetCoordinateSpace) → {Rectangle}

Retrieves the global bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.

Parameters

Name	Type	Argument	Description
targetCoordinateSpace	PIXIDisplayObject | PIXIMatrix	<optional>	Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.

Returns

Rectangle -

The rectangular bounding area

Source code: pixi/display/DisplayObjectContainer.js (Line 280)

getChildAt(index) → {DisplayObject}

Returns the child at the specified index

Parameters

Name	Type	Description
index	Number	The index to get the child from

Returns

DisplayObject -

The child at the given index, if any.

Source code: pixi/display/DisplayObjectContainer.js (Line 153)

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters

Name	Type	Description
child	DisplayObject	The DisplayObject instance to identify

Returns

Number -

The index position of the child display object to identify

Source code: pixi/display/DisplayObjectContainer.js (Line 112)

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.

Returns

Rectangle -

The rectangular bounding area

Source code: pixi/display/DisplayObjectContainer.js (Line 437)

removeChild(child) → {DisplayObject}

Removes a child from the container.

Parameters

Name	Type	Description
child	DisplayObject	The DisplayObject to remove

Returns

DisplayObject -

The child that was removed.

Source code: pixi/display/DisplayObjectContainer.js (Line 171)

removeChildAt(index) → {DisplayObject}

Removes a child from the specified index position.

Parameters

Name	Type	Description
index	Number	The index to get the child from

Returns

DisplayObject -

The child that was removed.

Source code: pixi/display/DisplayObjectContainer.js (Line 191)

removeChildren(beginIndex, endIndex)

Removes all children from this container that are within the begin and end indexes.

Parameters

Name	Type	Description
beginIndex	Number	The beginning position. Default value is 0.
endIndex	Number	The ending position. Default value is size of the container.

Source code: pixi/display/DisplayObjectContainer.js (Line 213)

setChildIndex(child, index)

Changes the position of an existing child in the display object container

Parameters

Name	Type	Description
child	DisplayObject	The child DisplayObject instance for which you want to change the index number
index	Number	The resulting index number for the child display object

Source code: pixi/display/DisplayObjectContainer.js (Line 132)

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters

Name	Type	Description
child	DisplayObject	-
child2	DisplayObject	-

Source code: pixi/display/DisplayObjectContainer.js (Line 85)