regions plugin: add regionsMinLength option

[marizuccara]

Added generalMinLength parameter to control min length of regions created dragging on drawer (so not those passed on initialization in regions array), to avoid dragging regions to size 0.

NB. Maybe unify in some way minLength and generalMinLength parameters if necesssary?

Related Issues and other PRs:

PR #2002
ISSUES #2001 #2008

[coveralls]

Coverage remained the same at 80.385% when pulling 28bd387 on marizuccara:master into 4eedd08 on katspaugh:master.

[thijstriemstra]

@sundayz can you also take a look? ps. I'm not a fan of the parameter name @marizuccara

[sundayz]

Maybe add a comment so people know a region's minLength is used over generalMinLength if both are specified

[thijstriemstra]

ping @marizuccara

[sundayz]

Maybe regionMinLength would be a better name, but I don't mind what name is used. example/regions/index.html should be updated to show the settings that are being used in the .js file.

When I tried testing this, generalMinLength seems to always be undefined? The code looks right I don't know why it's not being passed to the plugin constructor

edit:

okay so I see generalMinLength only applies to regions created by dragging the mouse.
I think it would be better if generalMinLength applied to all regions. If you want to set a different min length for regions created via the mouse it should be done by listening to the region-created event and modifying the region after it's created. That makes more sense to me. for example:

(example code, might not work)

// first wait for the region plugin to be loaded
wavesurfer.on('plugin-added', name => {
    if (name == 'regions') {
        // now any regions created after the plugin was loaded (i.e. via mouse drag) have minlength of 1.5
        wavesurfer.on('region-created', region => region.minLength = 1.5)
    } 
})

[marizuccara]

Maybe regionMinLength would be a better name, but I don't mind what name is used. example/regions/index.html should be updated to show the settings that are being used in the .js file.

When I tried testing this, generalMinLength seems to always be undefined? The code looks right I don't know why it's not being passed to the plugin constructor

edit:

okay so I see generalMinLength only applies to regions created by dragging the mouse.
I think it would be better if generalMinLength applied to all regions. If you want to set a different min length for regions created via the mouse it should be done by listening to the region-created event and modifying the region after it's created. That makes more sense to me. for example:

(example code, might not work)

// first wait for the region plugin to be loaded
wavesurfer.on('plugin-added', name => {
    if (name == 'regions') {
        // now any regions created after the plugin was loaded (i.e. via mouse drag) have minlength of 1.5
        wavesurfer.on('region-created', region => region.minLength = 1.5)
    } 
})

I'm agree, thanks. Later fix

[marizuccara]

So sorry for the absence :(
If you approve these changes, I'll update changelog end regions/index.html example

[thijstriemstra]

@marizuccara there are many old, unrelated changes in this PR, can you take a look at that?

[marizuccara]

@sundayz have you take a look at this PR if you'll have time?

[sundayz]

I tested the change and it works as intended:

• When setting minLength AND regionsMinLength, minLength is used
• When setting only minLength and no regionsMinLength, minLength is used
• When setting only regionsMinLength and no minLength, regionsMinLength is used

Works well, just need to update HTML for the examples page

[thijstriemstra]

see inline comment and there's a merge conflict with this branch.