Winter Cardinal UI - v0.457.0 / DViewImpl

Class: DViewImpl

Hierarchy

• EventEmitter

  ↳ DViewImpl

Implements

• DView

Table of contents

Constructors

• constructor

Properties

• _constraint
• _dblClickZoomChecker
• _dblClickZoomModifier
• _dblClickZoomSpeed
• _dblclickZoomDuration
• _gesture
• _isDblClickZoomEnabled
• _isWheelTranslationEnabled
• _isWheelZoomEnabled
• _parent
• _toTarget
• _transform
• _wheelTranslationChecker
• _wheelTranslationModifier
• _wheelTranslationSpeed
• _wheelZoomChecker
• _wheelZoomModifier
• _wheelZoomSpeed
• _workRect
• _zoomKeepRatio
• _zoomMax
• _zoomMin
• _zoomPoint
• CONSTRAINT

Accessors

• gesture
• position
• scale

Methods

• addListener
• emit
• eventNames
• fit
• getThemeDefault
• getType
• listenerCount
• listeners
• moveTo
• off
• on
• onDblClick
• onDown
• onWheel
• once
• removeAllListeners
• removeListener
• reset
• stop
• toGlobal
• toLocal
• toNormalizedScale
• toTheme
• transform
• zoom
• zoomAt
• zoomAtGlobal
• zoomIn
• zoomOut

Constructors

constructor

• new DViewImpl(parent, toTarget, options): DViewImpl

Parameters

Name	Type
parent	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
toTarget	DViewToTarget
options	undefined | DViewOptions

Returns

DViewImpl

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:58

Properties

_constraint

• Protected _constraint: DViewConstraint

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:30

---

_dblClickZoomChecker

• Protected _dblClickZoomChecker: DViewChecker

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:45

---

_dblClickZoomModifier

• Protected _dblClickZoomModifier: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:44

---

_dblClickZoomSpeed

• Protected _dblClickZoomSpeed: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:43

---

_dblclickZoomDuration

• Protected _dblclickZoomDuration: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:46

---

_gesture

• Protected _gesture: DViewGestureImpl

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:54

---

_isDblClickZoomEnabled

• Protected _isDblClickZoomEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:42

---

_isWheelTranslationEnabled

• Protected _isWheelTranslationEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:48

---

_isWheelZoomEnabled

• Protected _isWheelZoomEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:37

---

_parent

• Protected _parent: DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:28

---

_toTarget

• Protected _toTarget: DViewToTarget

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:29

---

_transform

• Protected _transform: DViewTransformImpl

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:53

---

_wheelTranslationChecker

• Protected _wheelTranslationChecker: DViewChecker

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:51

---

_wheelTranslationModifier

• Protected _wheelTranslationModifier: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:50

---

_wheelTranslationSpeed

• Protected _wheelTranslationSpeed: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:49

---

_wheelZoomChecker

• Protected _wheelZoomChecker: DViewChecker

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:40

---

_wheelZoomModifier

• Protected _wheelZoomModifier: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:39

---

_wheelZoomSpeed

• Protected _wheelZoomSpeed: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:38

---

_workRect

• Protected _workRect: Rectangle

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:56

---

_zoomKeepRatio

• Protected _zoomKeepRatio: boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:35

---

_zoomMax

• Protected _zoomMax: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:34

---

_zoomMin

• Protected _zoomMin: number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:33

---

_zoomPoint

• Protected _zoomPoint: Point

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:32

---

CONSTRAINT

▪ Static Protected CONSTRAINT: DViewConstraint

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:23

Accessors

gesture

• get gesture(): DViewGesture

Returns

DViewGesture

Implementation of

DView.gesture

Defined in

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

---

position

• get position(): DViewTargetPoint

Returns

DViewTargetPoint

Implementation of

DView.position

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:298

• set position(position): void

Parameters

Name	Type
position	DViewTargetPoint

Returns

void

Implementation of

DView.position

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:306

---

scale

• get scale(): DViewTargetPoint

Returns

DViewTargetPoint

Implementation of

DView.scale

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:272

• set scale(scale): void

Parameters

Name	Type
scale	DViewTargetPoint

Returns

void

Implementation of

DView.scale

Defined in

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

Methods

addListener

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

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DView.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

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

---

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.

Implementation of

DView.emit

Inherited from

utils.EventEmitter.emit

Defined in

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

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DView.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

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

---

fit

▸ fit(duration?, stop?): void

Fits into a screen.

Parameters

Name	Type	Description
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.fit

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:174

---

getThemeDefault

▸ getThemeDefault(): DThemeView

Returns

DThemeView

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:426

---

getType

▸ getType(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:430

---

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

Implementation of

DView.listenerCount

Inherited from

utils.EventEmitter.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[]

Implementation of

DView.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

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

---

moveTo

▸ moveTo(x, y, duration?, stop?): void

Moves to the given position.

Parameters

Name	Type	Description
x	number	a local X coordinate position
y	number	a local Y coordinate position
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.moveTo

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:290

---

off

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

Alias method for removeListener

Parameters

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

Returns

this

Implementation of

DView.off

Inherited from

utils.EventEmitter.off

Defined in

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

---

on

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

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DView.on

Inherited from

utils.EventEmitter.on

Defined in

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

---

onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

Name	Type
e	MouseEvent | TouchEvent
interactionManager	InteractionManager

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:389

---

onDown

▸ onDown(e): void

Parameters

Name	Type
e	InteractionEvent

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:385

---

onWheel

▸ onWheel(e, deltas, global): boolean

Parameters

Name	Type
e	WheelEvent
deltas	UtilWheelEventDeltas
global	Point

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:340

---

once

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

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DView.once

Inherited from

utils.EventEmitter.once

Defined in

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

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Implementation of

DView.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

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

---

removeListener

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

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Implementation of

DView.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

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

---

reset

▸ reset(duration?, stop?): void

Resets a position and a scale.

Parameters

Name	Type	Description
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.reset

Defined in

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

---

stop

▸ stop(): void

Stops an animation if exits.

Returns

void

Implementation of

DView.stop

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:145

---

toGlobal

▸ toGlobal(local, global, skipUpdate?): IPoint

Parameters

Name	Type
local	IPoint
global	Point
skipUpdate?	boolean

Returns

IPoint

Implementation of

DView.toGlobal

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:332

---

toLocal

▸ toLocal(global, local, skipUpdate?): IPoint

Parameters

Name	Type
global	IPoint
local	Point
skipUpdate?	boolean

Returns

IPoint

Implementation of

DView.toLocal

Defined in

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

---

toNormalizedScale

▸ toNormalizedScale(scale): number

Parameters

Name	Type
scale	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:336

---

toTheme

▸ toTheme(options?): null | DThemeView

Parameters

Name	Type
options?	DViewOptions

Returns

null | DThemeView

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:414

---

transform

▸ transform(x, y, scaleX, scaleY, duration?, stop?): void

Sets to the specified position and scale.

Parameters

Name	Type	Description
x	number	a local X coordinate position
y	number	a local Y coordinate position
scaleX	number	a X coordinate scale
scaleY	number	a Y coordinate scale
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.transform

Defined in

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

---

zoom

▸ zoom(scaleX, scaleY, duration?, stop?): void

Zooms in / out at the current position.

Parameters

Name	Type	Description
scaleX	number	a X coordinate scale
scaleY	number	a Y coordinate scale
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.zoom

Defined in

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

---

zoomAt

▸ zoomAt(x, y, scaleX, scaleY, duration?, stop?): void

Zooms into the given position.

Parameters

Name	Type	Description
x	number	a local X coordinate position
y	number	a local Y coordinate position
scaleX	number	a X coordinate scale
scaleY	number	a Y coordinate scale
duration?	number	an duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.zoomAt

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:226

---

zoomAtGlobal

▸ zoomAtGlobal(x, y, scaleX, scaleY, duration?, stop?): void

Zooms into the specified global position.

Parameters

Name	Type	Description
x	number	a global X coordinate position
y	number	a global Y coordinate position
scaleX	number	a X coordinate scale
scaleY	number	a Y coordinate scale
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.zoomAtGlobal

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:253

---

zoomIn

▸ zoomIn(duration?, stop?): void

Zooms in at the current position.

Parameters

Name	Type	Description
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.zoomIn

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:208

---

zoomOut

▸ zoomOut(duration?, stop?): void

Zooms out at the current position.

Parameters

Name	Type	Description
duration?	number	an animation duration
stop?	boolean	false to keep a previous animation

Returns

void

Implementation of

DView.zoomOut

Defined in

src/main/typescript/wcardinal/ui/d-view-impl.ts:217

Edit this page.