Class default

Hierarchy

BasePlugin<HoverPluginEvents, HoverPluginOptions>
- default

Index

Constructors

constructor

new default(options?): default
Parameters
- Optional options: HoverPluginOptions
Returns default
Overrides BasePlugin<HoverPluginEvents, HoverPluginOptions>.constructor
- Defined in plugins/hover.ts:57

Properties

`Private` label

label: HTMLElement

`Protected` options

options: HoverPluginOptions & {
    labelPreferLeft: boolean;
    labelSize: number;
    lineWidth: number;
    formatTimeCallback(seconds) => string;
}

Type declaration

labelPreferLeft: boolean
labelSize: number
lineWidth: number
formatTimeCallback:function
- formatTimeCallback(seconds): string
- Parameters
  - seconds: number
  Returns string
  - Defined in plugins/hover.ts:39

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Private` unsubscribe

unsubscribe: (() => void) = ...

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: default

`Private` wrapper

wrapper: HTMLElement

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` addUnits

addUnits(value): string
Parameters
- value: string | number
Returns string
- Defined in plugins/hover.ts:70

destroy

destroy(): void
Unmount

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/hover.ts:150

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "destroy" | "hover"
Parameters
- eventName: EventName
- Rest ...args: HoverPluginEvents[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" | "hover"
Parameters
- event: EventName
- listener: EventListener<HoverPluginEvents, 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
Called by wavesurfer, don't call manually

Returns void
Overrides BasePlugin.onInit
- Defined in plugins/hover.ts:76

`Private` onPointerLeave

onPointerLeave(): void
Returns void
- Defined in plugins/hover.ts:145

`Private` onPointerMove

onPointerMove(e): void
Parameters
- e: PointerEvent | WheelEvent
Returns void
- Defined in plugins/hover.ts:122

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "destroy" | "hover"
Parameters
- event: EventName
- listener: EventListener<HoverPluginEvents, 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" | "hover"
Parameters
- event: EventName
- listener: EventListener<HoverPluginEvents, 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: HoverPluginOptions
Returns default
- Defined in plugins/hover.ts:66

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: HoverPluginOptions

Returns default

Properties

Private label

Protected options

Type declaration

labelPreferLeft: boolean

labelSize: number

lineWidth: number

formatTimeCallback:function

Parameters

seconds: number

Returns string

Protected subscriptions

Type declaration

Returns void

Private unsubscribe

Type declaration

Returns void

Protected Optional wavesurfer

Private wrapper

Methods

_init

Parameters

wavesurfer: default

Returns void

Private addUnits

Parameters

value: string | number

Returns string

destroy

Returns void

Protected emit

Type Parameters

EventName extends "destroy" | "hover"

Parameters

eventName: EventName

Rest ...args: HoverPluginEvents[EventName]

Returns void

on

Type Parameters

EventName extends "destroy" | "hover"

Parameters

event: EventName

listener: EventListener<HoverPluginEvents, EventName>

Optional options: { once?: boolean; }

Optional once?: boolean

Returns (() => void)

Returns void

onInit

Returns void

Private onPointerLeave

Returns void

Private onPointerMove

Parameters

e: PointerEvent | WheelEvent

Returns void

once

Type Parameters

EventName extends "destroy" | "hover"

Parameters

event: EventName

listener: EventListener<HoverPluginEvents, EventName>

Returns (() => void)

Returns void

un

Type Parameters

EventName extends "destroy" | "hover"

Parameters

event: EventName

listener: EventListener<HoverPluginEvents, EventName>

`Optional` options: HoverPluginOptions

`Private` label

`Protected` options

`Protected` subscriptions

`Private` unsubscribe

`Protected` `Optional` wavesurfer

`Private` wrapper

`Private` addUnits

`Protected` emit

`Rest` ...args: HoverPluginEvents[EventName]

`Optional` options: {
once?: boolean;
}

`Optional` once?: boolean

`Private` onPointerLeave

`Private` onPointerMove

`Static` create

`Optional` options: HoverPluginOptions