Class PluginManager

constructor

• new PluginManager(viewport: Viewport): PluginManager

  This is called by Viewport to initialize the plugins.

  Parameters

  • viewport: Viewport

  Returns PluginManager

list

plugins

Readonlyviewport

add

• add(name: string, plugin: Plugin, index?: number): void

  Inserts a named plugin or a user plugin into the viewport default plugin order: 'drag', 'pinch', 'wheel', 'follow', 'mouse-edges', 'edge-scroll', 'decelerate', 'bounce', 'snap-zoom', 'clamp-zoom', 'snap', 'clamp'

  Parameters

  • name: string

    of plugin

  • plugin: Plugin

    instantiated Plugin class

  • Optionalindex: number

    position in the plugin order (built-in plugins keep their default position and user plugins are added at the end if not provided)

  Returns void

get

• get(name: "animate", ignorePaused?: boolean): Animate | null | undefined

  Parameters

  • name: "animate"
  • OptionalignorePaused: boolean

  Returns Animate | null | undefined

• get(name: "bounce", ignorePaused?: boolean): Bounce | null | undefined

  Parameters

  • name: "bounce"
  • OptionalignorePaused: boolean

  Returns Bounce | null | undefined

• get(name: "clamp", ignorePaused?: boolean): Clamp | null | undefined

  Parameters

  • name: "clamp"
  • OptionalignorePaused: boolean

  Returns Clamp | null | undefined

• get(name: "clamp-zoom", ignorePaused?: boolean): ClampZoom | null | undefined

  Parameters

  • name: "clamp-zoom"
  • OptionalignorePaused: boolean

  Returns ClampZoom | null | undefined

• get(name: "decelerate", ignorePaused?: boolean): Decelerate | null | undefined

  Parameters

  • name: "decelerate"
  • OptionalignorePaused: boolean

  Returns Decelerate | null | undefined

• get(name: "drag", ignorePaused?: boolean): Drag | null | undefined

  Parameters

  • name: "drag"
  • OptionalignorePaused: boolean

  Returns Drag | null | undefined

• get(name: "follow", ignorePaused?: boolean): Follow | null | undefined

  Parameters

  • name: "follow"
  • OptionalignorePaused: boolean

  Returns Follow | null | undefined

• get(name: "mouse-edges", ignorePaused?: boolean): MouseEdges | null | undefined

  Parameters

  • name: "mouse-edges"
  • OptionalignorePaused: boolean

  Returns MouseEdges | null | undefined

• get(name: "edge-scroll", ignorePaused?: boolean): EdgeScroll | null | undefined

  Parameters

  • name: "edge-scroll"
  • OptionalignorePaused: boolean

  Returns EdgeScroll | null | undefined

• get(name: "pinch", ignorePaused?: boolean): Pinch | null | undefined

  Parameters

  • name: "pinch"
  • OptionalignorePaused: boolean

  Returns Pinch | null | undefined

• get(name: "snap", ignorePaused?: boolean): Snap | null | undefined

  Parameters

  • name: "snap"
  • OptionalignorePaused: boolean

  Returns Snap | null | undefined

• get(name: "snap-zoom", ignorePaused?: boolean): SnapZoom | null | undefined

  Parameters

  • name: "snap-zoom"
  • OptionalignorePaused: boolean

  Returns SnapZoom | null | undefined

• get(name: "wheel", ignorePaused?: boolean): Wheel | null | undefined

  Parameters

  • name: "wheel"
  • OptionalignorePaused: boolean

  Returns Wheel | null | undefined

• get<T extends Plugin = Plugin>(
      name: string,
      ignorePaused?: boolean,
  ): T | null | undefined

  Type Parameters

  • T extends Plugin = Plugin

  Parameters

  • name: string
  • OptionalignorePaused: boolean

  Returns T | null | undefined

pause

• pause(name: string): void

  Pause plugin

  Parameters

  • name: string

    of plugin (e.g., 'drag', 'pinch')

  Returns void

remove

• remove(name: string): void

  Removes installed plugin

  Parameters

  • name: string

    of plugin (e.g., 'drag', 'pinch')

  Returns void

removeAll

• removeAll(): void

  removes all installed plugins

  Returns void

reset

• reset(): void

  Clamps and resets bounce and decelerate (as needed) after manually moving viewport

  Returns void

resume

• resume(name: string): void

  Resume plugin

  Parameters

  • name: string

    of plugin (e.g., 'drag', 'pinch')

  Returns void