Winter Cardinal UI - v0.442.0 / DMenuSided

Class: DMenuSided<VALUE, THEME, CONTENT_OPTIONS, OPTIONS>

A base class for UI classes. See DBaseEvents for event details.

Type parameters

Name	Type
`VALUE`	`unknown`
`THEME`	extends `DThemeMenuSided` = `DThemeMenuSided`
`CONTENT_OPTIONS`	extends `DMenuSidedContentOptions` = `DMenuSidedContentOptions`
`OPTIONS`	extends `DMenuSidedOptions`<`VALUE`, `THEME`, `CONTENT_OPTIONS`> = `DMenuSidedOptions`<`VALUE`, `THEME`, `CONTENT_OPTIONS`>

Hierarchy

DPane<THEME, CONTENT_OPTIONS, OPTIONS>

↳ DMenuSided

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new DMenuSided<VALUE, THEME, CONTENT_OPTIONS, OPTIONS>(options?): DMenuSided<VALUE, THEME, CONTENT_OPTIONS, OPTIONS>

Type parameters

Name	Type
`VALUE`	`unknown`
`THEME`	extends `DThemeMenuSided` = `DThemeMenuSided`
`CONTENT_OPTIONS`	extends `DMenuSidedContentOptions`<`DThemeMenuSidedContent`> = `DMenuSidedContentOptions`<`DThemeMenuSidedContent`>
`OPTIONS`	extends `DMenuSidedOptions`<`VALUE`, `THEME`, `CONTENT_OPTIONS`> = `DMenuSidedOptions`<`VALUE`, `THEME`, `CONTENT_OPTIONS`>

Parameters

Name	Type
`options?`	`OPTIONS`

Returns

DMenuSided<VALUE, THEME, CONTENT_OPTIONS, OPTIONS>

Overrides

DPane.constructor

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:42

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DPane._accessibleActive

Defined in

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

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DPane._accessibleDiv

Defined in

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

_auto

• Protected _auto: DBaseAutoSet

Inherited from

DPane._auto

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:777

_background

• Protected _background: DBackgroundStateAware

Inherited from

DPane._background

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:788

_border

• Protected _border: DBorderStateAware

Inherited from

DPane._border

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:789

_bounds

• _bounds: Bounds

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

Member

PIXI.DisplayObject#_bounds

Inherited from

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

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

DPane._boundsRect

Defined in

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

_clearType

• Protected _clearType: number

Inherited from

DPane._clearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:791

_content

• Protected Optional _content: DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Inherited from

DPane._content

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:67

_context

• Protected _context: null | DMenuContext

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:39

_corner

• Protected _corner: DCorner

Inherited from

DPane._corner

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:775

_cursor

• Protected Optional _cursor: DStateAwareOrValueMightBe<string>

Inherited from

DPane._cursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:796

_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

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

DPane._enabledFilters

Defined in

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

_lastDownPoint

• Protected Optional _lastDownPoint: Point

Inherited from

DPane._lastDownPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:795

_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

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

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

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

DPane._mask

Defined in

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

_options

• Protected _options: undefined | OPTIONS

Inherited from

DPane._options

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:771

_outline

• Protected _outline: DOutline

Inherited from

DPane._outline

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:790

_overflowMask

• Protected Optional _overflowMask: null | Graphics

Inherited from

DPane._overflowMask

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:68

_padding

• Protected _padding: DPadding

Inherited from

DPane._padding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:774

_reflowable

• Protected _reflowable: DBaseReflowableContainer

Inherited from

DPane._reflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:794

_scrollbar

• Protected Optional _scrollbar: DPaneScrollBar<DPaneScrollBarParent>

Inherited from

DPane._scrollbar

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:69

_selection

• Protected _selection: DMenuSidedSelection<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:40

_shortcuts

• Protected Optional _shortcuts: UtilKeyboardEventShortcut[]

Inherited from

DPane._shortcuts

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:792

_snippet

• Protected _snippet: DBaseSnippetContainer

Inherited from

DPane._snippet

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:793

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

DPane._tempDisplayObjectParent

Defined in

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

_title

• Protected _title: string

Inherited from

DPane._title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:787

_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

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

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

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

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

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

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

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

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

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

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

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

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

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

DPane.filterArea

Defined in

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

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

Inherited from

DPane.filters

Defined in

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

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

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

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

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

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

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

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

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

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

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

DPane.pivot

Defined in

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

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

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

DPane.rotation

Defined in

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

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

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

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

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

DPane.visible

Defined in

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

worldAlpha

• Readonly worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

Inherited from

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

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

DPane.worldVisible

Defined in

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

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

DPane.zIndex

Defined in

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

WORK_CONTAINS_POINT

▪ Static Protected WORK_CONTAINS_POINT: Point

Inherited from

DPane.WORK_CONTAINS_POINT

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:767

WORK_POINT

▪ Static Protected Optional WORK_POINT: Point

Inherited from

DPane.WORK_POINT

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:64

WORK_RECTANGLE

▪ Static Protected Optional WORK_RECTANGLE: Rectangle

Inherited from

DPane.WORK_RECTANGLE

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:65

Accessors

background

• get background(): DBackgroundStateAware

Returns

DBackgroundStateAware

Inherited from

DPane.background

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1471

border

• get border(): DBorderStateAware

Returns

DBorderStateAware

Inherited from

DPane.border

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1475

content

• get content(): DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Returns

DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Inherited from

DPane.content

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:177

corner

• get corner(): DCorner

Returns

DCorner

Inherited from

DPane.corner

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1467

height

• get height(): number

Returns

number

Inherited from

DPane.height

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1390

• set height(height): void

Parameters

Name	Type
`height`	`DCoordinateSize`

Returns

void

Inherited from

DPane.height

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1394

options

• get options(): undefined | OPTIONS

Returns

undefined | OPTIONS

Inherited from

DPane.options

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1690

outline

• get outline(): DOutline

Returns

DOutline

Inherited from

DPane.outline

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1479

padding

• get padding(): DPadding

Returns

DPadding

Inherited from

DPane.padding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1463

position

• get position(): DBasePoint

Returns

DBasePoint

Inherited from

DPane.position

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1449

reflowable

• get reflowable(): DBaseReflowableContainer

Returns

DBaseReflowableContainer

Inherited from

DPane.reflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1120

scale

• get scale(): DBasePoint

Returns

DBasePoint

Inherited from

DPane.scale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1454

scrollbar

• get scrollbar(): DPaneScrollBar<DPaneScrollBarParent>

Returns

DPaneScrollBar<DPaneScrollBarParent>

Inherited from

DPane.scrollbar

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:121

selection

• get selection(): DMenuSidedSelection<VALUE>

Returns

DMenuSidedSelection<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:83

shadow

• get shadow(): null | DShadow

Returns

null | DShadow

Inherited from

DPane.shadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1853

• set shadow(shadow): void

Parameters

Name	Type
`shadow`	`null` \| `DShadow`

Returns

void

Inherited from

DPane.shadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1857

skew

• get skew(): DBasePoint

Returns

DBasePoint

Inherited from

DPane.skew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1459

snippet

• get snippet(): DBaseSnippetContainer

Returns

DBaseSnippetContainer

Inherited from

DPane.snippet

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1116

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

DPane.state

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1686

theme

• get theme(): THEME

Returns

THEME

Inherited from

DPane.theme

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1694

• set theme(theme): void

Parameters

Name	Type
`theme`	`THEME`

Returns

void

Inherited from

DPane.theme

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1698

title

• get title(): string

Returns

string

Inherited from

DPane.title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1487

• set title(title): void

Parameters

Name	Type
`title`	`string`

Returns

void

Inherited from

DPane.title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1491

type

• get type(): string

Returns

string

Inherited from

DPane.type

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1246

unsafe

• get unsafe(): Transform

Returns

Transform

Inherited from

DPane.unsafe

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1483

weight

• get weight(): number

Returns

number

Inherited from

DPane.weight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1141

• set weight(weight): void

Parameters

Name	Type
`weight`	`number`

Returns

void

Inherited from

DPane.weight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1145

width

• get width(): number

Returns

number

Inherited from

DPane.width

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1331

• set width(width): void

Parameters

Name	Type
`width`	`DCoordinateSize`

Returns

void

Inherited from

DPane.width

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1335

x

• get x(): number

Returns

number

Inherited from

DPane.x

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1251

• set x(x): void

Parameters

Name	Type
`x`	`DCoordinatePosition`

Returns

void

Inherited from

DPane.x

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1255

y

• get y(): number

Returns

number

Inherited from

DPane.y

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1291

• set y(y): void

Parameters

Name	Type
`y`	`DCoordinatePosition`

Returns

void

Inherited from

DPane.y

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1295

Methods

_calculateBounds

▸ _calculateBounds(): void

Returns

void

Inherited from

DPane._calculateBounds

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2084

_recursivePostUpdateTransform

▸ _recursivePostUpdateTransform(): void

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

Returns

void

Inherited from

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

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

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

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

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

DPane.addListener

Defined in

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

applyTitle

▸ applyTitle(): void

Returns

void

Inherited from

DPane.applyTitle

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1500

blur

▸ blur(recursively?): this

Parameters

Name	Type
`recursively?`	`boolean`

Returns

this

Inherited from

DPane.blur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1606

calculateBounds

▸ calculateBounds(): void

Recalculates the bounds of the container.

Returns

void

Inherited from

DPane.calculateBounds

Defined in

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

close

▸ close(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:99

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

DPane.containerUpdateTransform

Defined in

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

containsGlobalPoint

▸ containsGlobalPoint(point): boolean

Parameters

Name	Type
`point`	`Point`

Returns

boolean

Inherited from

DPane.containsGlobalPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2098

containsLocalPoint

▸ containsLocalPoint(point): boolean

Parameters

Name	Type
`point`	`Point`

Returns

boolean

Inherited from

DPane.containsLocalPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2102

containsPoint

▸ containsPoint(point): boolean

Parameters

Name	Type
`point`	`Point`

Returns

boolean

Inherited from

DPane.containsPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2089

destroy

▸ destroy(): void

Returns

void

Inherited from

DPane.destroy

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:382

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name	Type	Description
`cacheParent`	`DisplayObject`	actual parent of element

Returns

void

Inherited from

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

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

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

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

DPane.eventNames

Defined in

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

focus

▸ focus(): this

Returns

this

Inherited from

DPane.focus

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1602

focusOnClosest

▸ focusOnClosest(): void

Returns

void

Inherited from

DPane.focusOnClosest

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2019

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

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

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

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

DPane.getChildIndex

Defined in

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

getClearType

▸ getClearType(): number

Returns

number

Inherited from

DPane.getClearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1215

getClippingRect

▸ getClippingRect(target, result): void

Returns a clipping rect.

Parameters

Name	Type	Description
`target`	`unknown`	-
`result`	`Rectangle`	a clipping rect

Returns

void

Inherited from

DPane.getClippingRect

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2115

getCloseable

▸ getCloseable(): null | DMenuCloseable

Returns

null | DMenuCloseable

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:91

getContext

▸ getContext(): null | DMenuContext

Returns

null | DMenuContext

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:87

getFocusedChildClippingRect

▸ getFocusedChildClippingRect(focused, contentX, contentY, contentWidth, contentHeight, width, height, result): Rectangle

Parameters

Name	Type
`focused`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`contentX`	`number`
`contentY`	`number`
`contentWidth`	`number`
`contentHeight`	`number`
`width`	`number`
`height`	`number`
`result`	`Rectangle`

Returns

Rectangle

Inherited from

DPane.getFocusedChildClippingRect

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:283

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

DPane.getGlobalPosition

Defined in

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

getHeight

▸ getHeight(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DPane.getHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1398

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

DPane.getLocalBounds

Defined in

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

getOverflowMask

▸ getOverflowMask(): null | Graphics

Returns

null | Graphics

Inherited from

DPane.getOverflowMask

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:212

getParentOfSize

▸ getParentOfSize(): null | { height: number ; padding: DPadding ; width: number }

Returns

null | { height: number ; padding: DPadding ; width: number }

Inherited from

DPane.getParentOfSize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1887

getThemeDefault

▸ getThemeDefault(): THEME

Returns

THEME

Inherited from

DPane.getThemeDefault

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2075

getType

▸ getType(): string

Returns

string

Overrides

DPane.getType

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:108

getWheelContentX

▸ getWheelContentX(content, delta): number

Parameters

Name	Type
`content`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`delta`	`number`

Returns

number

Inherited from

DPane.getWheelContentX

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:243

getWheelContentY

▸ getWheelContentY(content, delta): number

Parameters

Name	Type
`content`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`delta`	`number`

Returns

number

Inherited from

DPane.getWheelContentY

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:251

getWidth

▸ getWidth(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DPane.getWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1339

getX

▸ getX(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DPane.getX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1259

getY

▸ getY(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DPane.getY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1299

hasDirty

▸ hasDirty(): boolean

Returns

boolean

Inherited from

DPane.hasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1588

hasRefitableHeight

▸ hasRefitableHeight(target): target is DRefitable

Returns true if the given target has a height that doesn’t depend on its parent height.

Parameters

Name	Type	Description
`target`	`any`	a target

Returns

target is DRefitable

true if the given target has a height that doesn’t depend on its parent height.

Inherited from

DPane.hasRefitableHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1831

hasRefitableWidth

▸ hasRefitableWidth(target): target is DRefitable

Returns true if the given target has a width that doesn’t depend on its parent width.

Parameters

Name	Type	Description
`target`	`any`	a target

Returns

target is DRefitable

true if the given target has a width that doesn’t depend on its parent width.

Inherited from

DPane.hasRefitableWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1843

hide

▸ hide(): this

Returns

this

Inherited from

DPane.hide

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1520

init

▸ init(options?): void

Parameters

Name	Type
`options?`	`OPTIONS`

Returns

void

Inherited from

DPane.init

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1137

initContent

▸ initContent(content): void

Parameters

Name	Type
`content`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>

Returns

void

Inherited from

DPane.initContent

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:203

initGesture

▸ initGesture(theme, options?): void

Parameters

Name	Type
`theme`	`THEME`
`options?`	`OPTIONS`

Returns

void

Inherited from

DPane.initGesture

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:94

initReflowable

▸ initReflowable(): void

Returns

void

Inherited from

DPane.initReflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1124

initScrollBar

▸ initScrollBar(scrollbar): void

Parameters

Name	Type
`scrollbar`	`DPaneScrollBar`<`DPaneScrollBarParent`>

Returns

void

Inherited from

DPane.initScrollBar

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:141

isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

DPane.isDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1584

isEventTarget

▸ isEventTarget(e): boolean

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

boolean

Inherited from

DPane.isEventTarget

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1965

isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DPane.isHidden

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1530

isHierarchyDirty

▸ isHierarchyDirty(): boolean

Returns

boolean

Inherited from

DPane.isHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1576

isRefitable

▸ isRefitable(target): target is DBase<any, any>

Parameters

Name	Type
`target`	`any`

Returns

target is DBase<any, any>

Inherited from

DPane.isRefitable

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:267

isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

DPane.isShown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1516

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

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

DPane.listeners

Defined in

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

newContent

▸ newContent(options?): DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Parameters

Name	Type
`options?`	`CONTENT_OPTIONS`

Returns

DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Overrides

DPane.newContent

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:79

newItems

▸ newItems(items, sticky): void

Parameters

Name	Type
`items`	(`DisplayObject` \| `DMenuItemOptionsUnion`<`VALUE`>)[]
`sticky`	`boolean`

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:72

newOverflowMask

▸ newOverflowMask(): null | Graphics

Returns

null | Graphics

Inherited from

DPane.newOverflowMask

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:221

newPadding

▸ newPadding(theme, options?, callback?): DBasePadding

Parameters

Name	Type
`theme`	`THEME`
`options?`	`OPTIONS`
`callback?`	() => `void`

Returns

DBasePadding

Inherited from

DPane.newPadding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1095

newScrollBar

▸ newScrollBar(options?): DPaneScrollBar<DPaneScrollBarParent>

Parameters

Name	Type
`options?`	`DPaneScrollBarOptions`

Returns

DPaneScrollBar<DPaneScrollBarParent>

Inherited from

DPane.newScrollBar

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:131

newSelection

▸ newSelection(options?): DMenuSidedSelection<VALUE>

Parameters

Name	Type
`options?`	`DMenuSidedSelectionOptions`<`any`>

Returns

DMenuSidedSelection<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:60

off

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

Parameters

Name	Type
`event`	`string`
`fn?`	`Function`
`context?`	`any`

Returns

this

Inherited from

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

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

DPane.on

Defined in

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

onBlur

▸ onBlur(): void

Returns

void

Inherited from

DPane.onBlur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1679

onChildBlur

▸ onChildBlur(blured): void

Parameters

Name	Type
`blured`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>

Returns

void

Inherited from

DPane.onChildBlur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1672

onChildFocus

▸ onChildFocus(focused): void

Parameters

Name	Type
`focused`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>

Returns

void

Inherited from

DPane.onChildFocus

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:300

onChildrenChange

▸ onChildrenChange(): void

Returns

void

Inherited from

DPane.onChildrenChange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1128

onContentChange

▸ onContentChange(): void

Returns

void

Inherited from

DPane.onContentChange

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:279

onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

Name	Type
`e`	`MouseEvent` \| `TouchEvent`
`interactionManager`	`InteractionManager`

Returns

boolean

Inherited from

DPane.onDblClick

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2051

onDown

▸ onDown(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onDown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1979

onDownThis

▸ onDownThis(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onDownThis

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1986

onFocus

▸ onFocus(): void

Returns

void

Inherited from

DPane.onFocus

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1665

onHierarchyDirty

▸ onHierarchyDirty(): void

Returns

void

Overrides

DPane.onHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:64

onKeyDown

▸ onKeyDown(e): boolean

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

boolean

Overrides

DPane.onKeyDown

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:103

onKeyUp

▸ onKeyUp(e): boolean

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

boolean

Inherited from

DPane.onKeyUp

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1959

onMove

▸ onMove(newX, newY, oldX, oldY): void

Parameters

Name	Type
`newX`	`number`
`newY`	`number`
`oldX`	`number`
`oldY`	`number`

Returns

void

Inherited from

DPane.onMove

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1153

onOut

▸ onOut(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onOut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2042

onOver

▸ onOver(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onOver

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:168

onParentMove

▸ onParentMove(newX, newY, oldX, oldY): void

Called when a parent moved.

Parameters

Name	Type	Description
`newX`	`number`	a new parent’s local x position
`newY`	`number`	a new parent’s local y position
`oldX`	`number`	an old parent’s local x position
`oldY`	`number`	an old parent’s local y position

Returns

void

Inherited from

DPane.onParentMove

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1943

onParentResize

▸ onParentResize(parentWidth, parentHeight, parentPadding): void

Called when a parent resized.

Parameters

Name	Type	Description
`parentWidth`	`number`	a parent’s local width
`parentHeight`	`number`	a parent’s local height
`parentPadding`	`DPadding`	-

Returns

void

Inherited from

DPane.onParentResize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1902

onRefit

▸ onRefit(): void

Returns

void

Inherited from

DPane.onRefit

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1739

onReflow

▸ onReflow(): void

Returns

void

Inherited from

DPane.onReflow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1849

onResize

▸ onResize(newWidth, newHeight, oldWidth, oldHeight): void

Parameters

Name	Type
`newWidth`	`number`
`newHeight`	`number`
`oldWidth`	`number`
`oldHeight`	`number`

Returns

void

Inherited from

DPane.onResize

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:271

onScale

▸ onScale(newX, newY, oldX, oldY): void

Parameters

Name	Type
`newX`	`number`
`newY`	`number`
`oldX`	`number`
`oldY`	`number`

Returns

void

Inherited from

DPane.onScale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1236

onScrollBarMoveX

▸ onScrollBarMoveX(start): void

Parameters

Name	Type
`start`	`number`

Returns

void

Inherited from

DPane.onScrollBarMoveX

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:150

onScrollBarMoveY

▸ onScrollBarMoveY(start): void

Parameters

Name	Type
`start`	`number`

Returns

void

Inherited from

DPane.onScrollBarMoveY

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:159

onScrollBarUpdate

▸ onScrollBarUpdate(isRegionVisible): void

Parameters

Name	Type
`isRegionVisible`	`boolean`

Returns

void

Inherited from

DPane.onScrollBarUpdate

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:137

onShortcut

▸ onShortcut(e): void

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

void

Inherited from

DPane.onShortcut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1133

onSkew

▸ onSkew(newX, newY, oldX, oldY): void

Parameters

Name	Type
`newX`	`number`
`newY`	`number`
`oldX`	`number`
`oldY`	`number`

Returns

void

Inherited from

DPane.onSkew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1241

onStateChange

▸ onStateChange(newState, oldState): void

Parameters

Name	Type
`newState`	`DBaseStateSet`
`oldState`	`DBaseStateSet`

Returns

void

Inherited from

DPane.onStateChange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1629

onUp

▸ onUp(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onUp

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1996

onUpThis

▸ onUpThis(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

DPane.onUpThis

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2003

onWheel

▸ onWheel(e, deltas, global): boolean

Parameters

Name	Type
`e`	`WheelEvent`
`deltas`	`UtilWheelEventDeltas`
`global`	`Point`

Returns

boolean

Inherited from

DPane.onWheel

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:228

once

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

Parameters

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

Returns

this

Inherited from

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

DPane.once

Defined in

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

open

▸ open(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided.ts:95

reflow

▸ reflow(): void

Returns

void

Inherited from

DPane.reflow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1712

removeAllListeners

▸ removeAllListeners(event?): this

Parameters

Name	Type
`event?`	`InteractionEventTypes`

Returns

this

Inherited from

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

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

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

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

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

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

DPane.removeListener

Defined in

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

render

▸ render(renderer): void

Parameters

Name	Type
`renderer`	`Renderer`

Returns

void

Inherited from

DPane.render

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2060

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

DPane.renderAdvanced

Defined in

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

resize

▸ resize(width?, height?): boolean

Parameters

Name	Type
`width?`	`number`
`height?`	`number`

Returns

boolean

Inherited from

DPane.resize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1165

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

DPane.setChildIndex

Defined in

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

setFocused

▸ setFocused(isFocused): this

Parameters

Name	Type
`isFocused`	`boolean`

Returns

this

Inherited from

DPane.setFocused

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1592

setHeight

▸ setHeight(height): void

Parameters

Name	Type
`height`	`DCoordinateSize`

Returns

void

Inherited from

DPane.setHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1402

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

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

DPane.setTransform

Defined in

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

setWidth

▸ setWidth(width): void

Parameters

Name	Type
`width`	`DCoordinateSize`

Returns

void

Inherited from

DPane.setWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1343

setX

▸ setX(x): void

Parameters

Name	Type
`x`	`DCoordinatePosition`

Returns

void

Inherited from

DPane.setX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1268

setY

▸ setY(y): void

Parameters

Name	Type
`y`	`DCoordinatePosition`

Returns

void

Inherited from

DPane.setY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1308

show

▸ show(): this

Returns

this

Inherited from

DPane.show

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1507

sortChildren

▸ sortChildren(): void

Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

Returns

void

Inherited from

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

DPane.swapChildren

Defined in

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

toContent

▸ toContent(options?): DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Parameters

Name	Type
`options?`	`OPTIONS`

Returns

DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Inherited from

DPane.toContent

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:187

toContentX

▸ toContentX(content, x): number

Parameters

Name	Type
`content`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`x`	`number`

Returns

number

Inherited from

DPane.toContentX

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:259

toContentY

▸ toContentY(content, y): number

Parameters

Name	Type
`content`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`y`	`number`

Returns

number

Inherited from

DPane.toContentY

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:263

toCursor

▸ toCursor(cursor, state): string

Parameters

Name	Type
`cursor`	`DStateAwareOrValueMightBe`<`string`>
`state`	`DBaseStateSet`

Returns

string

Inherited from

DPane.toCursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1099

toDirty

▸ toDirty(): boolean

Returns

boolean

Inherited from

DPane.toDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1534

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

DPane.toGlobal

Defined in

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

toHasDirty

▸ toHasDirty(): boolean

Returns

boolean

Inherited from

DPane.toHasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1543

toHierarchyDirty

▸ toHierarchyDirty(): boolean

Returns

boolean

Inherited from

DPane.toHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1559

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

DPane.toLocal

Defined in

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

toParentHasDirty

▸ toParentHasDirty(): void

Returns

void

Inherited from

DPane.toParentHasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1552

toParentHierarchyDirty

▸ toParentHierarchyDirty(): void

Returns

void

Inherited from

DPane.toParentHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1569

toParentResized

▸ toParentResized(): void

Returns

void

Inherited from

DPane.toParentResized

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1880

updateTransform

▸ updateTransform(): void

Returns

void

Inherited from

DPane.updateTransform

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2069

mixin

▸ mixin(source): void

Mixes all enumerable properties and methods from a source object to DisplayObject.

Parameters

Name	Type	Description
`source`	`any`	The source of properties and methods to mix in.

Returns

void

Inherited from

DPane.mixin

Defined in

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

Edit this page.

Class: DMenuSided<VALUE, THEME, CONTENT_OPTIONS, OPTIONS>

Type parameters

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Overrides

Defined in

Properties

_accessibleActive

Inherited from

Defined in

_accessibleDiv

Inherited from

Defined in

_auto

Inherited from

Defined in

_background

Inherited from

Defined in

_border

Inherited from

Defined in

_bounds

Inherited from

Defined in

_boundsID

Inherited from

Defined in

_boundsRect

Inherited from

Defined in

_clearType

Inherited from

Defined in

_content

Inherited from

Defined in

_context

Defined in

_corner

Inherited from

Defined in

_cursor

Inherited from

Defined in

_destroyed

Inherited from

Defined in

_enabledFilters

Inherited from

Defined in

_gestureUtil

Inherited from

Defined in

_lastDownPoint

Inherited from

Defined in

_lastSortedIndex

Inherited from

Defined in

_localBounds

Inherited from

Defined in

_localBoundsRect

Inherited from

Defined in

_mask

Inherited from

Defined in

_options

Inherited from