Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GcDebounceScroll

Limits the rate at which scroll function can fire. Used for smooth scrolling.

Hierarchy

  • GcDebounceScroll

Index

Accessors

cancelUnhandledScrolls

  • get cancelUnhandledScrolls(): boolean
  • set cancelUnhandledScrolls(cancel: boolean): void
  • Returns true when cancel unhandled scroll events enabled.

    Returns boolean

  • Set this property to true if you want to

    1. prevent scroll position change until callback is called.
    2. enable callback restoreCancelledScrollCallback

    Parameters

    • cancel: boolean

    Returns void

Methods

setScrollContainer

  • setScrollContainer(scrollContainer: any): void
  • Method can be used to change scroll container.

    Parameters

    • scrollContainer: any

      new scroll container.

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Static property
  • Static method
  • Method