@vue-pdf-viewer/viewer 3.0.0-alpha.4 → 3.0.0-alpha.6

package/dist/types/composables/useAnnotationHighlight.d.ts

@@ -0,0 +1,389 @@
+import { AnnotationHighlight } from '@/utils/types';
+import { AnnotationLayer, DrawLayer, PageViewport, PDFDocumentProxy, PDFPageProxy } from 'pdfjs-dist';
+import { Ref } from 'vue';
+interface UseAnnotationHighlightProps {
+    page: Ref<PDFPageProxy>;
+    viewport: Ref<PageViewport>;
+    canvasLayer: Ref<HTMLElement>;
+    textLayer: Ref<HTMLDivElement>;
+    annotationLayer: Ref<AnnotationLayer>;
+    document: PDFDocumentProxy;
+}
+export declare const useAnnotationHighlight: (props: UseAnnotationHighlightProps) => {
+    drawLayer: Ref<{
+        pageIndex: any;
+        setParent: (parent: any) => void;
+        draw: (properties: any, isPathUpdatable?: boolean | undefined, hasClip?: boolean | undefined) => {
+            id: number;
+            clipPathId: string;
+        };
+        drawOutline: (properties: any, mustRemoveSelfIntersections: any) => number;
+        finalizeDraw: (id: any, properties: any) => void;
+        updateProperties: (elementOrId: any, properties: any) => void;
+        updateParent: (id: any, layer: any) => void;
+        remove: (id: any) => void;
+        destroy: () => void;
+    } | null, DrawLayer | {
+        pageIndex: any;
+        setParent: (parent: any) => void;
+        draw: (properties: any, isPathUpdatable?: boolean | undefined, hasClip?: boolean | undefined) => {
+            id: number;
+            clipPathId: string;
+        };
+        drawOutline: (properties: any, mustRemoveSelfIntersections: any) => number;
+        finalizeDraw: (id: any, properties: any) => void;
+        updateProperties: (elementOrId: any, properties: any) => void;
+        updateParent: (id: any, layer: any) => void;
+        remove: (id: any) => void;
+        destroy: () => void;
+    } | null>;
+    isPrepared: Ref<boolean, boolean>;
+    highlightAnnotations: Ref<{
+        hexColor: string;
+        drawLayerId: number;
+        outlineId: number;
+        pageIndex?: number | undefined;
+        annotationType: number;
+        color?: {
+            [x: number]: number;
+            readonly BYTES_PER_ELEMENT: number;
+            readonly buffer: {
+                readonly byteLength: number;
+                slice: (begin: number, end?: number | undefined) => ArrayBuffer;
+                readonly [Symbol.toStringTag]: string;
+            } | {
+                readonly byteLength: number;
+                slice: (begin: number, end?: number | undefined) => SharedArrayBuffer;
+                readonly [Symbol.species]: SharedArrayBuffer;
+                readonly [Symbol.toStringTag]: "SharedArrayBuffer";
+            };
+            readonly byteLength: number;
+            readonly byteOffset: number;
+            copyWithin: (target: number, start: number, end?: number | undefined) => Uint8ClampedArray;
+            every: (predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any) => boolean;
+            fill: (value: number, start?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            filter: (predicate: (value: number, index: number, array: Uint8ClampedArray) => any, thisArg?: any) => Uint8ClampedArray;
+            find: (predicate: (value: number, index: number, obj: Uint8ClampedArray) => boolean, thisArg?: any) => number | undefined;
+            findIndex: (predicate: (value: number, index: number, obj: Uint8ClampedArray) => boolean, thisArg?: any) => number;
+            forEach: (callbackfn: (value: number, index: number, array: Uint8ClampedArray) => void, thisArg?: any) => void;
+            indexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+            join: (separator?: string | undefined) => string;
+            lastIndexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+            readonly length: number;
+            map: (callbackfn: (value: number, index: number, array: Uint8ClampedArray) => number, thisArg?: any) => Uint8ClampedArray;
+            reduce: {
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number): number;
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number, initialValue: number): number;
+                <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => U, initialValue: U): U;
+            };
+            reduceRight: {
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number): number;
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number, initialValue: number): number;
+                <U_1>(callbackfn: (previousValue: U_1, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => U_1, initialValue: U_1): U_1;
+            };
+            reverse: () => Uint8ClampedArray;
+            set: (array: ArrayLike<number>, offset?: number | undefined) => void;
+            slice: (start?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            some: (predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any) => boolean;
+            sort: (compareFn?: ((a: number, b: number) => number) | undefined) => Uint8ClampedArray;
+            subarray: (begin?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            toLocaleString: () => string;
+            toString: () => string;
+            valueOf: () => Uint8ClampedArray;
+            entries: () => IterableIterator<[number, number]>;
+            keys: () => IterableIterator<number>;
+            values: () => IterableIterator<number>;
+            includes: (searchElement: number, fromIndex?: number | undefined) => boolean;
+            at: (index: number) => number | undefined;
+            [Symbol.iterator]: () => IterableIterator<number>;
+            readonly [Symbol.toStringTag]: "Uint8ClampedArray";
+        } | undefined;
+        dest: string | [number | {
+            gen: number;
+            num: number;
+        }, {
+            name: string;
+        }, ...any[]];
+        hasAppearance: boolean;
+        id: string;
+        rect: number[];
+        subtype: string;
+        borderStyle: {
+            dashArray: number[];
+            horizontalCornerRadius: number;
+            style: number;
+            verticalCornerRadius: number;
+            width: number;
+        };
+        hasPopup?: boolean | undefined;
+        contents?: string | undefined;
+        contentsObj?: {
+            dir: string;
+            str: string;
+        } | undefined;
+        modificationDate?: string | undefined;
+        quadPoints?: any[] | undefined;
+        title?: string | undefined;
+        titleObj?: {
+            dir: string;
+            str: string;
+        } | undefined;
+        parentId?: string | undefined;
+        parentType?: string | undefined;
+        file?: {
+            content: {
+                [x: number]: number;
+                readonly BYTES_PER_ELEMENT: number;
+                readonly buffer: {
+                    readonly byteLength: number;
+                    slice: (begin: number, end?: number | undefined) => ArrayBuffer;
+                    readonly [Symbol.toStringTag]: string;
+                } | {
+                    readonly byteLength: number;
+                    slice: (begin: number, end?: number | undefined) => SharedArrayBuffer;
+                    readonly [Symbol.species]: SharedArrayBuffer;
+                    readonly [Symbol.toStringTag]: "SharedArrayBuffer";
+                };
+                readonly byteLength: number;
+                readonly byteOffset: number;
+                copyWithin: (target: number, start: number, end?: number | undefined) => Uint8Array;
+                every: (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean;
+                fill: (value: number, start?: number | undefined, end?: number | undefined) => Uint8Array;
+                filter: (predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array;
+                find: (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | undefined;
+                findIndex: (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number;
+                forEach: (callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void;
+                indexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+                join: (separator?: string | undefined) => string;
+                lastIndexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+                readonly length: number;
+                map: (callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array;
+                reduce: {
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number): number;
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number): number;
+                    <U_2>(callbackfn: (previousValue: U_2, currentValue: number, currentIndex: number, array: Uint8Array) => U_2, initialValue: U_2): U_2;
+                };
+                reduceRight: {
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number): number;
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number): number;
+                    <U_3>(callbackfn: (previousValue: U_3, currentValue: number, currentIndex: number, array: Uint8Array) => U_3, initialValue: U_3): U_3;
+                };
+                reverse: () => Uint8Array;
+                set: (array: ArrayLike<number>, offset?: number | undefined) => void;
+                slice: (start?: number | undefined, end?: number | undefined) => Uint8Array;
+                some: (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean;
+                sort: (compareFn?: ((a: number, b: number) => number) | undefined) => Uint8Array;
+                subarray: (begin?: number | undefined, end?: number | undefined) => Uint8Array;
+                toLocaleString: () => string;
+                toString: () => string;
+                valueOf: () => Uint8Array;
+                entries: () => IterableIterator<[number, number]>;
+                keys: () => IterableIterator<number>;
+                values: () => IterableIterator<number>;
+                includes: (searchElement: number, fromIndex?: number | undefined) => boolean;
+                at: (index: number) => number | undefined;
+                [Symbol.iterator]: () => IterableIterator<number>;
+                readonly [Symbol.toStringTag]: "Uint8Array";
+            };
+            filename: string;
+        } | undefined;
+        inkLists?: {
+            x: number;
+            y: number;
+        }[][] | undefined;
+        lineCoordinates: number[];
+        action?: string | undefined;
+        unsafeUrl?: string | undefined;
+        url?: string | undefined;
+        newWindow?: boolean | undefined;
+        vertices?: {
+            x: number;
+            y: number;
+        }[] | undefined;
+        name?: string | undefined;
+        fieldType: string;
+        pushButton: boolean;
+        deleted?: boolean | undefined;
+        noView?: boolean | undefined;
+        noPrint?: boolean | undefined;
+    }[], AnnotationHighlight[] | {
+        hexColor: string;
+        drawLayerId: number;
+        outlineId: number;
+        pageIndex?: number | undefined;
+        annotationType: number;
+        color?: {
+            [x: number]: number;
+            readonly BYTES_PER_ELEMENT: number;
+            readonly buffer: {
+                readonly byteLength: number;
+                slice: (begin: number, end?: number | undefined) => ArrayBuffer;
+                readonly [Symbol.toStringTag]: string;
+            } | {
+                readonly byteLength: number;
+                slice: (begin: number, end?: number | undefined) => SharedArrayBuffer;
+                readonly [Symbol.species]: SharedArrayBuffer;
+                readonly [Symbol.toStringTag]: "SharedArrayBuffer";
+            };
+            readonly byteLength: number;
+            readonly byteOffset: number;
+            copyWithin: (target: number, start: number, end?: number | undefined) => Uint8ClampedArray;
+            every: (predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any) => boolean;
+            fill: (value: number, start?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            filter: (predicate: (value: number, index: number, array: Uint8ClampedArray) => any, thisArg?: any) => Uint8ClampedArray;
+            find: (predicate: (value: number, index: number, obj: Uint8ClampedArray) => boolean, thisArg?: any) => number | undefined;
+            findIndex: (predicate: (value: number, index: number, obj: Uint8ClampedArray) => boolean, thisArg?: any) => number;
+            forEach: (callbackfn: (value: number, index: number, array: Uint8ClampedArray) => void, thisArg?: any) => void;
+            indexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+            join: (separator?: string | undefined) => string;
+            lastIndexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+            readonly length: number;
+            map: (callbackfn: (value: number, index: number, array: Uint8ClampedArray) => number, thisArg?: any) => Uint8ClampedArray;
+            reduce: {
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number): number;
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number, initialValue: number): number;
+                <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => U, initialValue: U): U;
+            };
+            reduceRight: {
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number): number;
+                (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => number, initialValue: number): number;
+                <U_1>(callbackfn: (previousValue: U_1, currentValue: number, currentIndex: number, array: Uint8ClampedArray) => U_1, initialValue: U_1): U_1;
+            };
+            reverse: () => Uint8ClampedArray;
+            set: (array: ArrayLike<number>, offset?: number | undefined) => void;
+            slice: (start?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            some: (predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any) => boolean;
+            sort: (compareFn?: ((a: number, b: number) => number) | undefined) => Uint8ClampedArray;
+            subarray: (begin?: number | undefined, end?: number | undefined) => Uint8ClampedArray;
+            toLocaleString: () => string;
+            toString: () => string;
+            valueOf: () => Uint8ClampedArray;
+            entries: () => IterableIterator<[number, number]>;
+            keys: () => IterableIterator<number>;
+            values: () => IterableIterator<number>;
+            includes: (searchElement: number, fromIndex?: number | undefined) => boolean;
+            at: (index: number) => number | undefined;
+            [Symbol.iterator]: () => IterableIterator<number>;
+            readonly [Symbol.toStringTag]: "Uint8ClampedArray";
+        } | undefined;
+        dest: string | [number | {
+            gen: number;
+            num: number;
+        }, {
+            name: string;
+        }, ...any[]];
+        hasAppearance: boolean;
+        id: string;
+        rect: number[];
+        subtype: string;
+        borderStyle: {
+            dashArray: number[];
+            horizontalCornerRadius: number;
+            style: number;
+            verticalCornerRadius: number;
+            width: number;
+        };
+        hasPopup?: boolean | undefined;
+        contents?: string | undefined;
+        contentsObj?: {
+            dir: string;
+            str: string;
+        } | undefined;
+        modificationDate?: string | undefined;
+        quadPoints?: any[] | undefined;
+        title?: string | undefined;
+        titleObj?: {
+            dir: string;
+            str: string;
+        } | undefined;
+        parentId?: string | undefined;
+        parentType?: string | undefined;
+        file?: {
+            content: {
+                [x: number]: number;
+                readonly BYTES_PER_ELEMENT: number;
+                readonly buffer: {
+                    readonly byteLength: number;
+                    slice: (begin: number, end?: number | undefined) => ArrayBuffer;
+                    readonly [Symbol.toStringTag]: string;
+                } | {
+                    readonly byteLength: number;
+                    slice: (begin: number, end?: number | undefined) => SharedArrayBuffer;
+                    readonly [Symbol.species]: SharedArrayBuffer;
+                    readonly [Symbol.toStringTag]: "SharedArrayBuffer";
+                };
+                readonly byteLength: number;
+                readonly byteOffset: number;
+                copyWithin: (target: number, start: number, end?: number | undefined) => Uint8Array;
+                every: (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean;
+                fill: (value: number, start?: number | undefined, end?: number | undefined) => Uint8Array;
+                filter: (predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array;
+                find: (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | undefined;
+                findIndex: (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number;
+                forEach: (callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void;
+                indexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+                join: (separator?: string | undefined) => string;
+                lastIndexOf: (searchElement: number, fromIndex?: number | undefined) => number;
+                readonly length: number;
+                map: (callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array;
+                reduce: {
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number): number;
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number): number;
+                    <U_2>(callbackfn: (previousValue: U_2, currentValue: number, currentIndex: number, array: Uint8Array) => U_2, initialValue: U_2): U_2;
+                };
+                reduceRight: {
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number): number;
+                    (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number): number;
+                    <U_3>(callbackfn: (previousValue: U_3, currentValue: number, currentIndex: number, array: Uint8Array) => U_3, initialValue: U_3): U_3;
+                };
+                reverse: () => Uint8Array;
+                set: (array: ArrayLike<number>, offset?: number | undefined) => void;
+                slice: (start?: number | undefined, end?: number | undefined) => Uint8Array;
+                some: (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean;
+                sort: (compareFn?: ((a: number, b: number) => number) | undefined) => Uint8Array;
+                subarray: (begin?: number | undefined, end?: number | undefined) => Uint8Array;
+                toLocaleString: () => string;
+                toString: () => string;
+                valueOf: () => Uint8Array;
+                entries: () => IterableIterator<[number, number]>;
+                keys: () => IterableIterator<number>;
+                values: () => IterableIterator<number>;
+                includes: (searchElement: number, fromIndex?: number | undefined) => boolean;
+                at: (index: number) => number | undefined;
+                [Symbol.iterator]: () => IterableIterator<number>;
+                readonly [Symbol.toStringTag]: "Uint8Array";
+            };
+            filename: string;
+        } | undefined;
+        inkLists?: {
+            x: number;
+            y: number;
+        }[][] | undefined;
+        lineCoordinates: number[];
+        action?: string | undefined;
+        unsafeUrl?: string | undefined;
+        url?: string | undefined;
+        newWindow?: boolean | undefined;
+        vertices?: {
+            x: number;
+            y: number;
+        }[] | undefined;
+        name?: string | undefined;
+        fieldType: string;
+        pushButton: boolean;
+        deleted?: boolean | undefined;
+        noView?: boolean | undefined;
+        noPrint?: boolean | undefined;
+    }[]>;
+    highlightElements: Ref<Map<string, HTMLElement> & Omit<Map<string, HTMLElement>, keyof Map<any, any>>, Map<string, HTMLElement> | (Map<string, HTMLElement> & Omit<Map<string, HTMLElement>, keyof Map<any, any>>)>;
+    highlightElementClickOpens: import("vue").Reactive<Map<string, boolean>>;
+    highlightCanvasInfos: import("vue").Reactive<Map<string, {
+        clipPathUrl: string;
+        outlineId: number;
+        drawLayerId: number;
+    }>>;
+    handleHighlightClick: (annotation: AnnotationHighlight) => void;
+    onSelectedHighlightColorUpdate: (color: string, annotation: AnnotationHighlight) => void;
+    handleHighlightRemove: (annotation: AnnotationHighlight) => void;
+};
+export {};