@interactjs / inertia/plugin / InertiaState
Class: InertiaState
inertia/plugin.InertiaState
Table of contents
Properties
- active
- allowResume
- currentOffset
- interaction
- isModified
- lambda_v0
- modification
- modifiedOffset
- modifierArg
- modifierCount
- one_ve_v0
- smoothEnd
- startCoords
- t0
- targetOffset
- te
- timeout
- v0
Methods
Properties
active
• active: boolean
= false
Defined in
allowResume
• allowResume: boolean
= false
Defined in
currentOffset
• currentOffset: Point
Defined in
interaction
• Readonly
interaction: Interaction
<keyof ActionMap
>
Defined in
isModified
• isModified: boolean
= false
Defined in
lambda_v0
• Optional
lambda_v0: number
= 0
Defined in
modification
• modification: Modification
Defined in
modifiedOffset
• modifiedOffset: Point
Defined in
modifierArg
• modifierArg: ModifierArg
<{ index?
: number
; methods?
: { beforeEnd?
: (arg
: ModifierArg
<any
>) => void
| Point
; set?
: (arg
: ModifierArg
<any
>) => any
; start?
: (arg
: ModifierArg
<any
>) => void
; stop?
: (arg
: ModifierArg
<any
>) => void
} ; name?
: any
; options
: unknown
}>
Defined in
modifierCount
• modifierCount: number
= 0
Defined in
one_ve_v0
• Optional
one_ve_v0: number
= 0
Defined in
smoothEnd
• smoothEnd: boolean
= false
Defined in
startCoords
• startCoords: Point
Defined in
t0
• t0: number
= 0
Defined in
targetOffset
• targetOffset: Point
Defined in
te
• te: number
= 0
Defined in
timeout
• timeout: number
Defined in
v0
• v0: number
= 0
Defined in
Methods
end
â–¸ end(): void
Returns
void
Defined in
inertiaTick
â–¸ inertiaTick(): void
Returns
void
Defined in
onNextFrame
â–¸ onNextFrame(tickFn
): void
Parameters
Name | Type |
---|---|
tickFn | () => void |
Returns
void
Defined in
resume
▸ resume(«destructured»
): void
Parameters
Name | Type |
---|---|
«destructured» | PointerArgProps <{ type : "down" }> |
Returns
void
Defined in
smoothEndTick
â–¸ smoothEndTick(): void
Returns
void
Defined in
start
â–¸ start(event
): boolean
Parameters
Name | Type |
---|---|
event | PointerEventType |
Returns
boolean
Defined in
startInertia
â–¸ startInertia(): void
Returns
void
Defined in
startSmoothEnd
â–¸ startSmoothEnd(): void
Returns
void
Defined in
stop
â–¸ stop(): void
Returns
void