Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: adjust highlight to align with verovio changes #1293

Merged
merged 2 commits into from
Feb 14, 2025
+137 −76
Merged

fix: adjust highlight to align with verovio changes #1293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1d5d10
fix: adjust highlight to align with verovio changes
yinanazhou Feb 14, 2025
e4da3da
test: update divLine highlight test
yinanazhou Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions cypress/e2e/select.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,12 @@ beforeEach(() => {

describe('select: syllable', () => {
beforeEach(() => {
cy.get('#selBySyllable')
.click()
.should('have.class', 'is-active');
cy.get('#selBySyllable').click().should('have.class', 'is-active');
});

it('highlight: syllable should be selected red', () => {
cy.get('.syllable').first()
cy.get('.syllable')
.first()
.click({ timeout: 100, force: true })
.should('have.class', 'selected')
.should('have.css', 'fill')
Expand All @@ -29,9 +28,7 @@ describe('select: syllable', () => {

describe('select: staff', () => {
beforeEach(() => {
cy.get('#selByStaff')
.click()
.should('have.class', 'is-active');
cy.get('#selByStaff').click().should('have.class', 'is-active');
});

it('highlight: syllables, clefs, and accids', () => {
Expand Down Expand Up @@ -63,7 +60,7 @@ describe('select: staff', () => {
.within(() => {
cy.get('.divLine')
.should('have.class', 'highlighted')
.and('have.css', 'stroke')
.and('have.css', 'color')
.and('eq', 'rgb(221, 0, 0)');
});
});
Expand All @@ -78,5 +75,4 @@ describe('select: staff', () => {

cy.get('#svg_group').find('.resizePoint').should('have.length', 8);
});

});
195 changes: 130 additions & 65 deletions src/utils/Color.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const ColorPalette: string[] = [
'rgb(240, 228, 66)',
'rgb(0, 114, 178)',
'rgb(213, 94, 0)',
'rgb(204, 121, 167)'
'rgb(204, 121, 167)',
];

/**
Expand All @@ -26,28 +26,36 @@ export function unhighlight(staff?: SVGGElement): void {
} else {
children = document.querySelectorAll(':not(.selected) .highlighted');
}
children.forEach(elem => {
if (elem.tagName === 'path' && !elem.closest('.staff').classList.contains('selected')) {
elem.setAttribute('stroke', '#000000');
} else if (elem.classList.contains('divLine') && !elem.closest('.staff').classList.contains('selected')) {
elem.setAttribute('stroke', '#000000');
}
else {
children.forEach((elem) => {
if (
elem.tagName === 'path' &&
!elem.closest('.staff').classList.contains('selected')
) {
(elem as SVGPathElement).style.stroke = '#000000';
} else if (
elem.classList.contains('divLine') &&
!elem.closest('.staff').classList.contains('selected')
) {
(elem as SVGPathElement).style.color = '#000000';
} else {
elem.removeAttribute('fill');
let rects = elem.querySelectorAll('.sylTextRect-display');
if (!rects.length) {
try {
rects = elem.closest('.syllable').querySelectorAll('.sylTextRect-display');
rects = elem
.closest('.syllable')
.querySelectorAll('.sylTextRect-display');
} catch (e) {
rects = [] as unknown as NodeListOf<Element>;
}
}
rects.forEach(function (rect: HTMLElement) {
if (rect.closest('.syllable').classList.contains('selected') ||
if (
rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.staff').classList.contains('selected') ||
rect.closest('.syl').classList.contains('selected')
// rect.closest('.layer').classList.contains('selected')
){
) {
rect.style.fill = '#d00';
} else {
rect.style.fill = 'blue';
Expand All @@ -71,32 +79,40 @@ export function unsetStaffHighlight(): void {
*/
export function unsetGroupingHighlight(): void {
unsetStaffHighlight();
const highlighted = Array.from(document.getElementsByClassName('highlighted'))
.filter((elem: HTMLElement) => !elem.parentElement.classList.contains('selected'));
const highlighted = Array.from(
document.getElementsByClassName('highlighted'),
).filter(
(elem: HTMLElement) => !elem.parentElement.classList.contains('selected'),
);
highlighted.forEach((elem: HTMLElement) => {
elem.setAttribute('#d00', null);
let rects = elem.querySelectorAll('.sylTextRect-display');
if (!rects.length) {
if (elem.closest('.syllable') !== null) {
rects = elem.closest('.syllable').querySelectorAll('sylTextRect-display');
rects = elem
.closest('.syllable')
.querySelectorAll('sylTextRect-display');
}
}
rects.forEach(function (rect: HTMLElement) {
if (rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.syl').classList.contains('selected')
){
if (
rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.syl').classList.contains('selected')
) {
rect.style.fill = '#d00';
} else {
rect.style.fill = 'blue';
}
rect.classList.remove('highlighted');
});
elem.classList.remove('highlighted');
elem.querySelectorAll('sylTextRect-display').forEach(rect => {
elem.querySelectorAll('sylTextRect-display').forEach((rect) => {
rect.classList.remove('highlighted');
});
});
Array.from(document.getElementsByClassName('selected')).forEach((el) => { el.setAttribute('fill', ''); });
Array.from(document.getElementsByClassName('selected')).forEach((el) => {
el.setAttribute('fill', '');
});
}

/**
Expand All @@ -107,37 +123,63 @@ export function highlight(staff: SVGGElement, color: string): void {
for (let i = 0; i < children.length; i++) {
const child = children[i];
if (child.tagName === 'path') {
child.setAttribute('stroke', color);
(child as SVGPathElement).style.stroke = color;
} else if (child.classList.contains('divLine')) {
child.setAttribute('stroke', color);
(child as SVGPathElement).style.color = color;
child.setAttribute('stroke-width', '30px');
} else if (child.querySelectorAll('.divLine').length && child.classList.contains('syllable')) {
Array.from(child.children).filter(el => el.querySelectorAll('.divLine')).forEach(cchild => { children.push(cchild); });
}
else if (child.classList.contains('resizePoint') || child.id === 'resizeRect' || child.classList.contains('rotatePoint')) {
} else if (
child.querySelectorAll('.divLine').length &&
child.classList.contains('syllable')
) {
Array.from(child.children)
.filter((el) => el.querySelectorAll('.divLine'))
.forEach((cchild) => {
children.push(cchild);
});
} else if (
child.classList.contains('resizePoint') ||
child.id === 'resizeRect' ||
child.classList.contains('rotatePoint')
) {
return;
} else if (child.classList.contains('layer')) {
Array.from(child.children).forEach(cchild => { children.push(cchild); });
} else if (document.getElementsByClassName('highlight-selected').length &&
document.getElementsByClassName('highlight-selected')[0].id === 'highlight-neume'
&& child.classList.contains('syllable')) {
Array.from(child.children).filter(el => el.classList.contains('neume')).forEach(cchild => { children.push(cchild); });
Array.from(child.children).forEach((cchild) => {
children.push(cchild);
});
} else if (
document.getElementsByClassName('highlight-selected').length &&
document.getElementsByClassName('highlight-selected')[0].id ===
'highlight-neume' &&
child.classList.contains('syllable')
) {
Array.from(child.children)
.filter((el) => el.classList.contains('neume'))
.forEach((cchild) => {
children.push(cchild);
});
} else {
child.setAttribute('fill', color);
let rects = child.querySelectorAll('.sylTextRect-display');
if (!rects.length) {
try {
rects = child.closest('.syllable').querySelectorAll('.sylTextRect-display');
rects = child
.closest('.syllable')
.querySelectorAll('.sylTextRect-display');
} catch (e) {
rects = [] as unknown as NodeListOf<Element>;
}
}
rects.forEach(function (rect: HTMLElement) {
if (!(rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.syl').classList.contains('selected') ||
rect.closest('.staff').classList.contains('selected')
// rect.closest('.layer').classList.contains('selected')
)) {
if (
!(
(
rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.syl').classList.contains('selected') ||
rect.closest('.staff').classList.contains('selected')
)
// rect.closest('.layer').classList.contains('selected')
)
) {
rect.style.fill = color;
rect.classList.add('highlighted');
}
Expand All @@ -156,12 +198,11 @@ export function highlight(staff: SVGGElement, color: string): void {
if (width !== undefined && height !== undefined) {
// idk looks good :')
// TODO find a better way of calculating this as this actually doesn't work as well as 30px
stroke = (width * height / 1000000).toString();
}
else {
stroke = ((width * height) / 1000000).toString();
} else {
stroke = '30px';
}
staff.querySelectorAll('.nc, .custos, .clef, .accid').forEach(el => {
staff.querySelectorAll('.nc, .custos, .clef, .accid').forEach((el) => {
el.setAttribute('stroke', 'black');
el.setAttribute('stroke-width', stroke);
});
Expand All @@ -171,18 +212,22 @@ export function highlight(staff: SVGGElement, color: string): void {
* Highlight each staff a different color.
*/
export function setStaffHighlight(): void {
const staves = Array.from(document.getElementsByClassName('staff')) as SVGGElement[];
const staves = Array.from(
document.getElementsByClassName('staff'),
) as SVGGElement[];
for (let i = 0; i < staves.length; i++) {
const staffColor = ColorPalette[i % ColorPalette.length];
highlight(staves[i], staffColor);
}
}

function setColumnHighlight(): void {
const groups: { [key: number]: SVGGElement[] } = {};
const groups: { [key: number]: SVGGElement[] } = {};

document.querySelectorAll('.staff').forEach((staff) => {
const hasColumn = Array.from(staff.classList).join(' ').match(/\bcolumn(\d+)\b/);
const hasColumn = Array.from(staff.classList)
.join(' ')
.match(/\bcolumn(\d+)\b/);
let columnNum = 0;
if (hasColumn) {
columnNum = parseInt(hasColumn[1], 10) - 1;
Expand Down Expand Up @@ -212,12 +257,10 @@ export function setGroupingHighlight(grouping: GroupingType): void {
if (grouping === 'staff') {
setStaffHighlight();
return;
}
else if (grouping === 'column') {
} else if (grouping === 'column') {
setColumnHighlight();
return;
}
else if (grouping === 'selection') {
} else if (grouping === 'selection') {
const temp = document.querySelector('.sel-by.is-active').id;
switch (temp) {
case 'selBySyllable':
Expand Down Expand Up @@ -245,23 +288,36 @@ export function setGroupingHighlight(grouping: GroupingType): void {

if (grouping == 'layerElement') {
groups = document.querySelectorAll('.accid, .clef, .custos, .divLine');
}
else {
groups = document.getElementsByClassName(grouping) as HTMLCollectionOf<HTMLElement>;
} else {
groups = document.getElementsByClassName(
grouping,
) as HTMLCollectionOf<HTMLElement>;
}

document.querySelectorAll('.nc, .custos, .clef, .accid, .divLine').forEach(el => {
el.setAttribute('stroke', 'black');
el.setAttribute('stroke-width', '30px');
});
document
.querySelectorAll('.nc, .custos, .clef, .accid, .divLine')
.forEach((el) => {
el.setAttribute('stroke', 'black');
el.setAttribute('stroke-width', '30px');
});

for (let i = 0; i < groups.length; i++) {
const groupColor = ColorPalette[i % ColorPalette.length];
if ((groups[i].closest('.selected') === null) && !groups[i].classList.contains('selected')) {
groups[i].setAttribute('fill', groupColor);
const rects = groups[i].querySelectorAll('.sylTextRect-display') as NodeListOf<HTMLElement>;
if (
groups[i].closest('.selected') === null &&
!groups[i].classList.contains('selected')
) {
if (groups[i].classList.contains('divLine')) {
(groups[i] as SVGPathElement).style.color = groupColor;
} else {
groups[i].setAttribute('fill', groupColor);
}
const rects = groups[i].querySelectorAll(
'.sylTextRect-display',
) as NodeListOf<HTMLElement>;
rects.forEach(function (rect) {
if (rect.closest('.syl').classList.contains('selected') ||
if (
rect.closest('.syl').classList.contains('selected') ||
rect.closest('.syllable').classList.contains('selected') ||
rect.closest('.staff').classList.contains('selected')
) {
Expand All @@ -270,25 +326,34 @@ export function setGroupingHighlight(grouping: GroupingType): void {
rect.style.fill = groupColor;
});
groups[i].classList.add('highlighted');
groups[i].querySelectorAll('.sylTextRect-display').forEach(rect => {
groups[i].querySelectorAll('.sylTextRect-display').forEach((rect) => {
rect.classList.add('highlighted');
});
} else {
if (!groups[i].classList.contains('selected')) {
groups[i].setAttribute('fill', null);
if (groups[i].classList.contains('divLine')) {
(groups[i] as SVGPathElement).style.color = null;
} else {
groups[i].setAttribute('fill', null);
}
} else {
groups[i].setAttribute('fill', '#d00');
if (groups[i].classList.contains('divLine')) {
(groups[i] as SVGPathElement).style.color = '#d00';
} else {
groups[i].setAttribute('fill', '#d00');
}
}
groups[i].classList.remove('highlighted');
}

const divLineChildren = groups[i].querySelectorAll('.divLine');
const divLineChildren = groups[i].querySelectorAll(
'.divLine',
) as Array<SVGPathElement>;
if (divLineChildren) {
for (let j = 0; j < divLineChildren.length; j++) {
divLineChildren[j].setAttribute('stroke', groupColor);
divLineChildren[j].setAttribute('stroke-width', '30px');
divLineChildren[j].style.color = groupColor;
divLineChildren[j].style.strokeWidth = '30px';
}
}
}

}
4 changes: 2 additions & 2 deletions src/utils/SelectTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ export function select(
// set fill to red
// set stroke to red only if selected elem is a divLine
el.style.fill = '#d00';
el.style.stroke = el.classList.contains('divLine') ? '#d00' : 'black';
el.style.color = el.classList.contains('divLine') ? '#d00' : '';

if (el.querySelectorAll('.sylTextRect-display').length) {
el.querySelectorAll('.sylTextRect-display').forEach(
Expand All @@ -178,7 +178,7 @@ export function select(

if (el.querySelectorAll('.divLine').length) {
el.querySelectorAll('.divLine').forEach((elem: HTMLElement) => {
elem.style.stroke = '#d00';
elem.style.color = '#d00';
});
}

Expand Down
Loading