Winter Cardinal UI - v0.457.0 / DPagination

Class: DPagination<THEME, OPTIONS>

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

Type parameters

Name Type
THEME extends DThemePagination = DThemePagination
OPTIONS extends DPaginationOptions<THEME> = DPaginationOptions<THEME>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Type parameters

Name Type
THEME extends DThemePagination = DThemePagination
OPTIONS extends DPaginationOptions<THEME> = DPaginationOptions<THEME>

Parameters

Name Type
options? OPTIONS

Returns

DPagination<THEME, OPTIONS>

Overrides

DLayoutHorizontal.constructor

Defined in

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

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DLayoutHorizontal._accessibleActive

Defined in

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

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DLayoutHorizontal._accessibleDiv

Defined in

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

_auto

• Protected _auto: DBaseAutoSet

Inherited from

DLayoutHorizontal._auto

Defined in

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

_background

• Protected _background: DBackgroundStateAware

Inherited from

DLayoutHorizontal._background

Defined in

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

_border

• Protected _border: DBorderStateAware

Inherited from

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

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

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

DLayoutHorizontal._boundsRect

Defined in

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

_buttonLast

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

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:117

_buttonNext

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

Defined in

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

_buttonPages0

• Protected Optional _buttonPages0: DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:111

_buttonPages1

• Protected Optional _buttonPages1: DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:113

_buttonPrevious

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

Defined in

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

_buttonTop

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

Defined in

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

_clearType

• Protected _clearType: number

Inherited from

DLayoutHorizontal._clearType

Defined in

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

_corner

• Protected _corner: DCorner

Inherited from

DLayoutHorizontal._corner

Defined in

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

_cornerAdjust

• Protected _cornerAdjust: boolean

Inherited from

DLayoutHorizontal._cornerAdjust

Defined in

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

_cursor

• Protected Optional _cursor: DStateAwareOrValueMightBe<string>

Inherited from

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

DLayoutHorizontal._destroyed

Defined in

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

_direction

• Protected _direction: DLayoutDirection

Inherited from

DLayoutHorizontal._direction

Defined in

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

_dots0

• Protected Optional _dots0: DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:110

_dots1

• Protected Optional _dots1: DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:114

_enabledFilters

• Protected _enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

Inherited from

DLayoutHorizontal._enabledFilters

Defined in

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

_lastDownPoint

• Protected Optional _lastDownPoint: Point

Inherited from

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

DLayoutHorizontal._lastSortedIndex

Defined in

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

_localBounds

• _localBounds: Bounds

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

Member

PIXI.DisplayObject#_localBounds

Inherited from

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

DLayoutHorizontal._localBoundsRect

Defined in

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

_margin

• Protected _margin: DLayoutMargin

Inherited from

DLayoutHorizontal._margin

Defined in

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

_mask

• Protected _mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

Inherited from

DLayoutHorizontal._mask

Defined in

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

_multiplicity

• Protected _multiplicity: number

Inherited from

DLayoutHorizontal._multiplicity

Defined in

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

_options

• Protected _options: undefined | OPTIONS

Inherited from

DLayoutHorizontal._options

Defined in

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

_outline

• Protected _outline: DOutline

Inherited from

DLayoutHorizontal._outline

Defined in

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

_padding

• Protected _padding: DPadding

Inherited from

DLayoutHorizontal._padding

Defined in

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

_page

• Protected Optional _page: DPaginationPage<DThemePaginationPage, DPaginationPageOptions<DThemePaginationPage>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:112

_reflowable

• Protected _reflowable: DBaseReflowableContainer

Inherited from

DLayoutHorizontal._reflowable

Defined in

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

_reverse

• Protected _reverse: boolean

Inherited from

DLayoutHorizontal._reverse

Defined in

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

_shortcuts

• Protected Optional _shortcuts: UtilKeyboardEventShortcut[]

Inherited from

DLayoutHorizontal._shortcuts

Defined in

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

_size

• Protected _size: number

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:104

_snippet

• Protected _snippet: DBaseSnippetContainer

Inherited from

DLayoutHorizontal._snippet

Defined in

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

_spaceLeft

• Protected Optional _spaceLeft: null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:109

_spaceRight

• Protected Optional _spaceRight: null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

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

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

DLayoutHorizontal._tempDisplayObjectParent

Defined in

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

_title

• Protected _title: string

Inherited from

DLayoutHorizontal._title

Defined in

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

_value

• Protected _value: number

Defined in

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

_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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DLayoutHorizontal.zIndex

Defined in

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

CORNER_ADJUST_WORK

▪ Static CORNER_ADJUST_WORK: null | Float32Array = null

Inherited from

DLayoutHorizontal.CORNER_ADJUST_WORK

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:123

WORK_CONTAINS_POINT

▪ Static Protected WORK_CONTAINS_POINT: Point

Inherited from

DLayoutHorizontal.WORK_CONTAINS_POINT

Defined in

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

Accessors

background

• get background(): DBackgroundStateAware

Returns

DBackgroundStateAware

Inherited from

DLayoutHorizontal.background

Defined in

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

border

• get border(): DBorderStateAware

Returns

DBorderStateAware

Inherited from

DLayoutHorizontal.border

Defined in

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

buttonLast

• get buttonLast(): 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-pagination.ts:282

buttonNext

• get buttonNext(): 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-pagination.ts:340

buttonPages0

• get buttonPages0(): DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Returns

DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:456

buttonPages1

• get buttonPages1(): DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Returns

DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:485

buttonPrevious

• get buttonPrevious(): 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-pagination.ts:376

buttonTop

• get buttonTop(): 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-pagination.ts:412

corner

• get corner(): DCorner

Returns

DCorner

Inherited from

DLayoutHorizontal.corner

Defined in

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

dots0

• get dots0(): DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Returns

DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:260

dots1

• get dots1(): DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Returns

DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Defined in

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

height

• get height(): number

Returns

number

Inherited from

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

DLayoutHorizontal.height

Defined in

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

margin

• get margin(): DLayoutMargin

Returns

DLayoutMargin

Inherited from

DLayoutHorizontal.margin

Defined in

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

multiplicity

• get multiplicity(): number

Returns

number

Inherited from

DLayoutHorizontal.multiplicity

Defined in

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

options

• get options(): undefined | OPTIONS

Returns

undefined | OPTIONS

Inherited from

DLayoutHorizontal.options

Defined in

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

outline

• get outline(): DOutline

Returns

DOutline

Inherited from

DLayoutHorizontal.outline

Defined in

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

padding

• get padding(): DPadding

Returns

DPadding

Inherited from

DLayoutHorizontal.padding

Defined in

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

page

• get page(): DPaginationPage<DThemePaginationPage, DPaginationPageOptions<DThemePaginationPage>>

Returns

DPaginationPage<DThemePaginationPage, DPaginationPageOptions<DThemePaginationPage>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:514

position

• get position(): DBasePoint

Returns

DBasePoint

Inherited from

DLayoutHorizontal.position

Defined in

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

reflowable

• get reflowable(): DBaseReflowableContainer

Returns

DBaseReflowableContainer

Inherited from

DLayoutHorizontal.reflowable

Defined in

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

scale

• get scale(): DBasePoint

Returns

DBasePoint

Inherited from

DLayoutHorizontal.scale

Defined in

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

selected

• get selected(): number

Returns an index of the selected page.

Returns

number

an index of the selected page.

Deprecated

in favor of value.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:209

• set selected(index): void

Selects a page.

Parameters

Name Type Description
index number an index of a page

Returns

void

Deprecated

in favor of value.

Defined in

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

shadow

• get shadow(): null | DShadow

Returns

null | DShadow

Inherited from

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

DLayoutHorizontal.shadow

Defined in

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

size

• get size(): number

Returns a number of total pages.

Returns

number

a number of total pages.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:236

• set size(size): void

Sets a number of total pages.

Parameters

Name Type Description
size number a number of pages

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:218

skew

• get skew(): DBasePoint

Returns

DBasePoint

Inherited from

DLayoutHorizontal.skew

Defined in

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

snippet

• get snippet(): DBaseSnippetContainer

Returns

DBaseSnippetContainer

Inherited from

DLayoutHorizontal.snippet

Defined in

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

spaceLeft

• get spaceLeft(): null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Returns

null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:538

spaceRight

• get spaceRight(): null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Returns

null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:554

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

DLayoutHorizontal.state

Defined in

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

theme

• get theme(): THEME

Returns

THEME

Inherited from

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

DLayoutHorizontal.theme

Defined in

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

title

• get title(): string

Returns

string

Inherited from

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

DLayoutHorizontal.title

Defined in

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

total

• get total(): number

Returns a number of total pages.

Returns

number

a number of total pages.

Deprecated

in favor of size

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:256

• set total(total): void

Sets a number of total pages.

Parameters

Name Type Description
total number a number of pages

Returns

void

Deprecated

in favor of size

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:246

type

• get type(): string

Returns

string

Inherited from

DLayoutHorizontal.type

Defined in

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

unsafe

• get unsafe(): Transform

Returns

Transform

Inherited from

DLayoutHorizontal.unsafe

Defined in

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

value

• get value(): number

Returns a value that is an index of a current page.

Returns

number

a value that is an index of a selected page.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:189

• set value(value): void

Sets a value that is an index of a current page.

Parameters

Name Type Description
value number a value that is an index of a page

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:176

weight

• get weight(): number

Returns

number

Inherited from

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

DLayoutHorizontal.weight

Defined in

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

width

• get width(): number

Returns

number

Inherited from

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

DLayoutHorizontal.width

Defined in

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

x

• get x(): number

Returns

number

Inherited from

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

DLayoutHorizontal.x

Defined in

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

y

• get y(): number

Returns

number

Inherited from

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

DLayoutHorizontal.y

Defined in

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

Methods

_calculateBounds

▸ _calculateBounds(): void

Returns

void

Inherited from

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

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

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

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

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

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

DLayoutHorizontal.addListener

Defined in

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

addSpace

▸ addSpace(options?): DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Parameters

Name Type
options? DLayoutSpaceOptions<DThemeLayoutSpace>

Returns

DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Inherited from

DLayoutHorizontal.addSpace

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:804

allocButtonPages0

▸ allocButtonPages0(size): void

Parameters

Name Type
size number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:474

allocButtonPages1

▸ allocButtonPages1(size): void

Parameters

Name Type
size number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:503

applyTitle

▸ applyTitle(): void

Returns

void

Inherited from

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

DLayoutHorizontal.blur

Defined in

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

calcSpaceLeft

▸ calcSpaceLeft(isOn, size, padding, margin): number

Parameters

Name Type
isOn boolean
size number
padding number
margin number

Returns

number

Inherited from

DLayoutHorizontal.calcSpaceLeft

Defined in

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

calculateBounds

▸ calculateBounds(): void

Recalculates the bounds of the container.

Returns

void

Inherited from

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

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

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

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

DLayoutHorizontal.containsPoint

Defined in

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

countColumn

▸ countColumn(istart, irow, cornerAdjustWork): number

Parameters

Name Type
istart number
irow number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.countColumn

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:760

countRow

▸ countRow(istart, icolumn, cornerAdjustWork): number

Parameters

Name Type
istart number
icolumn number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.countRow

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:718

destroy

▸ destroy(): void

Returns

void

Inherited from

DLayoutHorizontal.destroy

Defined in

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

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name Type Description
cacheParent DisplayObject actual parent of element

Returns

void

Inherited from

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

DLayoutHorizontal.displayObjectUpdateTransform

Defined in

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

doUpdate0

▸ doUpdate0(value, size): void

Parameters

Name Type
value number
size number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:607

doUpdate1

▸ doUpdate1(value, size): void

Parameters

Name Type
value number
size number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:643

doUpdate2

▸ doUpdate2(value, size, left, right, nleft1, nright1): void

Parameters

Name Type
value number
size number
left 0 | 1 | 2 | 3 | 4
right 0 | 1 | 2 | 3 | 4
nleft1 number
nright1 number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:805

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

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

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

DLayoutHorizontal.eventNames

Defined in

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

findColumnIndexNext

▸ findColumnIndexNext(istart, icolumn, cornerAdjustWork): number

Parameters

Name Type
istart number
icolumn number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.findColumnIndexNext

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:699

findColumnIndexPrevious

▸ findColumnIndexPrevious(istart, icolumn, cornerAdjustWork): number

Parameters

Name Type
istart number
icolumn number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.findColumnIndexPrevious

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:686

findRowIndexNext

▸ findRowIndexNext(istart, irow, cornerAdjustWork): number

Parameters

Name Type
istart number
irow number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.findRowIndexNext

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:741

findRowIndexPrevious

▸ findRowIndexPrevious(istart, irow, cornerAdjustWork): number

Parameters

Name Type
istart number
irow number
cornerAdjustWork Float32Array

Returns

number

Inherited from

DLayoutHorizontal.findRowIndexPrevious

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:728

focus

▸ focus(): this

Returns

this

Inherited from

DLayoutHorizontal.focus

Defined in

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

focusOnClosest

▸ focusOnClosest(): void

Returns

void

Inherited from

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

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

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

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

DLayoutHorizontal.getChildIndex

Defined in

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

getClearType

▸ getClearType(): number

Returns

number

Inherited from

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

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

DLayoutHorizontal.getGlobalPosition

Defined in

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

getHeight

▸ getHeight(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

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

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

DLayoutHorizontal.getParentOfSize

Defined in

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

getSpaceLeft

▸ getSpaceLeft(baseSize, margin): number

Parameters

Name Type
baseSize number
margin number

Returns

number

Inherited from

DLayoutHorizontal.getSpaceLeft

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:184

getThemeDefault

▸ getThemeDefault(): THEME

Returns

THEME

Inherited from

DLayoutHorizontal.getThemeDefault

Defined in

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

getType

▸ getType(): string

Returns

string

Overrides

DLayoutHorizontal.getType

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:945

getWeightTotal

▸ getWeightTotal(): number

Returns

number

Inherited from

DLayoutHorizontal.getWeightTotal

Defined in

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

getWidth

▸ getWidth(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DLayoutHorizontal.getWidth

Defined in

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

getX

▸ getX(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DLayoutHorizontal.getX

Defined in

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

getY

▸ getY(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DLayoutHorizontal.getY

Defined in

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

goTo

▸ goTo(index, silently?): boolean

Goes to the given page. Unlike value, this method emits the change event if silently is not true.

Parameters

Name Type Description
index number a page index
silently? boolean true to suppress the change event

Returns

boolean

this

Defined in

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

goToLast

▸ goToLast(silently?): boolean

Goes to the last page. Unlike value, this method emits the change event if silently is not true.

Parameters

Name Type Description
silently? boolean true to suppress the change event

Returns

boolean

true if succeeded.

Defined in

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

goToNext

▸ goToNext(silently?): boolean

Goes to the next page. Unlike value, this method emits the change event if silently is not true.

Parameters

Name Type Description
silently? boolean true to suppress the change event

Returns

boolean

true if succeeded.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:372

goToPrevious

▸ goToPrevious(silently?): boolean

Goes to the previous page. Unlike value, this method emits the change event if silently is not true.

Parameters

Name Type Description
silently? boolean true to suppress the change event

Returns

boolean

true if succeeded.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:408

goToTop

▸ goToTop(silently?): boolean

Goes to the top page. Unlike value, this method emits the change event if silently is not true.

Parameters

Name Type Description
silently? boolean true to suppress the change event

Returns

boolean

true if succeeded.

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:444

hasClearType

▸ hasClearType(children, index, clearType): boolean

Parameters

Name Type
children DisplayObject[]
index number
clearType number

Returns

boolean

Inherited from

DLayoutHorizontal.hasClearType

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:669

hasClearTypeAfter

▸ hasClearTypeAfter(children, index): boolean

Parameters

Name Type
children DisplayObject[]
index number

Returns

boolean

Inherited from

DLayoutHorizontal.hasClearTypeAfter

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:665

hasClearTypeBefore

▸ hasClearTypeBefore(children, index): boolean

Parameters

Name Type
children DisplayObject[]
index number

Returns

boolean

Inherited from

DLayoutHorizontal.hasClearTypeBefore

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:661

hasDirty

▸ hasDirty(): boolean

Returns

boolean

Inherited from

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

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

DLayoutHorizontal.hasRefitableWidth

Defined in

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

hide

▸ hide(): this

Returns

this

Inherited from

DLayoutHorizontal.hide

Defined in

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

hideDots

▸ hideDots(dots): void

Parameters

Name Type
dots DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:941

hidePage

▸ hidePage(button): void

Parameters

Name Type
button DImageBase<number, DThemeImageBase<number>, DImageBaseOptions<number, DThemeImageBase<number>, any>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:933

init

▸ init(options?): void

Parameters

Name Type
options? OPTIONS

Returns

void

Inherited from

DLayoutHorizontal.init

Defined in

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

initReflowable

▸ initReflowable(): void

Returns

void

Inherited from

DLayoutHorizontal.initReflowable

Defined in

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

isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

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

DLayoutHorizontal.isEventTarget

Defined in

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

isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DLayoutHorizontal.isHidden

Defined in

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

isHierarchyDirty

▸ isHierarchyDirty(): boolean

Returns

boolean

Inherited from

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

DLayoutHorizontal.isRefitable

Defined in

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

isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

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

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

DLayoutHorizontal.listeners

Defined in

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

newButtonLast

▸ newButtonLast(): 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-pagination.ts:291

newButtonNext

▸ newButtonNext(): 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-pagination.ts:349

newButtonPage

▸ newButtonPage(): DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>

Returns

DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:448

newButtonPages0

▸ newButtonPages0(): DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Returns

DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:465

newButtonPages1

▸ newButtonPages1(): DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Returns

DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>[]

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:494

newButtonPrevious

▸ newButtonPrevious(): 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-pagination.ts:385

newButtonTop

▸ newButtonTop(): 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-pagination.ts:421

newDots

▸ newDots(): DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Returns

DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:278

newPadding

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

Parameters

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

Returns

DBasePadding

Inherited from

DLayoutHorizontal.newPadding

Defined in

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

newPage

▸ newPage(): DPaginationPage<DThemePaginationPage, DPaginationPageOptions<DThemePaginationPage>>

Returns

DPaginationPage<DThemePaginationPage, DPaginationPageOptions<DThemePaginationPage>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:523

newSpace

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

Returns

null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:570

newSpaceLeft

▸ newSpaceLeft(): null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Returns

null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:547

newSpaceRight

▸ newSpaceRight(): null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Returns

null | DLayoutSpace<DThemeLayoutSpace, DLayoutSpaceOptions<DThemeLayoutSpace>>

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:563

off

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

Parameters

Name Type
event string
fn? Function
context? any

Returns

this

Inherited from

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

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

DLayoutHorizontal.on

Defined in

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

onBlur

▸ onBlur(): void

Returns

void

Inherited from

DLayoutHorizontal.onBlur

Defined in

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

onButtonLastActive

▸ onButtonLastActive(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:303

onButtonNextActive

▸ onButtonNextActive(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:361

onButtonPageActive

▸ onButtonPageActive(button): void

Parameters

Name Type
button DButton<number, DThemeButton<number>, DButtonOptions<number, DThemeButton<number>, any>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:527

onButtonPreviousActive

▸ onButtonPreviousActive(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:397

onButtonTopActive

▸ onButtonTopActive(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:433

onChildBlur

▸ onChildBlur(blured): void

Parameters

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

Returns

void

Inherited from

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

DLayoutHorizontal.onChildFocus

Defined in

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

onChildrenChange

▸ onChildrenChange(): void

Returns

void

Inherited from

DLayoutHorizontal.onChildrenChange

Defined in

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

onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

Name Type
e MouseEvent | TouchEvent
interactionManager InteractionManager

Returns

boolean

Inherited from

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

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

DLayoutHorizontal.onDownThis

Defined in

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

onFocus

▸ onFocus(): void

Returns

void

Inherited from

DLayoutHorizontal.onFocus

Defined in

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

onHierarchyDirty

▸ onHierarchyDirty(): void

Returns

void

Inherited from

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

DLayoutHorizontal.onKeyDown

Defined in

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

onKeyUp

▸ onKeyUp(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

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

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

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

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

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

DLayoutHorizontal.onParentResize

Defined in

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

onRefit

▸ onRefit(): void

Returns

void

Inherited from

DLayoutHorizontal.onRefit

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:265

onReflow

▸ onReflow(): void

Returns

void

Overrides

DLayoutHorizontal.onReflow

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:588

onResize

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

Parameters

Name Type
newWidth number
newHeight number
oldWidth number
oldHeight number

Returns

void

Inherited from

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

DLayoutHorizontal.onScale

Defined in

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

onShortcut

▸ onShortcut(e): void

Parameters

Name Type
e KeyboardEvent

Returns

void

Inherited from

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

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

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

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

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

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

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

DLayoutHorizontal.once

Defined in

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

reflow

▸ reflow(): void

Returns

void

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DLayoutHorizontal.setY

Defined in

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

show

▸ show(): this

Returns

this

Inherited from

DLayoutHorizontal.show

Defined in

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

showDots

▸ showDots(dots, from, to): void

Parameters

Name Type
dots DPaginationDots<DThemePaginationDots, DPaginationDotsOptions<DThemePaginationDots>>
from number
to number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:937

showPage

▸ showPage(button, index): void

Parameters

Name Type
button DImageBase<number, DThemeImageBase<number>, DImageBaseOptions<number, DThemeImageBase<number>, any>>
index number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:928

sortChildren

▸ sortChildren(): void

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

Returns

void

Inherited from

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

DLayoutHorizontal.swapChildren

Defined in

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

toCornerMaskColumn

▸ toCornerMaskColumn(i0, i1, i2, n): number

Parameters

Name Type
i0 number
i1 number
i2 number
n number

Returns

number

Inherited from

DLayoutHorizontal.toCornerMaskColumn

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:770

toCornerMaskRow

▸ toCornerMaskRow(i0, i1, i2, n): number

Parameters

Name Type
i0 number
i1 number
i2 number
n number

Returns

number

Inherited from

DLayoutHorizontal.toCornerMaskRow

Defined in

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

toCursor

▸ toCursor(cursor, state): string

Parameters

Name Type
cursor DStateAwareOrValueMightBe<string>
state DBaseStateSet

Returns

string

Inherited from

DLayoutHorizontal.toCursor

Defined in

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

toDirty

▸ toDirty(): boolean

Returns

boolean

Inherited from

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

DLayoutHorizontal.toGlobal

Defined in

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

toHasDirty

▸ toHasDirty(): boolean

Returns

boolean

Inherited from

DLayoutHorizontal.toHasDirty

Defined in

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

toHierarchyDirty

▸ toHierarchyDirty(): boolean

Returns

boolean

Inherited from

DLayoutHorizontal.toHierarchyDirty

Defined in

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

toLocal

▸ toLocal(position, from?, point?, skipUpdate?): Point

Calculates the local position of the display object relative to another point.

Parameters

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

Returns

Point

A point object representing the position of this object

Inherited from

DLayoutHorizontal.toLocal

Defined in

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

toParentHasDirty

▸ toParentHasDirty(): void

Returns

void

Inherited from

DLayoutHorizontal.toParentHasDirty

Defined in

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

toParentHierarchyDirty

▸ toParentHierarchyDirty(): void

Returns

void

Inherited from

DLayoutHorizontal.toParentHierarchyDirty

Defined in

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

toParentResized

▸ toParentResized(): void

Returns

void

Inherited from

DLayoutHorizontal.toParentResized

Defined in

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

update

▸ update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-pagination.ts:593

updateTransform

▸ updateTransform(): void

Returns

void

Inherited from

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

DLayoutHorizontal.mixin

Defined in

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

Edit this page.