Options to configure inertia. Inertia causes the controller to keep panning after releasing the mouse or finger.

Hierarchy

  • PanControllerInertiaOptions

Properties

frictionMultiplier?: number

A scale factor for the default inertia friction. Use this if you want to change the rate at which the inertia slows down.

A value above 1 means that the fling animation slows down and ends faster than the default (more friction). A value below 1 means that the fling animation continues running for longer than the default (less friction).

Default

1
maxSpeed?: number

The maximum speed (in pixels/second) of inertia fling animations. This is used to avoid extremely fast flings. Note that this maximum is applied after applying the speedMultiplier.

Typical values for fling speeds are in the range of 1000 to 10000 pixels/second.

Default

5000
speedMultiplier?: number

A scale factor for the default speed at which the inertia animation starts. Use this if you want to change the speed at which the inertia kicks in.

A value above 1 means that the inertia animation starts faster than the default speed. A value below 1 means that the inertia animation starts slower than the default speed.

Default

1