Class ZoomInteraction

Interaction handler for zooming the canvas, which is achieved by scrolling the mouse wheel on the canvas.

For examples, head to the Zoom Interaction documentation page.

Hierarchy

BaseInteraction<ZoomInteractionCallbacks, Record<string, never>>
- ZoomInteraction

Index

Constructors

Properties

Accessors

containerInstance currentOptions nvlInstance

Methods

addEventListener callCallbackIfRegistered destroy removeCallback removeEventListener toggleGlobalTextSelection updateCallback

Constructors

constructor

new ZoomInteraction(nvl, options?): ZoomInteraction
Creates a new instance of the zoom interaction handler.
Parameters
- nvl: NVL
  The NVL instance to attach the interaction handler to
- options: {} = {}
Returns ZoomInteraction
Overrides BaseInteraction<ZoomInteractionCallbacks, Record<string, never>>.constructor

Properties

`Internal`callbackMap

callbackMap: Map<"onZoom", undefined | boolean | ((zoomLevel: number, event: WheelEvent) => void)>

Accessors

containerInstance

get containerInstance(): HTMLElement
Internal
Returns HTMLElement
Inherited from BaseInteraction.containerInstance

currentOptions

get currentOptions(): P
Returns P
Inherited from BaseInteraction.currentOptions

nvlInstance

get nvlInstance(): NVL
Internal
Returns NVL
Inherited from BaseInteraction.nvlInstance

Methods

addEventListener

addEventListener(type, listener, options?): void
Internal
Parameters
- type: keyof HTMLElementEventMap
- listener: ((event: Event) => void)
  - - (event): void
    - Parameters
      event: Event
      Returns void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from BaseInteraction.addEventListener

callCallbackIfRegistered

callCallbackIfRegistered(name, ...args): void
Internal
Parameters
- name: "onZoom"
- Rest...args: unknown[]
Returns void
Inherited from BaseInteraction.callCallbackIfRegistered

destroy

destroy(): void
Removes the relevant event listeners from the canvas.

Returns void
Overrides BaseInteraction.destroy

removeCallback

removeCallback(name): void
Remove a callback for a given event of type.
Parameters
- name: string
  The name of the event
Returns void
Inherited from BaseInteraction.removeCallback

removeEventListener

removeEventListener(type, listener, options?): void
Internal
Parameters
- type: keyof HTMLElementEventMap
- listener: ((event: Event) => void)
  - - (event): void
    - Parameters
      event: Event
      Returns void
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from BaseInteraction.removeEventListener

toggleGlobalTextSelection

toggleGlobalTextSelection(enable, eventFunction?): void
Enables or disables global text selection during a drag or pan operation.
Parameters
- enable: boolean
  Whether to enable or disable global text selection
- OptionaleventFunction: ((this: HTMLElement, ev: MouseEvent) => void)
  The event function to be added/removed when text selection is disabled/enabled
  - - (this, ev): void
    - Parameters
      this: HTMLElement
      ev: MouseEvent
      Returns void
Returns void
Inherited from BaseInteraction.toggleGlobalTextSelection

updateCallback

updateCallback(name, callback): void
Add or update a callback for a given event of type.
Parameters
- name: string
  The name of the event
- callback: undefined | boolean | ((zoomLevel: number, event: WheelEvent) => void)
  The callback to be called when the event is triggered
Returns void
Inherited from BaseInteraction.updateCallback