issue #1603 - key signature on non-treble stave, no glyph #1606
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
None of our test cases had clef with non-default clef (e.g. bass) and a key signature, without the clef symbol displayed. I added a test case and created a 'addClefLines' that adds the logical clef (e.g. the lines match the clef) but without the glyph.
rvilarl
approved these changes
Jan 4, 2024
src/stave.ts
Outdated
|
|
||
| /** | ||
| * treat the stave as if the clef is clefSpec, but don't display the clef | ||
| * @param clefSpec |
There was a problem hiding this comment.
@param is no longer needed.
| @@ -443,7 +443,14 @@ export class Stave extends Element { | |||
| } | |||
| return this; | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Please leave a space before and after the function.
tests/keysignature_tests.ts
Outdated
| function clefKeySignature(options: TestOptions): void { | ||
| const f = VexFlowTests.makeFactory(options, 900); | ||
|
|
||
| // The previous code was buggy: f.Stave(10, 10, 800), even though Factory.Stave() only accepts 1 argument. |
tests/keysignature_tests.ts
Outdated
| f.KeySigNote({ key: 'Bb' }), | ||
| f.StaveNote({ keys: ['c/4'], duration: '1', clef: 'bass' }), | ||
| f.BarNote(), | ||
| f.KeySigNote({ key: 'D', alterKey: ['b', 'n'] }), // TODO: alterKey needs to be a string[] |
| f.draw(); | ||
|
|
||
| options.assert.ok(true, 'all pass'); | ||
| } |
There was a problem hiding this comment.
Add a line after the function.
|
@AaronDavidNewman Thanks for the PR, let me know if you prefer to do the changes or just to let it and merge. Also, would you like to do the same PR in Vexflow 5 or should I do it? |
|
After the merge, you can try to cherry pick the commit and apply it to the V5 repo (assuming the modified file isn't substantially different). That way the authorship is preserved, I believe. (Or Aaron can submit the V5 PR himself.) |
|
I updated based on comments and I'll merge it in. I'll look at vex5 soon and submit a PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this fix, there was no way to show a key signature correctly in a bass clef stave, without the clef glyph (and any other non-treble). I added a test case and created a
stave.addClefLines(clefSpec: string)method that adds the logical clef (e.g. the lines match the clef) but without the glyph.