mirror of
https://github.com/mozilla/pdf.js.git
synced 2026-02-08 00:21:11 +01:00
346afd1e1c
*The [api-minor] label probably ought to have been added to the original PR, given the changes to the `createAnnotationLayerBuilder` signature (if nothing else).*
This patch fixes the following things:
- Let the `AnnotationLayer.render` method create an `AnnotationStorage`-instance if none was provided, thus making the parameter *properly* optional. This not only fixes the reference tests, it also prevents issues when the viewer components are used.
- Stop exporting `AnnotationStorage` in the official API, i.e. the `src/pdf.js` file, since it's no longer necessary given the change above. Generally speaking, unless absolutely necessary we probably shouldn't export unused things in the API.
- Fix a number of JSDocs `typedef`s, in `src/display/` and `web/` code, to actually account for the new `annotationStorage` parameter.
- Update `web/interfaces.js` to account for the changes in `createAnnotationLayerBuilder`.
- Initialize the storage, in `AnnotationStorage`, using `Object.create(null)` rather than `{}` (which is the PDF.js default).
58 lines
1.4 KiB
JavaScript
58 lines
1.4 KiB
JavaScript
/* Copyright 2020 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
class AnnotationStorage {
|
|
constructor() {
|
|
this._storage = Object.create(null);
|
|
}
|
|
|
|
/**
|
|
* Get the value for a given key if it exists
|
|
* or store and return the default value
|
|
*
|
|
* @public
|
|
* @memberof AnnotationStorage
|
|
* @param {string} key
|
|
* @param {Object} defaultValue
|
|
* @returns {Object}
|
|
*/
|
|
getOrCreateValue(key, defaultValue) {
|
|
if (key in this._storage) {
|
|
return this._storage[key];
|
|
}
|
|
|
|
this._storage[key] = defaultValue;
|
|
return defaultValue;
|
|
}
|
|
|
|
/**
|
|
* Set the value for a given key
|
|
*
|
|
* @public
|
|
* @memberof AnnotationStorage
|
|
* @param {string} key
|
|
* @param {Object} value
|
|
*/
|
|
setValue(key, value) {
|
|
this._storage[key] = value;
|
|
}
|
|
|
|
getAll() {
|
|
return this._storage;
|
|
}
|
|
}
|
|
|
|
export { AnnotationStorage };
|