pdfjs-dist
Version:
Generic build of Mozilla's PDF.js library.
81 lines (80 loc) • 2.23 kB
TypeScript
/**
* Key/value storage for annotation data in forms.
*/
export class AnnotationStorage {
/**
* PLEASE NOTE: Only intended for usage within the API itself.
* @ignore
*/
static getHash(map: any): string;
_storage: Map<any, any>;
_modified: boolean;
onSetModified: any;
onResetModified: any;
/**
* Get the value for a given key if it exists, or return the default value.
*
* @public
* @memberof AnnotationStorage
* @param {string} key
* @param {Object} defaultValue
* @returns {Object}
*/
public getValue(key: string, defaultValue: Object): Object;
/**
* Get the value for a given key.
*
* @public
* @memberof AnnotationStorage
* @param {string} key
* @returns {Object}
*/
public getRawValue(key: string): Object;
/**
* Remove a value from the storage.
* @param {string} key
*/
removeKey(key: string): void;
/**
* Set the value for a given key
*
* @public
* @memberof AnnotationStorage
* @param {string} key
* @param {Object} value
*/
public setValue(key: string, value: Object): void;
/**
* Check if the storage contains the given key.
* @param {string} key
* @returns {boolean}
*/
has(key: string): boolean;
getAll(): any;
get size(): number;
resetModified(): void;
/**
* @returns {PrintAnnotationStorage}
*/
get print(): PrintAnnotationStorage;
/**
* PLEASE NOTE: Only intended for usage within the API itself.
* @ignore
*/
get serializable(): Map<any, any> | null;
#private;
}
/**
* A special `AnnotationStorage` for use during printing, where the serializable
* data is *frozen* upon initialization, to prevent scripting from modifying its
* contents. (Necessary since printing is triggered synchronously in browsers.)
*/
export class PrintAnnotationStorage extends AnnotationStorage {
constructor(parent: any);
/**
* PLEASE NOTE: Only intended for usage within the API itself.
* @ignore
*/
get serializable(): null;
#private;
}