Winter Cardinal UI - v0.442.0 / DDiagramCanvasEditorSnapParent

Interface: DDiagramCanvasEditorSnapParent

Hierarchy

Table of contents

Properties

Methods

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

Container._accessibleActive

Defined in

node_modules/pixi.js/pixi.js.d.ts:8559

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

Container._accessibleDiv

Defined in

node_modules/pixi.js/pixi.js.d.ts:8565

_bounds

• _bounds: Bounds

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

Member

PIXI.DisplayObject#_bounds

Inherited from

Container._bounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8681

_boundsID

• Protected _boundsID: number

Flags the cached bounds as dirty.

Member

PIXI.DisplayObject#_boundsID

Inherited from

Container._boundsID

Defined in

node_modules/pixi.js/pixi.js.d.ts:8694

_boundsRect

• Protected _boundsRect: Bounds

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

Member

PIXI.DisplayObject#_boundsRect

Inherited from

Container._boundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:8701

_destroyed

• Protected _destroyed: boolean

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

Member

PIXI.DisplayObject#_destroyed

Inherited from

Container._destroyed

Defined in

node_modules/pixi.js/pixi.js.d.ts:8722

_enabledFilters

• Protected _enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

Inherited from

Container._enabledFilters

Defined in

node_modules/pixi.js/pixi.js.d.ts:8675

_lastSortedIndex

• Protected _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

Inherited from

Container._lastSortedIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8644

_localBounds

• _localBounds: Bounds

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

Member

PIXI.DisplayObject#_localBounds

Inherited from

Container._localBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8687

_localBoundsRect

• Protected _localBoundsRect: Bounds

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

Member

PIXI.DisplayObject#_localBoundsRect

Inherited from

Container._localBoundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:8708

_mask

• Protected _mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

Inherited from

Container._mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8715

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

Container._tempDisplayObjectParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8795

_zIndex

• Protected _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

Inherited from

Container._zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8652

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#

Inherited from

Container.accessible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8538

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

Inherited from

Container.accessibleChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8592

accessibleHint

• accessibleHint: string

Sets the aria-label attribute of the shadow div

Member

Memberof

PIXI.DisplayObject#

Inherited from

Container.accessibleHint

Defined in

node_modules/pixi.js/pixi.js.d.ts:8553

accessiblePointerEvents

• accessiblePointerEvents: string

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

Member

Memberof

PIXI.DisplayObject#

Default

'auto'

Inherited from

Container.accessiblePointerEvents

Defined in

node_modules/pixi.js/pixi.js.d.ts:8583

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#

Inherited from

Container.accessibleTitle

Defined in

node_modules/pixi.js/pixi.js.d.ts:8546

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'

Inherited from

Container.accessibleType

Defined in

node_modules/pixi.js/pixi.js.d.ts:8574

alpha

• alpha: number

The opacity of the object.

Member

PIXI.DisplayObject#alpha

Inherited from

Container.alpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:8605

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

Inherited from

Container.angle

Defined in

node_modules/pixi.js/pixi.js.d.ts:8882

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#

Inherited from

Container.buttonMode

Defined in

node_modules/pixi.js/pixi.js.d.ts:8964

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#

Inherited from

Container.cacheAsBitmap

Defined in

node_modules/pixi.js/pixi.js.d.ts:8991

children

• Readonly children: DisplayObject[]

The array of children of this container.

Member

PIXI.Container#children

Inherited from

Container.children

Defined in

node_modules/pixi.js/pixi.js.d.ts:8327

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#

Inherited from

Container.cursor

Defined in

node_modules/pixi.js/pixi.js.d.ts:8978

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

Inherited from

Container.filterArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:8661

filters

• filters: Filter[]

Sets the filters for the displayObject.

Member

PIXI.DisplayObject#filters

Inherited from

Container.filters

Defined in

node_modules/pixi.js/pixi.js.d.ts:8669

height

• Readonly height: number

Overrides

Container.height

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:81

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#

Inherited from

Container.hitArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:8952

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#

Inherited from

Container.interactive

Defined in

node_modules/pixi.js/pixi.js.d.ts:8940

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#

Inherited from

Container.interactiveChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8518

isMask

• isMask: boolean

Does any other displayObject use this object as a mask?

Member

PIXI.DisplayObject#isMask

Inherited from

Container.isMask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8732

isSprite

• isSprite: boolean

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

Member

PIXI.DisplayObject#isSprite

Inherited from

Container.isSprite

Defined in

node_modules/pixi.js/pixi.js.d.ts:8727

localTransform

• Readonly localTransform: Matrix

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

Member

Inherited from

Container.localTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8840

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

Inherited from

Container.mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8918

name

• name: string

The instance name of the object.

Memberof

PIXI.DisplayObject#

Member

name

Inherited from

Container.name

Defined in

node_modules/pixi.js/pixi.js.d.ts:8998

parent

• parent: Container

The display object container that contains this display object.

Member

PIXI.DisplayObject#parent

Inherited from

Container.parent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8629

pivot

• pivot: ObservablePoint

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

Member

Inherited from

Container.pivot

Defined in

node_modules/pixi.js/pixi.js.d.ts:8861

position

• position: ObservablePoint

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

Member

Inherited from

Container.position

Defined in

node_modules/pixi.js/pixi.js.d.ts:8847

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

Inherited from

Container.renderable

Defined in

node_modules/pixi.js/pixi.js.d.ts:8623

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

Inherited from

Container.rotation

Defined in

node_modules/pixi.js/pixi.js.d.ts:8875

scale

• scale: ObservablePoint

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

Member

Inherited from

Container.scale

Defined in

node_modules/pixi.js/pixi.js.d.ts:8854

skew

• skew: ObservablePoint

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

Member

Inherited from

Container.skew

Defined in

node_modules/pixi.js/pixi.js.d.ts:8868

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

Inherited from

Container.sortDirty

Defined in

node_modules/pixi.js/pixi.js.d.ts:8350

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

Inherited from

Container.sortableChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8343

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

Inherited from

Container.transform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8599

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

Inherited from

Container.visible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8614

width

• Readonly width: number

Overrides

Container.width

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:80

worldAlpha

• Readonly worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

Inherited from

Container.worldAlpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:8636

worldTransform

• Readonly worldTransform: Matrix

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

Member

Inherited from

Container.worldTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8833

worldVisible

• Readonly worldVisible: boolean

Indicates if the object is globally visible.

Member

Inherited from

Container.worldVisible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8898

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

Inherited from

Container.x

Defined in

node_modules/pixi.js/pixi.js.d.ts:8819

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

Inherited from

Container.y

Defined in

node_modules/pixi.js/pixi.js.d.ts:8826

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

Inherited from

Container.zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8891

Methods

_calculateBounds

▸ _calculateBounds(): void

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

Returns

void

Inherited from

Container._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

Inherited from

Container._recursivePostUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8737

_render

▸ _render(renderer): void

To be overridden by the subclasses.

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

Container._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

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to add to the container

Returns

TChildren[0]

The first child that was added.

Inherited from

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

Name Type
T extends DisplayObject

Parameters

Name Type Description
child T The child to add
index number The index to place the child in

Returns

T

The child that was added.

Inherited from

Container.addChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:8373

addListener

▸ addListener(event, fn, context?): this

Parameters

Name Type
event InteractionEventTypes
fn (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

Container.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25521

▸ addListener(event, fn, context?): this

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Inherited from

Container.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25523

calculateBounds

▸ calculateBounds(): void

Recalculates the bounds of the container.

Returns

void

Inherited from

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

Inherited from

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

Name Type Description
options? Object Options parameter. A boolean will act as if all options have been set to that value
options.baseTexture? boolean Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
options.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.
options.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

Inherited from

Container.destroy

Defined in

node_modules/pixi.js/pixi.js.d.ts:8486

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name Type Description
cacheParent DisplayObject actual parent of element

Returns

void

Inherited from

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

Inherited from

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

Name Type Description
event string | symbol The event name.
...args any[] Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

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

Inherited from

Container.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)[]

Inherited from

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

Name Type Description
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.
rect? Rectangle Optional rectangle to store the result of the bounds calculation.

Returns

Rectangle

The rectangular bounding area.

Inherited from

Container.getBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8747

getChildAt

▸ getChildAt(index): DisplayObject

Returns the child at the specified index

Parameters

Name Type Description
index number The index to get the child at

Returns

DisplayObject

The child at the given index, if any.

Inherited from

Container.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 Type Description
name string Instance name.
deep? boolean Whether to search recursively

Returns

DisplayObject

The child with the specified name.

Method

getChildByName

Memberof

PIXI.Container#

Inherited from

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

Name Type Description
child DisplayObject The DisplayObject instance to identify

Returns

number

The index position of the child display object to identify

Inherited from

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

Name Type Description
point? Point The point to write the global value to.
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#

Inherited from

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

Name Type Description
rect? Rectangle Optional rectangle to store the result of the bounds calculation.
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.

Inherited from

Container.getLocalBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8445

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

number

Inherited from

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

Name Type Description
event string | symbol The event name.

Returns

Function[]

Inherited from

Container.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

off

▸ off(event, fn?, context?): this

Parameters

Name Type
event string
fn? Function
context? any

Returns

this

Inherited from

Container.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25534

on

▸ on(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

Container.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25530

▸ on(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

Container.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25532

onChildrenChange

▸ onChildrenChange(): void

Overridable method that can be used by Container subclasses whenever the children array is modified

Returns

void

Inherited from

Container.onChildrenChange

Defined in

node_modules/pixi.js/pixi.js.d.ts:8356

once

▸ once(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

Container.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25527

▸ once(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

Container.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25529

removeAllListeners

▸ removeAllListeners(event?): this

Parameters

Name Type
event? InteractionEventTypes

Returns

this

Inherited from

Container.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25516

▸ removeAllListeners(event?): this

Parameters

Name Type
event? string | symbol

Returns

this

Inherited from

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

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to remove

Returns

TChildren[0]

The first child that was removed.

Inherited from

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

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

Returns

DisplayObject

The child that was removed.

Inherited from

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

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

Returns

DisplayObject[]

List of removed children

Inherited from

Container.removeChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8423

removeListener

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event InteractionEventTypes
fn? (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

Container.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25513

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event string | symbol
fn? Function
context? any

Returns

this

Inherited from

Container.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25515

render

▸ render(renderer): void

Renders the object using the WebGL renderer

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

Container.render

Defined in

node_modules/pixi.js/pixi.js.d.ts:8458

renderAdvanced

▸ renderAdvanced(renderer): void

Render the object using the WebGL renderer and advanced features.

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

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

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

Returns

void

Inherited from

Container.setChildIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8394

setParent

▸ setParent(container): Container

Set the parent Container of this DisplayObject.

Parameters

Name Type Description
container Container The Container to add this DisplayObject to.

Returns

Container

The Container that this DisplayObject was added to.

Inherited from

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

Name Type Description
x? number The X position
y? number The Y position
scaleX? number The X scale value
scaleY? number The Y scale value
rotation? number The rotation
skewX? number The X skew value
skewY? number The Y skew value
pivotX? number The X pivot value
pivotY? number The Y pivot value

Returns

DisplayObject

The DisplayObject instance

Inherited from

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

Inherited from

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

Name Type Description
child DisplayObject First display object to swap
child2 DisplayObject Second display object to swap

Returns

void

Inherited from

Container.swapChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8380

toDirty

▸ toDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:82

toGlobal

▸ toGlobal(position, point?, skipUpdate?): Point

Calculates the global position of the display object.

Parameters

Name Type Description
position IPointData The world origin to calculate from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform.

Returns

Point

A point object representing the position of this object.

Inherited from

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

Name Type Description
position IPointData The world origin to calculate from.
from? DisplayObject The DisplayObject to calculate the global position from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform

Returns

Point

A point object representing the position of this object

Inherited from

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

Inherited from

Container.updateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8431

Edit this page.