Skip to content

UIScrollViewDragEndEvent ​

UIScrollViewDragEndEvent represents the moment the user lifts the finger after dragging a scroll view.

The beforedragend event of UIScrollView is this class. It carries the speed at release and the position where the content will stop; a listener can change that position so the content stops elsewhere, for example aligned to a row boundary.

Inheritance: Event → UIScrollViewDragEndEvent

Constructor ​

UIScrollViewDragEndEvent()

Creates a UIScrollViewDragEndEvent. The runtime creates one itself when it fires the events below; app code can use it to build an event object and fire it with dispatchEvent() to try out a listener.

Instance properties ​

Also inherits the properties of Event; the most commonly used are type and target. The properties below are read-only except targetContentOffset; assigning to a read-only one throws TypeError.

PropertyDescription
velocity read-onlyHow fast the content was moving at release
targetContentOffsetWhere the content will stop. Writable; the content stops where you write

These properties live on the prototype, not on the event object itself: Object.keys(event) and { ...event } don't include them, so read them one by one. See Events with fields.

Events that use this class ​

ObjectEvents
UIScrollView and its subclassesbeforedragend

It can't be canceled: cancelable is false, and preventDefault() has no effect. To keep the content where it is, write the current contentOffset to targetContentOffset.

Examples ​

js
const scroller = new UIScrollView();
scroller.addEventListener('beforedragend', (e) => {
  console.log(e instanceof UIScrollViewDragEndEvent, e.velocity.y, e.targetContentOffset.y);
});

Effect: dragging scroller and lifting prints true, the vertical speed, and the stopping position the system computed.

Corresponding iOS API ​

ObjCJS
scrollViewWillEndDragging:withVelocity:targetContentOffset:The beforedragend event
The velocity parameterevent.velocity
*targetContentOffset = CGPointMake(0, y)event.targetContentOffset = new CGPoint(0, y)

See also ​