Class Container

inherited Pixim.Container

Hierarchy

Container
- Container

Implements

IAnimateContainer

Index

Constructors

constructor

Constructors

constructor

new Container(): Container
Returns Container
Overrides PixiContainer.constructor
- Defined in src/Container.ts:88

Properties

_accessibleActive

_accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

_accessibleDiv

_accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

_bounds

_bounds: Bounds

The bounds object, this is used to calculate and store the bounds of the displayObject.

Member

PIXI.DisplayObject#_bounds

`Protected` _boundsID

_boundsID: number

Flags the cached bounds as dirty.

Member

PIXI.DisplayObject#_boundsID

`Protected` _boundsRect

_boundsRect: Bounds

Cache of this display-object's bounds-rectangle.

Member

PIXI.DisplayObject#_boundsRect

`Private` _createjsData

_createjsData: {
controller: CreatejsController;
}

Type declaration

controller: CreatejsController

`Protected` _destroyed

_destroyed: boolean

If the object has been destroyed via destroy(). If true, it should not be used.

Member

PIXI.DisplayObject#_destroyed

`Protected` _enabledFilters

_enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

`Protected` _lastSortedIndex

_lastSortedIndex: number

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

Member

PIXI.DisplayObject#_lastSortedIndex

_localBounds

_localBounds: Bounds

Local bounds object, swapped with _bounds when using getLocalBounds().

Member

PIXI.DisplayObject#_localBounds

`Protected` _localBoundsRect

_localBoundsRect: Bounds

Cache of this display-object's local-bounds rectangle.

Member

PIXI.DisplayObject#_localBoundsRect

`Protected` _mask

_mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

`Protected` _tempDisplayObjectParent

_tempDisplayObjectParent: Container

Member

`Protected` _zIndex

_zIndex: number

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Member

PIXI.DisplayObject#_zIndex

accessible

accessible: boolean

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Member

Memberof

PIXI.DisplayObject#

accessibleChildren

accessibleChildren: boolean

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Member

Memberof

PIXI.DisplayObject#

Default

true

accessibleHint

accessibleHint: string

Sets the aria-label attribute of the shadow div

Member

Memberof

PIXI.DisplayObject#

accessiblePointerEvents

accessiblePointerEvents: string

Specify the pointer-events the accessible div will use Defaults to auto.

Member

Memberof

PIXI.DisplayObject#

Default

'auto'

accessibleTitle

accessibleTitle: string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'

Member

Memberof

PIXI.DisplayObject#

accessibleType

accessibleType: string

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Member

Memberof

PIXI.DisplayObject#

Default

'button'

alpha

alpha: number

The opacity of the object.

Member

PIXI.DisplayObject#alpha

angle

angle: number

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

Member

buttonMode

buttonMode: boolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

Member

Memberof

PIXI.DisplayObject#

cacheAsBitmap

cacheAsBitmap: boolean

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to false

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Member

Memberof

PIXI.DisplayObject#

`Readonly` children

children: DisplayObject[]

The array of children of this container.

Member

PIXI.Container#children

cursor

cursor: string

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

See

https://developer.mozilla.org/en/docs/Web/CSS/cursor

Member

Memberof

PIXI.DisplayObject#

filterArea

filterArea: Rectangle

The area the filter is applied to. This is used as more of an optimization rather than figuring out the dimensions of the displayObject each frame you can set this rectangle.

Also works as an interaction mask.

Member

PIXI.DisplayObject#filterArea

filters

filters: Filter[]

Sets the filters for the displayObject.

IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'.

Member

PIXI.DisplayObject#filters

height

height: number

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

Member

hitArea

hitArea: IHitArea

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

Member

Memberof

PIXI.DisplayObject#

interactive

interactive: boolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

Member

Memberof

PIXI.DisplayObject#

interactiveChildren

interactiveChildren: boolean

Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

Member

Memberof

PIXI.Container#

isMask

isMask: boolean

Does any other displayObject use this object as a mask?

Member

PIXI.DisplayObject#isMask

isSprite

isSprite: boolean

used to fast check if a sprite is.. a sprite!

Member

PIXI.DisplayObject#isSprite

`Readonly` localTransform

localTransform: Matrix

Current transform of the object based on local factors: position, scale, other stuff.

Member

mask

mask: null | Container | MaskData

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

Example

const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();

const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;

Todo

At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

Member

name

name: string

The instance name of the object.

Memberof

PIXI.DisplayObject#

Member

name

parent

parent: Container

The display object container that contains this display object.

Member

PIXI.DisplayObject#parent

pivot

pivot: ObservablePoint

The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.

Member

position

position: ObservablePoint

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

Member

renderable

renderable: boolean

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually.

Member

PIXI.DisplayObject#renderable

rotation

rotation: number

The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

Member

scale

scale: ObservablePoint

The scale factor of the object. Assignment by value since pixi-v4.

Member

skew

skew: ObservablePoint

The skew factor for the object in radians. Assignment by value since pixi-v4.

Member

sortDirty

sortDirty: boolean

Should children be sorted by zIndex at the next updateTransform call. Will get automatically set to true if a new child is added, or if a child's zIndex changes.

Member

PIXI.Container#sortDirty

sortableChildren

sortableChildren: boolean

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as

Link

https://github.com/pixijs/pixi-display

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

See

PIXI.settings.SORTABLE_CHILDREN

Member

PIXI.Container#sortableChildren

transform

transform: Transform

World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing.

Member

PIXI.DisplayObject#transform

visible

visible: boolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

Member

PIXI.DisplayObject#visible

width

width: number

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

Member

`Readonly` worldAlpha

worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

`Readonly` worldTransform

worldTransform: Matrix

Current transform of the object based on world (parent) factors.

Member

`Readonly` worldVisible

worldVisible: boolean

Indicates if the object is globally visible.

Member

x

x: number

The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

Member

y

y: number

The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

Member

zIndex

zIndex: number

The zIndex of the displayObject. If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other displayObjects within the same container.

Member

Methods

`Protected` _calculateBounds

_calculateBounds(): void
Protected
Recalculates the bounds of the object. Override this to calculate the bounds of the specific object (not including children).

Returns void
Implementation of IAnimateContainer._calculateBounds
Inherited from PixiContainer._calculateBounds
- Defined in node_modules/pixi.js/pixi.js.d.ts:8452

_recursivePostUpdateTransform

_recursivePostUpdateTransform(): void
Recursively updates transform of all objects from the root to this one internal function for toLocal()

Returns void
Implementation of IAnimateContainer._recursivePostUpdateTransform
Inherited from PixiContainer._recursivePostUpdateTransform
- Defined in node_modules/pixi.js/pixi.js.d.ts:8737

`Protected` _render

_render(renderer): void
Protected
To be overridden by the subclasses.
Parameters
- renderer: Renderer
  The renderer
Returns void
Implementation of IAnimateContainer._render
Inherited from PixiContainer._render
- Defined in node_modules/pixi.js/pixi.js.d.ts:8472

addChild

addChild<TChildren>(...children): TChildren[0]
Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)
Type Parameters
- TChildren extends DisplayObject[]
Parameters
- Rest ...children: TChildren
  The DisplayObject(s) to add to the container
Returns TChildren[0]
The first child that was added.
Implementation of IAnimateContainer.addChild
Inherited from PixiContainer.addChild
- Defined in node_modules/pixi.js/pixi.js.d.ts:8365

addChildAt

addChildAt<T>(child, index): T
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Type Parameters
- T extends DisplayObject
Parameters
- child: T
  The child to add
- index: number
  The index to place the child in
Returns T
The child that was added.
Implementation of IAnimateContainer.addChildAt
Inherited from PixiContainer.addChildAt
- Defined in node_modules/pixi.js/pixi.js.d.ts:8373

addCreatejs

addCreatejs(cjs): TCreatejsObject
Parameters
- cjs: TCreatejsObject
Returns TCreatejsObject
Implementation of IAnimateContainer.addCreatejs
- Defined in src/Container.ts:100

addCreatejsAt

addCreatejsAt(cjs, index): TCreatejsObject
Parameters
- cjs: TCreatejsObject
- index: number
Returns TCreatejsObject
Implementation of IAnimateContainer.addCreatejsAt
- Defined in src/Container.ts:104

addListener

addListener(event, fn, context?): this
Parameters
- event: InteractionEventTypes
- fn: ((event) => void)
  - - (event): void
    - Parameters
      event: InteractionEvent
      Returns void
- Optional context: any
Returns this
Implementation of IAnimateContainer.addListener
Inherited from PixiContainer.addListener
- Defined in node_modules/pixi.js/pixi.js.d.ts:25521
addListener(event, fn, context?): this
Parameters
- event: string | symbol
- fn: Function
- Optional context: any
Returns this
Implementation of IAnimateContainer.addListener
Inherited from PixiContainer.addListener
- Defined in node_modules/pixi.js/pixi.js.d.ts:25523

calculateBounds

calculateBounds(): void
Recalculates the bounds of the container.

Returns void
Implementation of IAnimateContainer.calculateBounds
Inherited from PixiContainer.calculateBounds
- Defined in node_modules/pixi.js/pixi.js.d.ts:8436

containerUpdateTransform

containerUpdateTransform(): void
Container default updateTransform, does update children of container. Will crash if there's no parent element.

Returns void
Memberof
PIXI.Container#

Function
containerUpdateTransform
Implementation of IAnimateContainer.containerUpdateTransform
Inherited from PixiContainer.containerUpdateTransform
- Defined in node_modules/pixi.js/pixi.js.d.ts:8510

destroy

destroy(options?): void
Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.
Parameters
- Optional options: {
      baseTexture?: boolean;
      children?: boolean;
      texture?: boolean;
  }
  Options parameter. A boolean will act as if all options have been set to that value
  - Optional baseTexture?: boolean
    Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
  - Optional children?: boolean
    if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
  - Optional texture?: boolean
    Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
Returns void
Implementation of IAnimateContainer.destroy
Inherited from PixiContainer.destroy
- Defined in node_modules/pixi.js/pixi.js.d.ts:8486

disableTempParent

disableTempParent(cacheParent): void
Pair method for enableTempParent
Parameters
- cacheParent: DisplayObject
  actual parent of element
Returns void
Implementation of IAnimateContainer.disableTempParent
Inherited from PixiContainer.disableTempParent
- Defined in node_modules/pixi.js/pixi.js.d.ts:8812

displayObjectUpdateTransform

displayObjectUpdateTransform(): void
DisplayObject default updateTransform, does not update children of container. Will crash if there's no parent element.

Returns void
Memberof
PIXI.DisplayObject#

Function
displayObjectUpdateTransform
Implementation of IAnimateContainer.displayObjectUpdateTransform
Inherited from PixiContainer.displayObjectUpdateTransform
- Defined in node_modules/pixi.js/pixi.js.d.ts:8926

emit

emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
- Rest ...args: any[]
  Arguments that are passed to registered listeners
Returns boolean
true if the event had listeners, else false.
Implementation of IAnimateContainer.emit
Inherited from PixiContainer.emit
- Defined in node_modules/pixi.js/pixi.js.d.ts:25441

enableTempParent

enableTempParent(): DisplayObject
Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root
```
const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
```
Returns DisplayObject
current parent
Implementation of IAnimateContainer.enableTempParent
Inherited from PixiContainer.enableTempParent
- Defined in node_modules/pixi.js/pixi.js.d.ts:8807

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Implementation of IAnimateContainer.eventNames
Inherited from PixiContainer.eventNames
- Defined in node_modules/pixi.js/pixi.js.d.ts:25415

getBounds

getBounds(skipUpdate?, rect?): Rectangle
Retrieves the bounds of the displayObject as a rectangle object.
Parameters
- Optional skipUpdate: boolean
  Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.
- Optional rect: Rectangle
  Optional rectangle to store the result of the bounds calculation.
Returns Rectangle
The rectangular bounding area.
Implementation of IAnimateContainer.getBounds
Inherited from PixiContainer.getBounds
- Defined in node_modules/pixi.js/pixi.js.d.ts:8747

getChildAt

getChildAt(index): DisplayObject
Returns the child at the specified index
Parameters
- index: number
  The index to get the child at
Returns DisplayObject
The child at the given index, if any.
Implementation of IAnimateContainer.getChildAt
Inherited from PixiContainer.getChildAt
- Defined in node_modules/pixi.js/pixi.js.d.ts:8401

getChildByName

getChildByName(name, deep?): DisplayObject
Returns the display object in the container.

Recursive searches are done in a preorder traversal.
Parameters
- name: string
  Instance name.
- Optional deep: boolean
  Whether to search recursively
Returns DisplayObject
The child with the specified name.

Method
getChildByName

Memberof
PIXI.Container#
Implementation of IAnimateContainer.getChildByName
Inherited from PixiContainer.getChildByName
- Defined in node_modules/pixi.js/pixi.js.d.ts:8530

getChildIndex

getChildIndex(child): number
Returns the index position of a child DisplayObject instance
Parameters
- child: DisplayObject
  The DisplayObject instance to identify
Returns number
The index position of the child display object to identify
Implementation of IAnimateContainer.getChildIndex
Inherited from PixiContainer.getChildIndex
- Defined in node_modules/pixi.js/pixi.js.d.ts:8387

getGlobalPosition

getGlobalPosition(point?, skipUpdate?): Point
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
Parameters
- Optional point: Point
  The point to write the global value to.
- Optional skipUpdate: boolean
  Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.
Returns Point
The updated point.

Method
getGlobalPosition

Memberof
PIXI.DisplayObject#
Implementation of IAnimateContainer.getGlobalPosition
Inherited from PixiContainer.getGlobalPosition
- Defined in node_modules/pixi.js/pixi.js.d.ts:9010

getLocalBounds

getLocalBounds(rect?, skipChildrenUpdate?): Rectangle
Retrieves the local bounds of the displayObject as a rectangle object.
Parameters
- Optional rect: Rectangle
  Optional rectangle to store the result of the bounds calculation.
- Optional skipChildrenUpdate: boolean
  Setting to true will stop re-calculation of children transforms, it was default behaviour of pixi 4.0-5.2 and caused many problems to users.
Returns Rectangle
The rectangular bounding area.
Implementation of IAnimateContainer.getLocalBounds
Inherited from PixiContainer.getLocalBounds
- Defined in node_modules/pixi.js/pixi.js.d.ts:8445

handleTick

handleTick(delta): void
Parameters
- delta: number
Returns void
Implementation of IAnimateContainer.handleTick
- Defined in src/Container.ts:96

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
  The event name.
Returns number
Implementation of IAnimateContainer.listenerCount
Inherited from PixiContainer.listenerCount
- Defined in node_modules/pixi.js/pixi.js.d.ts:25432

listeners

listeners(event): Function[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
Returns Function[]
Implementation of IAnimateContainer.listeners
Inherited from PixiContainer.listeners
- Defined in node_modules/pixi.js/pixi.js.d.ts:25424

off

off(event, fn?, context?): this
Parameters
- event: string
- Optional fn: Function
- Optional context: any
Returns this
Implementation of IAnimateContainer.off
Inherited from PixiContainer.off
- Defined in node_modules/pixi.js/pixi.js.d.ts:25534

on

on(event, fn, context?): this
Parameters
- event: "removed" | "added"
- fn: ((displayObject) => void)
  - - (displayObject): void
    - Parameters
      displayObject: DisplayObject
      Returns void
- Optional context: any
Returns this
Implementation of IAnimateContainer.on
Inherited from PixiContainer.on
- Defined in node_modules/pixi.js/pixi.js.d.ts:25530
on(event, fn, context?): this
Parameters
- event: string
- fn: Function
- Optional context: any
Returns this
Implementation of IAnimateContainer.on
Inherited from PixiContainer.on
- Defined in node_modules/pixi.js/pixi.js.d.ts:25532

`Protected` onChildrenChange

onChildrenChange(): void
Protected
Overridable method that can be used by Container subclasses whenever the children array is modified

Returns void
Implementation of IAnimateContainer.onChildrenChange
Inherited from PixiContainer.onChildrenChange
- Defined in node_modules/pixi.js/pixi.js.d.ts:8356

once

once(event, fn, context?): this
Parameters
- event: "removed" | "added"
- fn: ((displayObject) => void)
  - - (displayObject): void
    - Parameters
      displayObject: DisplayObject
      Returns void
- Optional context: any
Returns this
Implementation of IAnimateContainer.once
Inherited from PixiContainer.once
- Defined in node_modules/pixi.js/pixi.js.d.ts:25527
once(event, fn, context?): this
Parameters
- event: string
- fn: Function
- Optional context: any
Returns this
Implementation of IAnimateContainer.once
Inherited from PixiContainer.once
- Defined in node_modules/pixi.js/pixi.js.d.ts:25529

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: InteractionEventTypes
Returns this
Implementation of IAnimateContainer.removeAllListeners
Inherited from PixiContainer.removeAllListeners
- Defined in node_modules/pixi.js/pixi.js.d.ts:25516
removeAllListeners(event?): this
Parameters
- Optional event: string | symbol
Returns this
Implementation of IAnimateContainer.removeAllListeners
Inherited from PixiContainer.removeAllListeners
- Defined in node_modules/pixi.js/pixi.js.d.ts:25517

removeChild

removeChild<TChildren>(...children): TChildren[0]
Removes one or more children from the container.
Type Parameters
- TChildren extends DisplayObject[]
Parameters
- Rest ...children: TChildren
  The DisplayObject(s) to remove
Returns TChildren[0]
The first child that was removed.
Implementation of IAnimateContainer.removeChild
Inherited from PixiContainer.removeChild
- Defined in node_modules/pixi.js/pixi.js.d.ts:8408

removeChildAt

removeChildAt(index): DisplayObject
Removes a child from the specified index position.
Parameters
- index: number
  The index to get the child from
Returns DisplayObject
The child that was removed.
Implementation of IAnimateContainer.removeChildAt
Inherited from PixiContainer.removeChildAt
- Defined in node_modules/pixi.js/pixi.js.d.ts:8415

removeChildren

removeChildren(beginIndex?, endIndex?): DisplayObject[]
Removes all children from this container that are within the begin and end indexes.
Parameters
- Optional beginIndex: number
  The beginning position.
- Optional endIndex: number
  The ending position. Default value is size of the container.
Returns DisplayObject[]
List of removed children
Implementation of IAnimateContainer.removeChildren
Inherited from PixiContainer.removeChildren
- Defined in node_modules/pixi.js/pixi.js.d.ts:8423

removeCreatejs

removeCreatejs(cjs): TCreatejsObject
Parameters
- cjs: TCreatejsObject
Returns TCreatejsObject
Implementation of IAnimateContainer.removeCreatejs
- Defined in src/Container.ts:108

removeListener

removeListener(event, fn?, context?): this
Parameters
- event: InteractionEventTypes
- Optional fn: ((event) => void)
  - - (event): void
    - Parameters
      event: InteractionEvent
      Returns void
- Optional context: any
Returns this
Implementation of IAnimateContainer.removeListener
Inherited from PixiContainer.removeListener
- Defined in node_modules/pixi.js/pixi.js.d.ts:25513
removeListener(event, fn?, context?): this
Parameters
- event: string | symbol
- Optional fn: Function
- Optional context: any
Returns this
Implementation of IAnimateContainer.removeListener
Inherited from PixiContainer.removeListener
- Defined in node_modules/pixi.js/pixi.js.d.ts:25515

render

render(renderer): void
Renders the object using the WebGL renderer
Parameters
- renderer: Renderer
  The renderer
Returns void
Implementation of IAnimateContainer.render
Inherited from PixiContainer.render
- Defined in node_modules/pixi.js/pixi.js.d.ts:8458

`Protected` renderAdvanced

renderAdvanced(renderer): void
Protected
Render the object using the WebGL renderer and advanced features.
Parameters
- renderer: Renderer
  The renderer
Returns void
Implementation of IAnimateContainer.renderAdvanced
Inherited from PixiContainer.renderAdvanced
- Defined in node_modules/pixi.js/pixi.js.d.ts:8465

setChildIndex

setChildIndex(child, index): void
Changes the position of an existing child in the display object container
Parameters
- 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
Returns void
Implementation of IAnimateContainer.setChildIndex
Inherited from PixiContainer.setChildIndex
- Defined in node_modules/pixi.js/pixi.js.d.ts:8394

setParent

setParent(container): Container
Set the parent Container of this DisplayObject.
Parameters
- container: Container
  The Container to add this DisplayObject to.
Returns Container
The Container that this DisplayObject was added to.
Implementation of IAnimateContainer.setParent
Inherited from PixiContainer.setParent
- Defined in node_modules/pixi.js/pixi.js.d.ts:8775

setTransform

setTransform(x?, y?, scaleX?, scaleY?, rotation?, skewX?, skewY?, pivotX?, pivotY?): DisplayObject
Convenience function to set the position, scale, skew and pivot at once.
Parameters
- Optional x: number
  The X position
- Optional y: number
  The Y position
- Optional scaleX: number
  The X scale value
- Optional scaleY: number
  The Y scale value
- Optional rotation: number
  The rotation
- Optional skewX: number
  The X skew value
- Optional skewY: number
  The Y skew value
- Optional pivotX: number
  The X pivot value
- Optional pivotY: number
  The Y pivot value
Returns DisplayObject
The DisplayObject instance
Implementation of IAnimateContainer.setTransform
Inherited from PixiContainer.setTransform
- Defined in node_modules/pixi.js/pixi.js.d.ts:8790

sortChildren

sortChildren(): void
Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

Returns void
Implementation of IAnimateContainer.sortChildren
Inherited from PixiContainer.sortChildren
- Defined in node_modules/pixi.js/pixi.js.d.ts:8427

swapChildren

swapChildren(child, child2): void
Swaps the position of 2 Display Objects within this container.
Parameters
- child: DisplayObject
  First display object to swap
- child2: DisplayObject
  Second display object to swap
Returns void
Implementation of IAnimateContainer.swapChildren
Inherited from PixiContainer.swapChildren
- Defined in node_modules/pixi.js/pixi.js.d.ts:8380

toGlobal

toGlobal(position, point?, skipUpdate?): Point
Calculates the global position of the display object.
Parameters
- position: IPointData
  The world origin to calculate from.
- Optional point: Point
  A Point object in which to store the value, optional (otherwise will create a new Point).
- Optional skipUpdate: boolean
  Should we skip the update transform.
Returns Point
A point object representing the position of this object.
Implementation of IAnimateContainer.toGlobal
Inherited from PixiContainer.toGlobal
- Defined in node_modules/pixi.js/pixi.js.d.ts:8757

toLocal

toLocal(position, from?, point?, skipUpdate?): Point
Calculates the local position of the display object relative to another point.
Parameters
- position: IPointData
  The world origin to calculate from.
- Optional from: DisplayObject
  The DisplayObject to calculate the global position from.
- Optional point: Point
  A Point object in which to store the value, optional (otherwise will create a new Point).
- Optional skipUpdate: boolean
  Should we skip the update transform
Returns Point
A point object representing the position of this object
Implementation of IAnimateContainer.toLocal
Inherited from PixiContainer.toLocal
- Defined in node_modules/pixi.js/pixi.js.d.ts:8768

updateTransform

updateTransform(): void
Updates the transform on all children of this container for rendering

Returns void
Implementation of IAnimateContainer.updateTransform
Inherited from PixiContainer.updateTransform
- Defined in node_modules/pixi.js/pixi.js.d.ts:8431

`Static` mixin

mixin(source): void
Mixes all enumerable properties and methods from a source object to DisplayObject.
Parameters
- source: any
  The source of properties and methods to mix in.
Returns void
Inherited from PixiContainer.mixin
- Defined in node_modules/pixi.js/pixi.js.d.ts:9230

Class Container

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Container

Properties

_accessibleActive

Member

Memberof

Todo

_accessibleDiv

Member

Memberof

Todo

_bounds

Member

Protected _boundsID

Member

Protected _boundsRect

Member

Private _createjsData

Type declaration

controller: CreatejsController

Protected _destroyed

Member

Protected _enabledFilters

Member

Protected _lastSortedIndex

Member

_localBounds

Member

Protected _localBoundsRect

Member

Protected _mask

Member

Protected _tempDisplayObjectParent

Member

Protected _zIndex

Member

accessible

Member

Memberof

accessibleChildren

Member

Memberof

Default

accessibleHint

Member

Memberof

accessiblePointerEvents

Member

Memberof

Default

accessibleTitle

Member

Memberof

accessibleType

Member

Memberof

Default

alpha

Member

angle

Member

buttonMode

Example

Member

Memberof

cacheAsBitmap

Member

Memberof

Readonly children

Member

cursor

Example

`Protected` _boundsID

`Protected` _boundsRect

`Private` _createjsData

`Protected` _destroyed

`Protected` _enabledFilters

`Protected` _lastSortedIndex

`Protected` _localBoundsRect

`Protected` _mask

`Protected` _tempDisplayObjectParent

`Protected` _zIndex

`Readonly` children

`Readonly` localTransform

`Readonly` worldAlpha

`Readonly` worldTransform

`Readonly` worldVisible