Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Properly ignore PopupAnnotations with custom trigger-elements

Browse Source 
A number of Annotation-types are currently creating their own PopupAnnotations, since they need to use a custom `trigger`-element. However, because of where that check is currently implemented[1] we end up attaching empty/unused containers for those PopupAnnotations to the DOM[2]; see e.g. the `annotation-line.pdf` file in the test-suite for one example.

By instead moving the types-check into the `PopupAnnotationElement` constructor, we can completely skip those PopupAnnotations that are being explicitly handled elsewhere.
Note that I don't *believe* that this is a new issue, although I've not tried to bisect it, but this likely goes back quite some time (possibly even as far as PR 8228).

---
[1] In the `PopupAnnotationElement.render` method.

[2] Please note that the actual Popup-element *itself* isn't being attached/rendered here, just its container which by itself serves no purpose as far as I can tell.
This commit is contained in:
Jonas Jenwald 2022-08-29 16:12:20 +02:00
parent 86370bd5c5
commit 0ecf6458ee
1 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/display/annotation_layer.js
View File

@ -1736,35 +1736,31 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
} }
class PopupAnnotationElement extends AnnotationElement { class PopupAnnotationElement extends AnnotationElement {
constructor(parameters) {
const isRenderable = !!(
parameters.data.titleObj?.str ||
parameters.data.contentsObj?.str ||
parameters.data.richText?.str
);
super(parameters, { isRenderable });
}
render() {
// Do not render popup annotations for parent elements with these types as // Do not render popup annotations for parent elements with these types as
// they create the popups themselves (because of custom trigger divs). // they create the popups themselves (because of custom trigger divs).
const IGNORE_TYPES = [ static IGNORE_TYPES = new Set([
"Line", "Line",
"Square", "Square",
"Circle", "Circle",
"PolyLine", "PolyLine",
"Polygon", "Polygon",
"Ink", "Ink",
]; ]);
this.container.className = "popupAnnotation"; constructor(parameters) {
const { data } = parameters;
if (IGNORE_TYPES.includes(this.data.parentType)) { const isRenderable =
return this.container; !PopupAnnotationElement.IGNORE_TYPES.has(data.parentType) &&
!!(data.titleObj?.str || data.contentsObj?.str || data.richText?.str);
super(parameters, { isRenderable });
} }
const selector = `[data-annotation-id="${this.data.parentId}"]`; render() {
const parentElements = this.layer.querySelectorAll(selector); this.container.className = "popupAnnotation";
const parentElements = this.layer.querySelectorAll(
`[data-annotation-id="${this.data.parentId}"]`
);
if (parentElements.length === 0) { if (parentElements.length === 0) {
return this.container; return this.container;
} }