StrictControl

class StrictControl extends Control

A Control that allow you to select the maximum number of panels to move at a time

Properties

Methods

count
controller
activeIndex
activePanel
animating
holding

destroy
updateInput
moveToPosition
init
enable
disable
updatePosition
resetActive
moveToPanel
setActive

Constructor

new StrictControl()

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
	Partial<StrictControlOptions>	✔️	{}

Properties

count

Maximum number of panels that can be moved at a time

Type: number

Default: 1

controller

readonlyinherited

A controller that handles the @egjs/axes events

Type: AxesController

activeIndex

readonlyinherited

Index number of the currentPanel

Type: number

Default: 0

activePanel

readonlyinherited

An active panel

Type: Panel | null

animating

readonlyinherited

Whether Flicking's animating

Type: boolean

holding

readonlyinherited

Whether user is clicking or touching

Type: boolean

Methods

destroy

Destroy Control and return to initial state

Returns: void

updateInput

Update controller's state

Returns: this

moveToPosition

async

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

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
position	number			The target position to move
duration	number			Duration of the panel movement animation (unit: ms).
axesEvent	object	✔️		release event of Axes

Throws: FlickingError

code	condition
POSITION_NOT_REACHABLE	When the given panel is already removed or not in the Camera's range
NOT_ATTACHED_TO_FLICKING	When init is not called before
ANIMATION_INTERRUPTED	When the animation is interrupted by user input
STOP_CALLED_BY_USER	When the animation is interrupted by user input

init

inherited

Initialize Control

Returns: this

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
flicking	Flicking			An instance of Flicking

enable

inherited

Enable input from the user (mouse/touch)

Returns: this

disable

inherited

Disable input from the user (mouse/touch)

Returns: this

updatePosition

inherited

Update position after resizing

Returns: Promise<void>

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
progressInPanel	number			Previous camera's progress in active panel before resize

Throws: FlickingError

NOT_ATTACHED_TO_FLICKING When init is not called before

resetActive

inherited

Reset activePanel to null

Returns: this

moveToPanel

inheritedasync

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

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
panel	Panel			The target panel to move
options	object			An options object
duration	number			Duration of the animation (unit: ms)
axesEvent	object	✔️		release event of Axes
direction	DIRECTION	✔️	DIRECTION.NONE	Direction to move, only available in the circular mode

Throws: FlickingError

code	condition
POSITION_NOT_REACHABLE	When the given panel is already removed or not in the Camera's range
NOT_ATTACHED_TO_FLICKING	When init is not called before
ANIMATION_INTERRUPTED	When the animation is interrupted by user input
STOP_CALLED_BY_USER	When the animation is interrupted by user input

setActive

inherited

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
newActivePanel	Panel
prevActivePanel	Panel | null
isTrusted	boolean

⚠️ This function is for internal use only.