Class default

Hierarchy

BasePlugin<ZoomPluginEvents, ZoomPluginOptions>
- default

Index

Constructors

Properties

accumulatedDelta container options subscriptions wavesurfer? wrapper

Methods

_init calculateNewZoom destroy emit on onInit onWheel once un unAll create

Constructors

constructor

new default(options?): default
Parameters
- Optional options: ZoomPluginOptions
Returns default
Overrides BasePlugin<ZoomPluginEvents, ZoomPluginOptions>.constructor
- Defined in plugins/zoom.ts:53

Properties

`Private` accumulatedDelta

accumulatedDelta: number = 0

`Private` container

container: null | HTMLElement = null

`Protected` options

options: ZoomPluginOptions & {
deltaThreshold: number;
scale: number;
}

Type declaration

deltaThreshold: number
scale: number

`Protected` subscriptions

subscriptions: (() => void)[] = []

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: default

`Private` wrapper

wrapper: undefined | HTMLElement = undefined

Methods

_init

_init(wavesurfer): void
Do not call directly, only called by WavesSurfer internally
Parameters
- wavesurfer: default
Returns void
Inherited from BasePlugin._init
- Defined in base-plugin.ts:28

`Private` calculateNewZoom

calculateNewZoom(oldZoom, delta): number
Parameters
- oldZoom: number
- delta: number
Returns number
- Defined in plugins/zoom.ts:105

destroy

destroy(): void
Returns void
Overrides BasePlugin.destroy
- Defined in plugins/zoom.ts:110

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "destroy"
Parameters
- eventName: EventName
- Rest ...args: BasePluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "destroy"
Parameters
- event: EventName
- listener: EventListener<BasePluginEvents, EventName>
- Optional options: {
  once?: boolean;
  }
  - Optional once?: boolean
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from BasePlugin.on
- Defined in event-emitter.ts:20

onInit

onInit(): void
Returns void
Overrides BasePlugin.onInit
- Defined in plugins/zoom.ts:62

`Private` onWheel

onWheel(e): void
Parameters
- e: WheelEvent
Returns void
- Defined in plugins/zoom.ts:71

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "destroy"
Parameters
- event: EventName
- listener: EventListener<BasePluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "destroy"
Parameters
- event: EventName
- listener: EventListener<BasePluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:43

unAll

unAll(): void
Clear all events

Returns void
Inherited from BasePlugin.unAll
- Defined in event-emitter.ts:59

`Static` create

create(options?): default
Parameters
- Optional options: ZoomPluginOptions
Returns default
- Defined in plugins/zoom.ts:58

Generated using TypeDoc