Class Scroller

Index

Constructor methods

Methods

Constructor methods

constructor(callback: (left: number, top: number, zoom: number) => void, options: ScrollerOptions): Scroller

Parameters

  • callback: (left: number, top: number, zoom: number) => void
  • options: ScrollerOptions

Returns

Scroller

Methods

public activatePullToRefresh(height: number, activateCallback: Function, deactivateCallback: Function, startCallback: Function)

Parameters

  • height: number
  • activateCallback: Function
  • deactivateCallback: Function
  • startCallback: Function

public doMouseZoom(wheelDelta: number, timeStamp: number, pageX: number, pageY: number)

Parameters

  • wheelDelta: number
  • timeStamp: number
  • pageX: number
  • pageY: number

public doTouchEnd(timeStamp: number)

Parameters

  • timeStamp: number

public doTouchMove(touches: Array<any>, timeStamp: number, scale?: number)

Parameters

  • touches: Array<any>
  • timeStamp: number
  • scale?: number optional

public doTouchStart(touches: Array<any>, timeStamp: number)

Parameters

  • touches: Array<any>
  • timeStamp: number

public finishPullToRefresh()

public getScrollMax(): ScrollValues

Returns

ScrollValues

public getValues(): ScrollValuesWithZoom

Returns

ScrollValuesWithZoom

public scrollBy(left?: number, top?: number, animate?: number)

Parameters

  • left?: number optional
  • top?: number optional
  • animate?: number optional

public scrollTo(left?: number, top?: number, animate?: number, zoom?: number)

Parameters

  • left?: number optional
  • top?: number optional
  • animate?: number optional
  • zoom?: number optional

public setDimensions(clientWidth: number, clientHeight: number, contentWidth: number, contentHeight: number)

Parameters

  • clientWidth: number
  • clientHeight: number
  • contentWidth: number
  • contentHeight: number

public setPosition(left: number, top: number)

Parameters

  • left: number
  • top: number

public setSnapSize(width: number, height: number)

Parameters

  • width: number
  • height: number

public zoomBy(factor: number, animate?: boolean, originLeft?: boolean, originTop?: boolean)

Parameters

  • factor: number
  • animate?: boolean optional
  • originLeft?: boolean optional
  • originTop?: boolean optional

public zoomTo(level: number, animate?: boolean, originLeft?: boolean, originTop?: boolean)

Parameters

  • level: number
  • animate?: boolean optional
  • originLeft?: boolean optional
  • originTop?: boolean optional