Skip to main content
Version: 4.1.1

State

⚠️ This class is for internal use only.
class State

A component that shows the current status of the user input or the animation

Properties

holding

readonly

Whether user is clicking or touching

Type: boolean

animating

readonly

Whether Flicking's animating

Type: boolean

Methods

onHold

An event handler for Axes's hold event

Returns: void

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
ctxobjectyesEvent context
ctx.flickingFlickingyesAn instance of Flicking
ctx.axesEventobjectyesA hold event of Axes
ctx.transitTofunctionyesA function for changing current state to other state

onChange

An event handler for Axes's change event

Returns: void

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
ctxobjectyesEvent context
ctx.flickingFlickingyesAn instance of Flicking
ctx.axesEventobjectyesA change event of Axes
ctx.transitTofunctionyesA function for changing current state to other state

onRelease

An event handler for Axes's release event

Returns: void

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
ctxobjectyesEvent context
ctx.flickingFlickingyesAn instance of Flicking
ctx.axesEventobjectyesA release event of Axes
ctx.transitTofunctionyesA function for changing current state to other state

onAnimationEnd

An event handler for Axes's animationEnd event

Returns: void

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
ctxobjectyesEvent context
ctx.flickingFlickingyesAn instance of Flicking
ctx.axesEventobjectyesA animationEnd event of Axes
ctx.transitTofunctionyesA function for changing current state to other state

onFinish

An event handler for Axes's finish event

Returns: void

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
ctxobjectyesEvent context
ctx.flickingFlickingyesAn instance of Flicking
ctx.axesEventobjectyesA finish event of Axes
ctx.transitTofunctionyesA function for changing current state to other state