FreeControl

A Control that can be scrolled freely without alignment

Constructor

constructor(options?: Partial<FreeControlOptions>);

Constructs a new instance of the FreeControl class

Properties

stopAtEdge

Type: boolean

Make scroll animation to stop at the start/end of the scroll area, not going out the bounce area

Default: true

Methods

moveToPosition

moveToPosition(position: number, duration: number, axesEvent?: OnRelease): Promise<void>

Move Camera to the given position

Parameters:

• position (number) - The target position to move

• duration (number) - Duration of the panel movement animation (unit: ms)

• axesEvent (OnRelease) - release event of Axes

Returns: A Promise which will be resolved after reaching the target position

Remarks: Unlike SnapControl, FreeControl moves to the exact position without snapping to panel boundaries.

Throws:

• MovementErrors

Fires:

• MovementEvents

updatePosition

updatePosition(progressInPanel: number): void

Update position after resizing

Parameters:

• progressInPanel (number) - Previous camera's progress in active panel before resize

Remarks: Unlike the base Control, FreeControl preserves the progress within the panel instead of snapping to the panel position.

Throws:

• InitializationErrors