Winter Cardinal UI - v0.442.0 / DDialogSelect

Class: DDialogSelect<VALUE, CATEGORY_ID, THEME, OPTIONS>

A dialog with a header, a content and a footer.

Type parameters

Name	Type
`VALUE`	`unknown`
`CATEGORY_ID`	`unknown`
`THEME`	extends `DThemeDialogSelect`<`VALUE`, `CATEGORY_ID`> = `DThemeDialogSelect`<`VALUE`, `CATEGORY_ID`>
`OPTIONS`	extends `DDialogSelectOptions`<`VALUE`, `CATEGORY_ID`, `THEME`> = `DDialogSelectOptions`<`VALUE`, `CATEGORY_ID`, `THEME`>

Hierarchy

DDialogLayered<VALUE | null, THEME, OPTIONS>

↳ DDialogSelect

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new DDialogSelect<VALUE, CATEGORY_ID, THEME, OPTIONS>(options?): DDialogSelect<VALUE, CATEGORY_ID, THEME, OPTIONS>

Type parameters

Name	Type
`VALUE`	`unknown`
`CATEGORY_ID`	`unknown`
`THEME`	extends `DThemeDialogSelect`<`VALUE`, `CATEGORY_ID`> = `DThemeDialogSelect`<`VALUE`, `CATEGORY_ID`>
`OPTIONS`	extends `DDialogSelectOptions`<`VALUE`, `CATEGORY_ID`, `THEME`, `any`> = `DDialogSelectOptions`<`VALUE`, `CATEGORY_ID`, `THEME`, `any`>

Parameters

Name	Type
`options?`	`OPTIONS`

Returns

DDialogSelect<VALUE, CATEGORY_ID, THEME, OPTIONS>

Overrides

DDialogLayered.constructor

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:155

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DDialogLayered._accessibleActive

Defined in

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

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DDialogLayered._accessibleDiv

Defined in

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

_align

• Protected _align: null | UtilAttachAlign

Inherited from

DDialogLayered._align

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:129

_animation

• Protected Optional _animation: null | DAnimation<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Inherited from

DDialogLayered._animation

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:122

_auto

• Protected _auto: DBaseAutoSet

Inherited from

DDialogLayered._auto

Defined in

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

_background

• Protected _background: DBackgroundStateAware

Inherited from

DDialogLayered._background

Defined in

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

_border

• Protected _border: DBorderStateAware

Inherited from

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

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

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

DDialogLayered._boundsRect

Defined in

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

_buttonDismiss

• Protected Optional _buttonDismiss: null | DButton<string, DThemeButton<string>, DButtonOptions<string, DThemeButton<string>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:153

_categories

• Protected _categories: DDialogSelectCategory<CATEGORY_ID>[]

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:145

_clearType

• Protected _clearType: number

Inherited from

DDialogLayered._clearType

Defined in

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

_closeOn

• Protected _closeOn: number

_corner

• Protected _corner: DCorner

Inherited from

DDialogLayered._corner

Defined in

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

_cursor

• Protected Optional _cursor: DStateAwareOrValueMightBe<string>

Inherited from

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

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

DDialogLayered._enabledFilters

Defined in

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

_focused

• Protected Optional _focused: null | DFocusable

Inherited from

DDialogLayered._focused

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:124

_footer

• Protected Optional _footer: null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Inherited from

DDialogLayered._footer

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:99

_gesture

• Protected _gesture: DDialogGesture<DDialogSelect<VALUE, CATEGORY_ID, THEME, OPTIONS>>

Inherited from

DDialogLayered._gesture

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:132

_header

• Protected Optional _header: null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Inherited from

DDialogLayered._header

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:97

_input

• Protected Optional _input: DInputSearch<DThemeInputSearch, DInputSearchOptions<DThemeInputSearch>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:146

_inputLayout

• Protected Optional _inputLayout: DLayoutHorizontal<DThemeLayoutHorizontal, DLayoutHorizontalOptions<DThemeLayoutHorizontal>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:147

_isCategoryFetched

• Protected Optional _isCategoryFetched: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:144

_lastDownPoint

• Protected Optional _lastDownPoint: Point

Inherited from

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

DDialogLayered._lastSortedIndex

Defined in

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

_layer

• Protected _layer: null | DApplicationLayerLike

Inherited from

DDialogLayered._layer

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:133

_layout

• Protected Optional _layout: DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Inherited from

DDialogLayered._layout

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:95

_list

• Protected Optional _list: DDialogSelectList<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions, DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:148

_localBounds

• _localBounds: Bounds

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

Member

PIXI.DisplayObject#_localBounds

Inherited from

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

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

DDialogLayered._mask

Defined in

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

_mode

• Protected _mode: DDialogMode

Inherited from

DDialogLayered._mode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:126

_noteError

• Protected Optional _noteError: null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

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

_noteNoItemsFound

• Protected Optional _noteNoItemsFound: null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:151

_noteSearching

• Protected Optional _noteSearching: null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:152

_onPrerenderBound

• Protected _onPrerenderBound: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

DDialogLayered._onPrerenderBound

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:128

_opener

• Protected Optional _opener: null | DDialogOpener

Inherited from

DDialogLayered._opener

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:130

_options

• Protected _options: undefined | OPTIONS

Inherited from

DDialogLayered._options

Defined in

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

_outline

• Protected _outline: DOutline

Inherited from

DDialogLayered._outline

Defined in

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

_overlay

• Protected _overlay: UtilOverlay

Inherited from

DDialogLayered._overlay

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:125

_padding

• Protected _padding: DPadding

Inherited from

DDialogLayered._padding

Defined in

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

_promise

• Protected Optional _promise: Promise<null | VALUE>

Inherited from

DDialogLayered._promise

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:118

_reflowable

• Protected _reflowable: DBaseReflowableContainer

Inherited from

DDialogLayered._reflowable

Defined in

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

_reject

• Protected Optional _reject: (reason?: any) => void

Type declaration

▸ (reason?): void

Parameters

Name	Type
`reason?`	`any`

Returns

void

Inherited from

DDialogLayered._reject

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:120

_resolve

• Protected Optional _resolve: (value: null | VALUE | PromiseLike<null | VALUE>) => void

Type declaration

▸ (value): void

Parameters

Name	Type
`value`	`null` \| `VALUE` \| `PromiseLike`<`null` \| `VALUE`>

Returns

void

Inherited from

DDialogLayered._resolve

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:119

_search

• Protected Optional _search: DDialogSelectSearch<VALUE, CATEGORY_ID>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:149

_selectCategory

• Protected Optional _selectCategory: DSelect<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:143

_shortcuts

• Protected Optional _shortcuts: UtilKeyboardEventShortcut[]

Inherited from

DDialogLayered._shortcuts

Defined in

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

_snippet

• Protected _snippet: DBaseSnippetContainer

Inherited from

DDialogLayered._snippet

Defined in

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

_sticky

• Protected _sticky: boolean

Inherited from

DDialogLayered._sticky

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:127

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

DDialogLayered._tempDisplayObjectParent

Defined in

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

_title

• Protected _title: string

Inherited from

DDialogLayered._title

Defined in

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

_value

• Protected _value: null | VALUE

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:142

_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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DDialogLayered.zIndex

Defined in

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

WORK_BOUNDS

▪ Static Protected Optional WORK_BOUNDS: Rectangle

Inherited from

DDialogLayered.WORK_BOUNDS

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:116

WORK_CONTAINS_POINT

▪ Static Protected WORK_CONTAINS_POINT: Point

Inherited from

DDialogLayered.WORK_CONTAINS_POINT

Defined in

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

Accessors

algin

• set algin(align): void

Parameters

Name	Type
`align`	`null` \| `UtilAttachAlign`

Returns

void

Inherited from

DDialogLayered.algin

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:223

align

• get align(): null | UtilAttachAlign

Returns

null | UtilAttachAlign

Inherited from

DDialogLayered.align

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:219

background

• get background(): DBackgroundStateAware

Returns

DBackgroundStateAware

Inherited from

DDialogLayered.background

Defined in

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

border

• get border(): DBorderStateAware

Returns

DBorderStateAware

Inherited from

DDialogLayered.border

Defined in

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

buttonDismiss

• get buttonDismiss(): null | DButton<string, DThemeButton<string>, DButtonOptions<string, DThemeButton<string>, any>>

Returns

null | DButton<string, DThemeButton<string>, DButtonOptions<string, DThemeButton<string>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:385

content

• get content(): DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Returns

DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Inherited from

DDialogLayered.content

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:170

corner

• get corner(): DCorner

Returns

DCorner

Inherited from

DDialogLayered.corner

Defined in

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

• get footer(): null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Returns

null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Inherited from

DDialogLayered.footer

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:195

gesture

• get gesture(): DDialogGesture<this>

Returns

DDialogGesture<this>

Inherited from

DDialogLayered.gesture

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:227

• get header(): null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Returns

null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Inherited from

DDialogLayered.header

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:140

height

• get height(): number

Returns

number

Inherited from

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

DDialogLayered.height

Defined in

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

input

• get input(): DInputSearch<DThemeInputSearch, DInputSearchOptions<DThemeInputSearch>>

Returns

DInputSearch<DThemeInputSearch, DInputSearchOptions<DThemeInputSearch>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:249

inputLayout

• get inputLayout(): DLayoutHorizontal<DThemeLayoutHorizontal, DLayoutHorizontalOptions<DThemeLayoutHorizontal>>

Returns

DLayoutHorizontal<DThemeLayoutHorizontal, DLayoutHorizontalOptions<DThemeLayoutHorizontal>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:199

layer

• get layer(): null | DApplicationLayerLike

Returns

null | DApplicationLayerLike

Inherited from

DDialogLayered.layer

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:231

layout

• get layout(): DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Returns

DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Inherited from

DDialogLayered.layout

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:106

list

• get list(): DDialogSelectList<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions, DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>>

Returns

DDialogSelectList<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions, DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:281

mode

• get mode(): DDialogMode

Returns

DDialogMode

Inherited from

DDialogLayered.mode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:215

noteError

• get noteError(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:310

noteNoItemsFound

• get noteNoItemsFound(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:322

noteSearching

• get noteSearching(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:334

options

• get options(): undefined | OPTIONS

Returns

undefined | OPTIONS

Inherited from

DDialogLayered.options

Defined in

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

outline

• get outline(): DOutline

Returns

DOutline

Inherited from

DDialogLayered.outline

Defined in

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

padding

• get padding(): DPadding

Returns

DPadding

Inherited from

DDialogLayered.padding

Defined in

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

position

• get position(): DBasePoint

Returns

DBasePoint

Inherited from

DDialogLayered.position

Defined in

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

reflowable

• get reflowable(): DBaseReflowableContainer

Returns

DBaseReflowableContainer

Inherited from

DDialogLayered.reflowable

Defined in

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

scale

• get scale(): DBasePoint

Returns

DBasePoint

Inherited from

DDialogLayered.scale

Defined in

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

search

• get search(): DDialogSelectSearch<VALUE, CATEGORY_ID>

Returns

DDialogSelectSearch<VALUE, CATEGORY_ID>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:365

selectCategory

• get selectCategory(): DSelect<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>>

Returns

DSelect<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:217

shadow

• get shadow(): null | DShadow

Returns

null | DShadow

Inherited from

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

DDialogLayered.shadow

Defined in

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

skew

• get skew(): DBasePoint

Returns

DBasePoint

Inherited from

DDialogLayered.skew

Defined in

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

snippet

• get snippet(): DBaseSnippetContainer

Returns

DBaseSnippetContainer

Inherited from

DDialogLayered.snippet

Defined in

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

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

DDialogLayered.state

Defined in

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

theme

• get theme(): THEME

Returns

THEME

Inherited from

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

DDialogLayered.theme

Defined in

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

title

• get title(): string

Returns

string

Inherited from

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

DDialogLayered.title

Defined in

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

type

• get type(): string

Returns

string

Inherited from

DDialogLayered.type

Defined in

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

unsafe

• get unsafe(): Transform

Returns

Transform

Inherited from

DDialogLayered.unsafe

Defined in

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

value

• get value(): null | VALUE

Returns

null | VALUE

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:438

weight

• get weight(): number

Returns

number

Inherited from

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

DDialogLayered.weight

Defined in

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

width

• get width(): number

Returns

number

Inherited from

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

DDialogLayered.width

Defined in

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

x

• get x(): number

Returns

number

Inherited from

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

DDialogLayered.x

Defined in

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

y

• get y(): number

Returns

number

Inherited from

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

DDialogLayered.y

Defined in

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

Methods

_calculateBounds

▸ _calculateBounds(): void

Returns

void

Inherited from

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

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

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

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

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

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

DDialogLayered.addListener

Defined in

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

applyTitle

▸ applyTitle(): void

Returns

void

Inherited from

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

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

DDialogLayered.calculateBounds

Defined in

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

cancel

▸ cancel(): void

Returns

void

Inherited from

DDialogLayered.cancel

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:238

close

▸ close(): void

Returns

void

Inherited from

DDialogLayered.close

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:425

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

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

DDialogLayered.containsGlobalPoint

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:508

containsLocalPoint

▸ containsLocalPoint(point): boolean

Parameters

Name	Type
`point`	`Point`

Returns

boolean

Inherited from

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

DDialogLayered.containsPoint

Defined in

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

destroy

▸ destroy(): void

Returns

void

Overrides

DDialogLayered.destroy

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:511

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

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

Returns

void

Inherited from

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

DDialogLayered.displayObjectUpdateTransform

Defined in

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

doReject

▸ doReject(reason?): void

Parameters

Name	Type
`reason?`	`any`

Returns

void

Inherited from

DDialogLayered.doReject

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:442

doResolve

▸ doResolve(value): void

Parameters

Name	Type
`value`	`null` \| `VALUE` \| `PromiseLike`<`null` \| `VALUE`>

Returns

void

Inherited from

DDialogLayered.doResolve

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:429

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

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

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

DDialogLayered.eventNames

Defined in

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

findFirstFocusable

▸ findFirstFocusable(focusController): null | DFocusable

Parameters

Name	Type
`focusController`	`DControllerFocus`

Returns

null | DFocusable

Inherited from

DDialogLayered.findFirstFocusable

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:225

focus

▸ focus(): this

Returns

this

Inherited from

DDialogLayered.focus

Defined in

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

focusOnClosest

▸ focusOnClosest(): void

Returns

void

Inherited from

DDialogLayered.focusOnClosest

Defined in

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

getAnimation

▸ getAnimation(): null | DAnimation<unknown>

Returns

null | DAnimation<unknown>

Inherited from

DDialogLayered.getAnimation

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:280

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

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

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

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

DDialogLayered.getChildIndex

Defined in

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

getClearType

▸ getClearType(): number

Returns

number

Inherited from

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

DDialogLayered.getClippingRect

Defined in

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

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

DDialogLayered.getGlobalPosition

Defined in

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

getHeight

▸ getHeight(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

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

DDialogLayered.getLocalBounds

Defined in

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

getParentOfSize

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

Returns

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

Inherited from

DDialogLayered.getParentOfSize

Defined in

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

getRejectReason

▸ getRejectReason(): any

Returns

any

Inherited from

DDialogLayered.getRejectReason

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:249

getResolvedValue

▸ getResolvedValue(): null | VALUE | PromiseLike<null | VALUE>

Returns

null | VALUE | PromiseLike<null | VALUE>

Overrides

DDialogLayered.getResolvedValue

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:446

getThemeDefault

▸ getThemeDefault(): THEME

Returns

THEME

Inherited from

DDialogLayered.getThemeDefault

Defined in

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

getType

▸ getType(): string

Returns

string

Overrides

DDialogLayered.getType

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:450

getWidth

▸ getWidth(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DDialogLayered.getWidth

Defined in

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

getX

▸ getX(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DDialogLayered.getX

Defined in

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

getY

▸ getY(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DDialogLayered.getY

Defined in

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

hasDirty

▸ hasDirty(): boolean

Returns

boolean

Inherited from

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

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

DDialogLayered.hasRefitableWidth

Defined in

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

hide

▸ hide(): this

Returns

this

Inherited from

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

DDialogLayered.init

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:101

initReflowable

▸ initReflowable(): void

Returns

void

Inherited from

DDialogLayered.initReflowable

Defined in

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

isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

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

DDialogLayered.isEventTarget

Defined in

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

isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DDialogLayered.isHidden

Defined in

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

isHierarchyDirty

▸ isHierarchyDirty(): boolean

Returns

boolean

Inherited from

DDialogLayered.isHierarchyDirty

Defined in

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

isOpened

▸ isOpened(): boolean

Returns

boolean

Inherited from

DDialogLayered.isOpened

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:421

isRefitable

▸ isRefitable(target): target is DRefitable

Parameters

Name	Type
`target`	`any`

Returns

target is DRefitable

Inherited from

DDialogLayered.isRefitable

Defined in

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

isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

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

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

DDialogLayered.listeners

Defined in

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

newButtonDismiss

▸ newButtonDismiss(): null | DButton<string, DThemeButton<string>, DButtonOptions<string, DThemeButton<string>, any>>

Returns

null | DButton<string, DThemeButton<string>, DButtonOptions<string, DThemeButton<string>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:394

newContent

▸ newContent(): DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Returns

DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Inherited from

DDialogLayered.newContent

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:179

newContentChildren

▸ newContentChildren(theme, options?): (null | DisplayObject)[]

Parameters

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

Returns

(null | DisplayObject)[]

Overrides

DDialogLayered.newContentChildren

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:193

newFooter

▸ newFooter(): null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Returns

null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Inherited from

DDialogLayered.newFooter

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:204

newHeader

▸ newHeader(): null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Returns

null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Inherited from

DDialogLayered.newHeader

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:149

newInput

▸ newInput(): DInputSearch<DThemeInputSearch, DInputSearchOptions<DThemeInputSearch>>

Returns

DInputSearch<DThemeInputSearch, DInputSearchOptions<DThemeInputSearch>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:253

newInputLayout

▸ newInputLayout(): DLayoutHorizontal<DThemeLayoutHorizontal, DLayoutHorizontalOptions<DThemeLayoutHorizontal>>

Returns

DLayoutHorizontal<DThemeLayoutHorizontal, DLayoutHorizontalOptions<DThemeLayoutHorizontal>>

Defined in

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

newLayout

▸ newLayout(): DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Returns

DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Inherited from

DDialogLayered.newLayout

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:115

newLayoutChildren

▸ newLayoutChildren(theme, options?): (null | DisplayObject)[]

Parameters

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

Returns

(null | DisplayObject)[]

Inherited from

DDialogLayered.newLayoutChildren

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:136

newLayoutOptions

▸ newLayoutOptions(theme, options?): DLayoutVerticalOptions<DThemeLayoutVertical>

Parameters

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

Returns

DLayoutVerticalOptions<DThemeLayoutVertical>

Inherited from

DDialogLayered.newLayoutOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:128

newList

▸ newList(): DDialogSelectList<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions, DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>>

Returns

DDialogSelectList<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions, DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:285

newNoteError

▸ newNoteError(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:314

newNoteNoItemsFound

▸ newNoteNoItemsFound(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:326

newNoteSearching

▸ newNoteSearching(): null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Returns

null | DNote<DThemeNote, DNoteOptions<DThemeNote>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:338

newPadding

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

Parameters

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

Returns

DBasePadding

Inherited from

DDialogLayered.newPadding

Defined in

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

newSearch

▸ newSearch(): DDialogSelectSearch<VALUE, CATEGORY_ID>

Returns

DDialogSelectSearch<VALUE, CATEGORY_ID>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:369

newSelectCategory

▸ newSelectCategory(): DSelect<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>>

Returns

DSelect<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>>

Defined in

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

newSpace

▸ newSpace(): DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Returns

DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:211

off

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

Parameters

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

Returns

this

Inherited from

DDialogLayered.off

Defined in

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

ok

▸ ok(): void

Returns

void

Inherited from

DDialogLayered.ok

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:229

on

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

Parameters

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

Returns

this

Inherited from

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

DDialogLayered.on

Defined in

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

onAnimationEnd

▸ onAnimationEnd(isReverse): void

Parameters

Name	Type
`isReverse`	`boolean`

Returns

void

Inherited from

DDialogLayered.onAnimationEnd

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:295

onBlur

▸ onBlur(): void

Returns

void

Inherited from

DDialogLayered.onBlur

Defined in

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

onCancel

▸ onCancel(reason): void

Parameters

Name	Type
`reason`	`any`

Returns

void

Inherited from

DDialogLayered.onCancel

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:242

onCategoriesChange

▸ onCategoriesChange(categories): void

Parameters

Name	Type
`categories`	`DDialogSelectCategory`<`CATEGORY_ID`>[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:473

onChildBlur

▸ onChildBlur(blured): void

Parameters

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

Returns

void

Inherited from

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

DDialogLayered.onChildFocus

Defined in

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

onChildrenChange

▸ onChildrenChange(): void

Returns

void

Inherited from

DDialogLayered.onChildrenChange

Defined in

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

onClose

▸ onClose(): void

Returns

void

Inherited from

DDialogLayered.onClose

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:455

onCloseOn

▸ onCloseOn(): void

Returns

void

Inherited from

DDialogLayered.onCloseOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:504

onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

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

Returns

boolean

Inherited from

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

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

DDialogLayered.onDownThis

Defined in

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

onFocus

▸ onFocus(): void

Returns

void

Inherited from

DDialogLayered.onFocus

Defined in

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

onHierarchyDirty

▸ onHierarchyDirty(): void

Returns

void

Inherited from

DDialogLayered.onHierarchyDirty

Defined in

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

onInputInput

▸ onInputInput(value): void

Parameters

Name	Type
`value`	`string`

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:273

onKeyDown

▸ onKeyDown(e): boolean

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

boolean

Inherited from

DDialogLayered.onKeyDown

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:495

onKeyUp

▸ onKeyUp(e): boolean

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

boolean

Inherited from

DDialogLayered.onKeyUp

Defined in

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

onListSelectionChange

▸ onListSelectionChange(selection): void

Parameters

Name	Type
`selection`	`DListDataSelection`<`VALUE`>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:293

onMove

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

Parameters

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

Returns

void

Inherited from

DDialogLayered.onMove

Defined in

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

onOk

▸ onOk(value): void

Parameters

Name	Type
`value`	`null` \| `VALUE` \| `PromiseLike`<`null` \| `VALUE`>

Returns

void

Overrides

DDialogLayered.onOk

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:506

onOpen

▸ onOpen(): void

Returns

void

Overrides

DDialogLayered.onOpen

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:454

onOut

▸ onOut(e): void

Parameters

Name	Type
`e`	`InteractionEvent`

Returns

void

Inherited from

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

DDialogLayered.onOver

Defined in

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

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

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

DDialogLayered.onParentResize

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:266

onPrerender

▸ onPrerender(): void

Returns

void

Inherited from

DDialogLayered.onPrerender

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:380

onRefit

▸ onRefit(): void

Returns

void

Inherited from

DDialogLayered.onRefit

Defined in

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

onReflow

▸ onReflow(): void

Returns

void

Inherited from

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

DDialogLayered.onResize

Defined in

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

onScale

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

Parameters

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

Returns

void

Inherited from

DDialogLayered.onScale

Defined in

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

onSearched

▸ onSearched(results): void

Parameters

Name	Type
`results`	`VALUE`[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:442

onSelectCategoryChange

▸ onSelectCategoryChange(categoryId): void

Parameters

Name	Type
`categoryId`	`CATEGORY_ID`

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:245

onShortcut

▸ onShortcut(e): void

Parameters

Name	Type
`e`	`KeyboardEvent`

Returns

void

Inherited from

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

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

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

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

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

DDialogLayered.onWheel

Defined in

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

once

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

Parameters

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

Returns

this

Inherited from

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

DDialogLayered.once

Defined in

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

open

▸ open(opener?): Promise<null | VALUE>

Opens a dialog.

Parameters

Name	Type	Description
`opener?`	`DDialogOpener`	An opener of a dialog. The dialog position is determined based on a position and a size of the opener. If the opener is undefined, the dialog is placed at the center of the screen.

Returns

Promise<null | VALUE>

a value of this dialog

Inherited from

DDialogLayered.open

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:328

reflow

▸ reflow(): void

Returns

void

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DDialogLayered.setY

Defined in

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

show

▸ show(): this

Returns

this

Inherited from

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

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

DDialogLayered.swapChildren

Defined in

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

toAlign

▸ toAlign(mode, theme, options?): null | UtilAttachAlign

Parameters

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

Returns

null | UtilAttachAlign

Inherited from

DDialogLayered.toAlign

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:204

toButtonDismissOptions

▸ toButtonDismissOptions(options?): DDialogSelectDismissableOptions

Parameters

Name	Type
`options?`	`OPTIONS`

Returns

DDialogSelectDismissableOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:407

toCloseOn

▸ toCloseOn(mode, theme, options?): number

Parameters

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

Returns

number

Inherited from

DDialogLayered.toCloseOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:188

toContentOptions

▸ toContentOptions(theme, options?): DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Parameters

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

Returns

DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Inherited from

DDialogLayered.toContentOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:183

toCursor

▸ toCursor(cursor, state): string

Parameters

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

Returns

string

Inherited from

DDialogLayered.toCursor

Defined in

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

toDirty

▸ toDirty(): boolean

Returns

boolean

Inherited from

DDialogLayered.toDirty

Defined in

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

toFooterOptions

▸ toFooterOptions(theme, options?): undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Parameters

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

Returns

undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Inherited from

DDialogLayered.toFooterOptions

Defined in

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

toGestureOptions

▸ toGestureOptions(mode, theme, options?): DDialogGestureOptions

Parameters

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

Returns

DDialogGestureOptions

Inherited from

DDialogLayered.toGestureOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:235

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

DDialogLayered.toGlobal

Defined in

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

toHasDirty

▸ toHasDirty(): boolean

Returns

boolean

Inherited from

DDialogLayered.toHasDirty

Defined in

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

toHeaderOptions

▸ toHeaderOptions(theme, options?): undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Parameters

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

Returns

undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Inherited from

DDialogLayered.toHeaderOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:157

toHierarchyDirty

▸ toHierarchyDirty(): boolean

Returns

boolean

Inherited from

DDialogLayered.toHierarchyDirty

Defined in

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

toInputMargin

▸ toInputMargin(theme, options?): number

Parameters

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

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:269

toInputOptions

▸ toInputOptions(theme, options?): DInputSearchOptions<DThemeInputSearch>

Parameters

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

Returns

DInputSearchOptions<DThemeInputSearch>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:261

toLayoutOptions

▸ toLayoutOptions(theme, options?): DLayoutVerticalOptions<DThemeLayoutVertical>

Parameters

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

Returns

DLayoutVerticalOptions<DThemeLayoutVertical>

Inherited from

DDialogLayered.toLayoutOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:119

toListOptions

▸ toListOptions(theme, options?): DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>

Parameters

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

Returns

DDialogSelectListOptions<VALUE, DListData<VALUE>, DThemeDialogSelecList, DContentOptions>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:302

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

DDialogLayered.toLocal

Defined in

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

toNoteOptions

▸ toNoteOptions(parent, options?): DNoteOptions<DThemeNote>

Parameters

Name	Type
`parent`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`options?`	`DNoteOptions`<`DThemeNote`>

Returns

DNoteOptions<DThemeNote>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:349

toParentHasDirty

▸ toParentHasDirty(): void

Returns

void

Inherited from

DDialogLayered.toParentHasDirty

Defined in

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

toParentHierarchyDirty

▸ toParentHierarchyDirty(): void

Returns

void

Inherited from

DDialogLayered.toParentHierarchyDirty

Defined in

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

toParentResized

▸ toParentResized(): void

Returns

void

Inherited from

DDialogLayered.toParentResized

Defined in

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

toSelectCategoryOptions

▸ toSelectCategoryOptions(theme, options?): DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>

Parameters

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

Returns

DSelectOptions<null | CATEGORY_ID, DThemeSelect<null | CATEGORY_ID>, any>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:231

updateTransform

▸ updateTransform(): void

Returns

void

Inherited from

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

DDialogLayered.mixin

Defined in

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

Edit this page.

Class: DDialogSelect<VALUE, CATEGORY_ID, THEME, 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

_align

Inherited from

Defined in

_animation

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

_buttonDismiss

Defined in

_categories

Defined in

_clearType

Inherited from

Defined in

_closeOn

Inherited from

Defined in

_content

Inherited from

Defined in

_corner

Inherited from

Defined in

_cursor

Inherited from

Defined in

_destroyed

Inherited from

Defined in

_enabledFilters

Inherited from

Defined in

_focused

Inherited from

Defined in

_footer

Inherited from

Defined in

_gesture

Inherited from

Defined in