Skip to main content
Version: 4.4.1

Control

class Control

A component that manages inputs and animation of Flicking

Properties#

controller#

readonly

A controller that handles the @egjs/axes events

Type: AxesController

activeIndex#

readonly

Index number of the currentPanel

Type: number

Default: 0

activePanel#

readonly

An active panel

Type: Panel | null

animating#

readonly

Whether Flicking's animating

Type: boolean

holding#

readonly

Whether user is clicking or touching

Type: boolean

Methods#

moveToPosition#

Move Camera to the given position

Returns: Promise<void>

  • A Promise which will be resolved after reaching the target position

Emits: Flicking#event:moveStart, Flicking#event:move, Flicking#event:moveEnd, Flicking#event:willChange, Flicking#event:changed, Flicking#event:willRestore, Flicking#event:restored, Flicking#event:needPanel, Flicking#event:visibleChange, Flicking#event:reachEdge

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
positionnumberThe target position to move
durationnumberDuration of the panel movement animation (unit: ms).
axesEventobject✔️release event of Axes

Throws: FlickingError

codecondition
POSITION_NOT_REACHABLEWhen the given panel is already removed or not in the Camera's range
NOT_ATTACHED_TO_FLICKINGWhen init is not called before
ANIMATION_INTERRUPTEDWhen the animation is interrupted by user input
STOP_CALLED_BY_USERWhen the animation is interrupted by user input

init#

Initialize Control

Returns: this

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
flickingFlickingAn instance of Flicking

destroy#

Destroy Control and return to initial state

Returns: void

enable#

Enable input from the user (mouse/touch)

Returns: this

disable#

Disable input from the user (mouse/touch)

Returns: this

updatePosition#

Update position after resizing

Returns: Promise<void>

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
progressInPanelnumberPrevious camera's progress in active panel before resize

Throws: FlickingError

NOT_ATTACHED_TO_FLICKING When init is not called before

updateInput#

Update controller's state

Returns: this

resetActive#

Reset activePanel to null

Returns: this

moveToPanel#

async

Move Camera to the given panel

Returns: Promise<void>

  • A Promise which will be resolved after reaching the target panel

Emits: Flicking#event:moveStart, Flicking#event:move, Flicking#event:moveEnd, Flicking#event:willChange, Flicking#event:changed, Flicking#event:willRestore, Flicking#event:restored, Flicking#event:needPanel, Flicking#event:visibleChange, Flicking#event:reachEdge

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
panelPanelThe target panel to move
optionsobjectAn options object
durationnumberDuration of the animation (unit: ms)
axesEventobject✔️release event of Axes
directionDIRECTION✔️DIRECTION.NONEDirection to move, only available in the circular mode

Throws: FlickingError

codecondition
POSITION_NOT_REACHABLEWhen the given panel is already removed or not in the Camera's range
NOT_ATTACHED_TO_FLICKINGWhen init is not called before
ANIMATION_INTERRUPTEDWhen the animation is interrupted by user input
STOP_CALLED_BY_USERWhen the animation is interrupted by user input

setActive#

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
newActivePanelPanel
prevActivePanelPanel | null
isTrustedboolean
⚠️ This function is for internal use only.