Class VScrollBar

constructor

• new VScrollBar(parent: any, renderer: any): VScrollBar

• Parameters

  • parent: any
  • renderer: any

  Returns VScrollBar

height

pageHeight

parent

renderer

scrollHeight

scrollTop

setInnerHeight

slideHeight

thumbHeight

thumbTop

viewHeight

width

_dispatchEvent

• _dispatchEvent<K extends "scroll">(
      eventName: K,
      ...args: Parameters<ScrollbarEvents[K]>,
  ): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • eventName: K
  • ...args: Parameters<ScrollbarEvents[K]>

  Returns void

_emit

• _emit<K extends "scroll">(
      eventName: K,
      ...args: Parameters<ScrollbarEvents[K]>,
  ): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • eventName: K
  • ...args: Parameters<ScrollbarEvents[K]>

  Returns void

_signal

• _signal<K extends "scroll">(
      eventName: K,
      ...args: Parameters<ScrollbarEvents[K]>,
  ): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • eventName: K
  • ...args: Parameters<ScrollbarEvents[K]>

  Returns void

addEventListener

• addEventListener<K extends "scroll">(
      name: K,
      callback: ScrollbarEvents[K],
      capturing?: boolean,
  ): ScrollbarEvents[K]

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]
  • Optionalcapturing: boolean

  Returns ScrollbarEvents[K]

getHeight

• getHeight(): number

• Returns number

getWidth

• getWidth(): number

• Returns the width of the scroll bar.

  Returns number

off

• off<K extends "scroll">(name: K, callback: ScrollbarEvents[K]): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]

  Returns void

on

• on<K extends "scroll">(
      name: K,
      callback: ScrollbarEvents[K],
      capturing?: boolean,
  ): ScrollbarEvents[K]

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]
  • Optionalcapturing: boolean

  Returns ScrollbarEvents[K]

once

• once<K extends "scroll">(name: K, callback: ScrollbarEvents[K]): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]

  Returns void

removeAllListeners

• removeAllListeners(name?: string): void

• Parameters

  • Optionalname: string

  Returns void

removeDefaultHandler

• removeDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

removeEventListener

• removeEventListener<K extends "scroll">(
      name: K,
      callback: ScrollbarEvents[K],
  ): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]

  Returns void

removeListener

• removeListener<K extends "scroll">(name: K, callback: ScrollbarEvents[K]): void

• Type Parameters

  • K extends "scroll"

  Parameters

  • name: K
  • callback: ScrollbarEvents[K]

  Returns void

scrollTopFromThumbTop

• scrollTopFromThumbTop(thumbTop: number): number

• Returns new top for scroll thumb

  Parameters

  • thumbTop: number

  Returns number

setDefaultHandler

• setDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

setHeight

• setHeight(height: number): void

• Sets the height of the scroll bar, in pixels.

  Parameters

  • height: number

    The new height

  Returns void

setScrollHeight

• setScrollHeight(height: number, force: boolean): void

• Sets the inner and scroll height of the scroll bar, in pixels.

  Parameters

  • height: number

    The new inner height
  • force: boolean

    Forcely update height

  Returns void

setScrollTop

• setScrollTop(scrollTop: number): void

• Sets the scroll top of the scroll bar.

  Parameters

  • scrollTop: number

    The new scroll top

  Returns void