In This Topic ▼

calculateInertia Property

Summary

When non-null, used to calculate the inertia scroll offset.

Syntax

TypeScript

JavaScript

Object.defineProperty(ControlInertiaScrollOptions.prototype, 'calculateInertia', 
	get: function(), 
	set: function(value) 
)

calculateInertia: CalculateInertiaCallback;

A CalculateInertiaCallback that will calculate the inertia scroll deceleration offsets. The default value is DefaultCalculateInertia. If null, DefaultCalculateInertia is used.

Remarks

DefaultCalculateInertia makes use of the values of DefaultBezierPoint1, DefaultBezierPoint2, DefaultDuration, and DefaultPower to return the new inertia scroll offset. The Bézier function is defined by the four points (0,0), DefaultBezierPoint1, DefaultBezierPoint2, (1,1) and defines the percent of total distance for the inertia animation.

CalculateInertia can make use of the properties in InertiaParams, specifically InertiaParams.Amplitude, InertiaParams.Velocity, and InertiaParams.ReasonTimestamp, to completely control how any individual inertia scroll will animate. InertiaParams.Stop must be used to end the inertia scroll. Failure to set InertiaParams.Stop to true may cause the inertia scroll to run indefinitely.

Requirements

Help Version 22.0.2023.2.4

Leadtools.Controls Assembly