Class default

Hierarchy

BasePlugin<RegionsPluginEvents, RegionsPluginOptions>
- default

Index

Constructors

Properties

options regions regionsContainer subscriptions wavesurfer?

Methods

_init addRegion adjustScroll avoidOverlapping clearRegions destroy emit enableDragSelection getRegions initRegionsContainer on onInit once saveRegion un unAll virtualAppend create

Constructors

constructor

new default(options?): default
Create an instance of RegionsPlugin
Parameters
- Optional options: undefined
Returns default
Overrides BasePlugin<RegionsPluginEvents, RegionsPluginOptions>.constructor
- Defined in plugins/regions.ts:410

Properties

`Protected` options

options: undefined

`Private` regions

regions: SingleRegion[] = []

`Private` regionsContainer

regionsContainer: HTMLElement

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: default

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

addRegion

addRegion(options): SingleRegion
Create a region with given parameters
Parameters
- options: RegionParams
Returns SingleRegion
- Defined in plugins/regions.ts:592

`Private` adjustScroll

adjustScroll(region): void
Parameters
- region: SingleRegion
Returns void
- Defined in plugins/regions.ts:501

`Private` avoidOverlapping

avoidOverlapping(region): void
Parameters
- region: SingleRegion
Returns void
- Defined in plugins/regions.ts:476

clearRegions

clearRegions(): void
Remove all regions

Returns void
- Defined in plugins/regions.ts:678

destroy

destroy(): void
Destroy the plugin and clean up

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/regions.ts:685

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"
Parameters
- eventName: EventName
- Rest ...args: RegionsPluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

enableDragSelection

enableDragSelection(options, threshold?): (() => void)
Enable creation of regions by dragging on an empty space on the waveform. Returns a function to disable the drag selection.
Parameters
- options: Omit<RegionParams, "start" | "end">
- threshold: number = 3
Returns (() => void)
- - (): void
  - Enable creation of regions by dragging on an empty space on the waveform. Returns a function to disable the drag selection.
    
    Returns void
- Defined in plugins/regions.ts:619

getRegions

getRegions(): SingleRegion[]
Get all created regions

Returns SingleRegion[]
- Defined in plugins/regions.ts:472

`Private` initRegionsContainer

initRegionsContainer(): HTMLElement
Returns HTMLElement
- Defined in plugins/regions.ts:457

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"
Parameters
- event: EventName
- listener: EventListener<RegionsPluginEvents, 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/regions.ts:421

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"
Parameters
- event: EventName
- listener: EventListener<RegionsPluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

`Private` saveRegion

saveRegion(region): void
Parameters
- region: SingleRegion
Returns void
- Defined in plugins/regions.ts:546

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"
Parameters
- event: EventName
- listener: EventListener<RegionsPluginEvents, 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

`Private` virtualAppend

virtualAppend(region, container, element): void
Parameters
- region: SingleRegion
- container: HTMLElement
- element: HTMLElement
Returns void
- Defined in plugins/regions.ts:517

`Static` create

create(options?): default
Create an instance of RegionsPlugin
Parameters
- Optional options: undefined
Returns default
- Defined in plugins/regions.ts:416

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: undefined

Returns default

Properties

Protected options

Private regions

Private regionsContainer

Protected subscriptions

Type declaration

Returns void

Protected Optional wavesurfer

Methods

_init

Parameters

wavesurfer: default

Returns void

addRegion

Parameters

options: RegionParams

Returns SingleRegion

Private adjustScroll

Parameters

region: SingleRegion

Returns void

Private avoidOverlapping

Parameters

region: SingleRegion

Returns void

clearRegions

Returns void

destroy

Returns void

Protected emit

Type Parameters

EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"

Parameters

eventName: EventName

Rest ...args: RegionsPluginEvents[EventName]

Returns void

enableDragSelection

Parameters

options: Omit<RegionParams, "start" | "end">

threshold: number = 3

Returns (() => void)

Returns void

getRegions

Returns SingleRegion[]

Private initRegionsContainer

Returns HTMLElement

on

Type Parameters

EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"

Parameters

event: EventName

listener: EventListener<RegionsPluginEvents, EventName>

Optional options: { once?: boolean; }

Optional once?: boolean

Returns (() => void)

Returns void

onInit

Returns void

once

Type Parameters

EventName extends "destroy" | "region-created" | "region-update" | "region-updated" | "region-removed" | "region-clicked" | "region-double-clicked" | "region-in" | "region-out"

Parameters

event: EventName

listener: EventListener<RegionsPluginEvents, EventName>

Returns (() => void)

Returns void

Private saveRegion

Parameters

region: SingleRegion

`Optional` options: undefined

`Protected` options

`Private` regions

`Private` regionsContainer

`Protected` subscriptions

`Protected` `Optional` wavesurfer

`Private` adjustScroll

`Private` avoidOverlapping

`Protected` emit

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

`Private` initRegionsContainer

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

`Optional` once?: boolean

`Private` saveRegion

`Private` virtualAppend

`Static` create

`Optional` options: undefined