Winter Cardinal UI - v0.457.0 / DMenuItemLink

Class: DMenuItemLink<VALUE, THEME, OPTIONS>

A base class for UI classes with an image support. See DImageBaseEvents for event details.

Type parameters

Name Type
VALUE unknown
THEME extends DThemeMenuItemLink = DThemeMenuItemLink
OPTIONS extends DMenuItemLinkOptions<VALUE, THEME> = DMenuItemLinkOptions<VALUE, THEME>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Type parameters

Name Type
VALUE unknown
THEME extends DThemeMenuItemLink = DThemeMenuItemLink
OPTIONS extends DMenuItemLinkOptions<VALUE, THEME> = DMenuItemLinkOptions<VALUE, THEME>

Parameters

Name Type
options? OPTIONS

Returns

DMenuItemLink<VALUE, THEME, OPTIONS>

Inherited from

DMenuItemText.constructor

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:28

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DMenuItemText._accessibleActive

Defined in

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


_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DMenuItemText._accessibleDiv

Defined in

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


_auto

• Protected _auto: DBaseAutoSet

Inherited from

DMenuItemText._auto

Defined in

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


_background

• Protected _background: DBackgroundStateAware

Inherited from

DMenuItemText._background

Defined in

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


_border

• Protected _border: DBorderStateAware

Inherited from

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

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

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

DMenuItemText._boundsRect

Defined in

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


_clearType

• Protected _clearType: number

Inherited from

DMenuItemText._clearType

Defined in

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


_corner

• Protected _corner: DCorner

Inherited from

DMenuItemText._corner

Defined in

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


_cursor

• Protected Optional _cursor: DStateAwareOrValueMightBe<string>

Inherited from

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

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

DMenuItemText._enabledFilters

Defined in

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


_image

• Protected Optional _image: DImagePieceContainerImpl

Inherited from

DMenuItemText._image

Defined in

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


_lastDownPoint

• Protected Optional _lastDownPoint: Point

Inherited from

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

DMenuItemText._lastSortedIndex

Defined in

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


• Protected Optional _link: DLink

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:35


_localBounds

• _localBounds: Bounds

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

Member

PIXI.DisplayObject#_localBounds

Inherited from

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

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

DMenuItemText._mask

Defined in

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


_options

• Protected _options: undefined | OPTIONS

Inherited from

DMenuItemText._options

Defined in

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


_outline

• Protected _outline: DOutline

Inherited from

DMenuItemText._outline

Defined in

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


_overflowMask

• Protected Optional _overflowMask: null | DBaseOverflowMaskSimple

Inherited from

DMenuItemText._overflowMask

Defined in

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


_padding

• Protected _padding: DPadding

Inherited from

DMenuItemText._padding

Defined in

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


_reflowable

• Protected _reflowable: DBaseReflowableContainer

Inherited from

DMenuItemText._reflowable

Defined in

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


_shortcutMargin

• Protected Optional _shortcutMargin: number

Inherited from

DMenuItemText._shortcutMargin

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:32


_shortcutText

• Protected Optional _shortcutText: null | DDynamicText

Inherited from

DMenuItemText._shortcutText

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:31


_shortcuts

• Protected Optional _shortcuts: UtilKeyboardEventShortcut[]

Inherited from

DMenuItemText._shortcuts

Defined in

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


_snippet

• Protected _snippet: DBaseSnippetContainer

Inherited from

DMenuItemText._snippet

Defined in

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


_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

DMenuItemText._tempDisplayObjectParent

Defined in

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


_text

• Protected Optional _text: DTextPieceImpl<string>

Inherited from

DMenuItemText._text

Defined in

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


_title

• Protected _title: string

Inherited from

DMenuItemText._title

Defined in

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


_value

• Protected _value: null | VALUE

Inherited from

DMenuItemText._value

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:26


_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

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

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

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

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

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

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

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

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

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

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

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

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

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

DMenuItemText.filterArea

Defined in

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


filters

• filters: Filter[]

Sets the filters for the displayObject.

Member

PIXI.DisplayObject#filters

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DMenuItemText.zIndex

Defined in

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


LAYOUTER

▪ Static Protected Optional LAYOUTER: DImagePieceLayouter

Inherited from

DMenuItemText.LAYOUTER

Defined in

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


WORK_CONTAINS_POINT

▪ Static Protected WORK_CONTAINS_POINT: Point

Inherited from

DMenuItemText.WORK_CONTAINS_POINT

Defined in

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

Accessors

background

• get background(): DBackgroundStateAware

Returns

DBackgroundStateAware

Inherited from

DMenuItemText.background

Defined in

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


border

• get border(): DBorderStateAware

Returns

DBorderStateAware

Inherited from

DMenuItemText.border

Defined in

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


corner

• get corner(): DCorner

Returns

DCorner

Inherited from

DMenuItemText.corner

Defined in

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


height

• get height(): number

Returns

number

Inherited from

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

DMenuItemText.height

Defined in

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


image

• get image(): DImagePieceContainer

Returns

DImagePieceContainer

Inherited from

DMenuItemText.image

Defined in

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

• set image(imageSource): void

Parameters

Name Type
imageSource DStateAwareOrValueMightBe<null | DisplayObject | Texture>

Returns

void

Inherited from

DMenuItemText.image

Defined in

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


• get link(): DLink

Returns

DLink

Defined in

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


options

• get options(): undefined | OPTIONS

Returns

undefined | OPTIONS

Inherited from

DMenuItemText.options

Defined in

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


outline

• get outline(): DOutline

Returns

DOutline

Inherited from

DMenuItemText.outline

Defined in

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


padding

• get padding(): DPadding

Returns

DPadding

Inherited from

DMenuItemText.padding

Defined in

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


position

• get position(): DBasePoint

Returns

DBasePoint

Inherited from

DMenuItemText.position

Defined in

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


reflowable

• get reflowable(): DBaseReflowableContainer

Returns

DBaseReflowableContainer

Inherited from

DMenuItemText.reflowable

Defined in

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


scale

• get scale(): DBasePoint

Returns

DBasePoint

Inherited from

DMenuItemText.scale

Defined in

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


shadow

• get shadow(): null | DShadow

Returns

null | DShadow

Inherited from

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

DMenuItemText.shadow

Defined in

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


skew

• get skew(): DBasePoint

Returns

DBasePoint

Inherited from

DMenuItemText.skew

Defined in

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


snippet

• get snippet(): DBaseSnippetContainer

Returns

DBaseSnippetContainer

Inherited from

DMenuItemText.snippet

Defined in

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


state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

DMenuItemText.state

Defined in

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


text

• get text(): DTextPiece<VALUE>

Returns

DTextPiece<VALUE>

Inherited from

DMenuItemText.text

Defined in

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

• set text(text): void

Parameters

Name Type
text DStateAwareOrValueMightBe<VALUE>

Returns

void

Inherited from

DMenuItemText.text

Defined in

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


theme

• get theme(): THEME

Returns

THEME

Inherited from

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

DMenuItemText.theme

Defined in

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


title

• get title(): string

Returns

string

Inherited from

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

DMenuItemText.title

Defined in

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


type

• get type(): string

Returns

string

Inherited from

DMenuItemText.type

Defined in

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


unsafe

• get unsafe(): Transform

Returns

Transform

Inherited from

DMenuItemText.unsafe

Defined in

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


value

• get value(): null | VALUE

Returns

null | VALUE

Inherited from

DMenuItemText.value

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:50

• set value(value): void

Parameters

Name Type
value null | VALUE

Returns

void

Inherited from

DMenuItemText.value

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:54


weight

• get weight(): number

Returns

number

Inherited from

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

DMenuItemText.weight

Defined in

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


width

• get width(): number

Returns

number

Inherited from

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

DMenuItemText.width

Defined in

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


x

• get x(): number

Returns

number

Inherited from

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

DMenuItemText.x

Defined in

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


y

• get y(): number

Returns

number

Inherited from

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

DMenuItemText.y

Defined in

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

Methods

_calculateBounds

▸ _calculateBounds(): void

Returns

void

Inherited from

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

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

DMenuItemText._render

Defined in

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


activate

▸ activate(e?): void

Parameters

Name Type
e? MouseEvent | KeyboardEvent | TouchEvent | InteractionEvent

Returns

void

Inherited from

DMenuItemText.activate

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:46


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

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

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

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

DMenuItemText.addListener

Defined in

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


applyTitle

▸ applyTitle(): void

Returns

void

Inherited from

DMenuItemText.applyTitle

Defined in

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


blur

▸ blur(recursively?): this

Parameters

Name Type
recursively? boolean

Returns

this

Inherited from

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

DMenuItemText.calculateBounds

Defined in

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


containerUpdateTransform

▸ containerUpdateTransform(): void

Container default updateTransform, does update children of container. Will crash if there’s no parent element.

Returns

void

Memberof

PIXI.Container#

Function

containerUpdateTransform

Inherited from

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

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

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

DMenuItemText.containsPoint

Defined in

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


destroy

▸ destroy(): void

Returns

void

Inherited from

DMenuItemText.destroy

Defined in

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


disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name Type Description
cacheParent DisplayObject actual parent of element

Returns

void

Inherited from

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

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

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

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

DMenuItemText.eventNames

Defined in

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


focus

▸ focus(): this

Returns

this

Inherited from

DMenuItemText.focus

Defined in

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


focusOnClosest

▸ focusOnClosest(): void

Returns

void

Inherited from

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

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

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

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

DMenuItemText.getChildIndex

Defined in

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


getClearType

▸ getClearType(): number

Returns

number

Inherited from

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

DMenuItemText.getClippingRect

Defined in

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


getCloseable

▸ getCloseable(): null | DMenuCloseable

Returns

null | DMenuCloseable

Inherited from

DMenuItemText.getCloseable

Defined in

src/main/typescript/wcardinal/ui/d-menu-item.ts:31


getContext

▸ getContext(): null | DMenuContext

Returns

null | DMenuContext

Inherited from

DMenuItemText.getContext

Defined in

src/main/typescript/wcardinal/ui/d-menu-item.ts:20


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

DMenuItemText.getGlobalPosition

Defined in

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


getHeight

▸ getHeight(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DMenuItemText.getHeight

Defined in

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


getImage

▸ getImage(): DImagePieceContainerImpl

Returns

DImagePieceContainerImpl

Inherited from

DMenuItemText.getImage

Defined in

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


getLayouter

▸ getLayouter(): DImagePieceLayouter

Returns

DImagePieceLayouter

Inherited from

DMenuItemText.getLayouter

Defined in

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


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

DMenuItemText.getLocalBounds

Defined in

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


getOverflowMask

▸ getOverflowMask(): null | Graphics

Returns

null | Graphics

Inherited from

DMenuItemText.getOverflowMask

Defined in

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


getParentOfSize

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

Returns

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

Inherited from

DMenuItemText.getParentOfSize

Defined in

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


getSelection

▸ getSelection(): null | DMenuItemBaseSelection

Returns

null | DMenuItemBaseSelection

Inherited from

DMenuItemText.getSelection

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:62


getText

▸ getText(): DTextPieceImpl<string>

Returns

DTextPieceImpl<string>

Inherited from

DMenuItemText.getText

Defined in

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


getThemeDefault

▸ getThemeDefault(): THEME

Returns

THEME

Inherited from

DMenuItemText.getThemeDefault

Defined in

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


getType

▸ getType(): string

Returns

string

Overrides

DMenuItemText.getType

Defined in

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


getWidth

▸ getWidth(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DMenuItemText.getWidth

Defined in

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


getX

▸ getX(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DMenuItemText.getX

Defined in

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


getY

▸ getY(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DMenuItemText.getY

Defined in

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


hasDirty

▸ hasDirty(): boolean

Returns

boolean

Inherited from

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

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

DMenuItemText.hasRefitableWidth

Defined in

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


hasSelection

▸ hasSelection(target): target is Object

Parameters

Name Type
target any

Returns

target is Object

Inherited from

DMenuItemText.hasSelection

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:58


hide

▸ hide(): this

Returns

this

Inherited from

DMenuItemText.hide

Defined in

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


init

▸ init(options?): void

Parameters

Name Type
options? OPTIONS

Returns

void

Overrides

DMenuItemText.init

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:68


initOnOver

▸ initOnOver(options?): void

Parameters

Name Type
options? OPTIONS

Returns

void

Inherited from

DMenuItemText.initOnOver

Defined in

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


initReflowable

▸ initReflowable(): void

Returns

void

Inherited from

DMenuItemText.initReflowable

Defined in

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


initShortcuts

▸ initShortcuts(options?): void

Parameters

Name Type
options? OPTIONS

Returns

void

Inherited from

DMenuItemText.initShortcuts

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:52


isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

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

DMenuItemText.isEventTarget

Defined in

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


isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DMenuItemText.isHidden

Defined in

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


isHierarchyDirty

▸ isHierarchyDirty(): boolean

Returns

boolean

Inherited from

DMenuItemText.isHierarchyDirty

Defined in

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


isRefitable

▸ isRefitable(target): target is DRefitable

Parameters

Name Type
target any

Returns

target is DRefitable

Inherited from

DMenuItemText.isRefitable

Defined in

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


isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

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

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

DMenuItemText.listeners

Defined in

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


newImage

▸ newImage(): DImagePieceContainerImpl

Returns

DImagePieceContainerImpl

Inherited from

DMenuItemText.newImage

Defined in

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


newOverflowMask

▸ newOverflowMask(): null | DBaseOverflowMaskSimple

Returns

null | DBaseOverflowMaskSimple

Inherited from

DMenuItemText.newOverflowMask

Defined in

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


newPadding

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

Parameters

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

Returns

DBasePadding

Inherited from

DMenuItemText.newPadding

Defined in

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


newShortcutText

▸ newShortcutText(): DDynamicText

Returns

DDynamicText

Inherited from

DMenuItemText.newShortcutText

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:67


newText

▸ newText(): DTextPieceImpl<string>

Returns

DTextPieceImpl<string>

Inherited from

DMenuItemText.newText

Defined in

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


off

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

Parameters

Name Type
event string
fn? Function
context? any

Returns

this

Inherited from

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

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

DMenuItemText.on

Defined in

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


onBlur

▸ onBlur(): void

Returns

void

Inherited from

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

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

DMenuItemText.onChildFocus

Defined in

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


onChildrenChange

▸ onChildrenChange(): void

Returns

void

Inherited from

DMenuItemText.onChildrenChange

Defined in

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


onClick

▸ onClick(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Overrides

DMenuItemText.onClick

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:81


onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

Name Type
e MouseEvent | TouchEvent
interactionManager InteractionManager

Returns

boolean

Inherited from

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

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

DMenuItemText.onDownThis

Defined in

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


onFocus

▸ onFocus(): void

Returns

void

Inherited from

DMenuItemText.onFocus

Defined in

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


onHierarchyDirty

▸ onHierarchyDirty(): void

Returns

void

Inherited from

DMenuItemText.onHierarchyDirty

Defined in

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


onKeyDown

▸ onKeyDown(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

DMenuItemText.onKeyDown

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:81


onKeyDownActivate

▸ onKeyDownActivate(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

DMenuItemText.onKeyDownActivate

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-base.ts:88


onKeyUp

▸ onKeyUp(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

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

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

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

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

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

DMenuItemText.onParentResize

Defined in

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


onRefit

▸ onRefit(): void

Returns

void

Inherited from

DMenuItemText.onRefit

Defined in

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


onReflow

▸ onReflow(): void

Returns

void

Inherited from

DMenuItemText.onReflow

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:109


onReflowTextAndImage

▸ onReflowTextAndImage(): void

Returns

void

Inherited from

DMenuItemText.onReflowTextAndImage

Defined in

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


onResize

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

Parameters

Name Type
newWidth number
newHeight number
oldWidth number
oldHeight number

Returns

void

Inherited from

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

DMenuItemText.onScale

Defined in

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


onSelect

▸ onSelect(e?): void

Parameters

Name Type
e? MouseEvent | KeyboardEvent | TouchEvent | InteractionEvent

Returns

void

Overrides

DMenuItemText.onSelect

Defined in

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


onShortcut

▸ onShortcut(e): void

Parameters

Name Type
e KeyboardEvent

Returns

void

Overrides

DMenuItemText.onShortcut

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:100


onSkew

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

Parameters

Name Type
newX number
newY number
oldX number
oldY number

Returns

void

Inherited from

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

DMenuItemText.onStateChange

Defined in

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


onUp

▸ onUp(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

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

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

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

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

DMenuItemText.once

Defined in

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


open

▸ open(inNewWindow): void

Parameters

Name Type
inNewWindow boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:96


reflow

▸ reflow(): void

Returns

void

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DMenuItemText.setY

Defined in

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


show

▸ show(): this

Returns

this

Inherited from

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

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

DMenuItemText.swapChildren

Defined in

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


toChecker

▸ toChecker(checker?): undefined | DLinkChecker

Parameters

Name Type
checker? DMenuItemLinkChecker

Returns

undefined | DLinkChecker

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:59


toCursor

▸ toCursor(cursor, state): string

Parameters

Name Type
cursor DStateAwareOrValueMightBe<string>
state DBaseStateSet

Returns

string

Inherited from

DMenuItemText.toCursor

Defined in

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


toDirty

▸ toDirty(): boolean

Returns

boolean

Inherited from

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

DMenuItemText.toGlobal

Defined in

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


toHasDirty

▸ toHasDirty(): boolean

Returns

boolean

Inherited from

DMenuItemText.toHasDirty

Defined in

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


toHierarchyDirty

▸ toHierarchyDirty(): boolean

Returns

boolean

Inherited from

DMenuItemText.toHierarchyDirty

Defined in

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


toLinkOptions

▸ toLinkOptions(options?): undefined | DLinkOptions

Parameters

Name Type
options? OPTIONS

Returns

undefined | DLinkOptions

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:37


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

DMenuItemText.toLocal

Defined in

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


toParentHasDirty

▸ toParentHasDirty(): void

Returns

void

Inherited from

DMenuItemText.toParentHasDirty

Defined in

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


toParentHierarchyDirty

▸ toParentHierarchyDirty(): void

Returns

void

Inherited from

DMenuItemText.toParentHierarchyDirty

Defined in

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


toParentResized

▸ toParentResized(): void

Returns

void

Inherited from

DMenuItemText.toParentResized

Defined in

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


toUrl

▸ toUrl(url?): undefined | string | DLinkUrlMaker

Parameters

Name Type
url? string | DMenuItemLinkUrlMaker

Returns

undefined | string | DLinkUrlMaker

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-link.ts:49


updateShortcutColor

▸ updateShortcutColor(): void

Returns

void

Inherited from

DMenuItemText.updateShortcutColor

Defined in

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


updateShortcutText

▸ updateShortcutText(): void

Returns

void

Inherited from

DMenuItemText.updateShortcutText

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:73


updateTransform

▸ updateTransform(): void

Returns

void

Inherited from

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

DMenuItemText.mixin

Defined in

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