@sv-print/hiprint 0.2.22 → 0.2.24

package/dist/index.d.ts

@@ -1,31 +1,186 @@
 export declare function autoConnect(callback?: (status?: boolean, msg?: any) => void);
 
+export declare interface ConfigOptions extends Record<string, any> {
+    optionItems?: any[];
+    movingDistance?: number; //鼠标拖动一次移动的距离,默认1.5pt
+    paperHeightTrim?: number; //纸张html 的高度等于真实高度-1
+    showPosition?: boolean; //显示坐标位置
+    positionLineMode?: boolean; //坐标显示在线上的
+    positionUnit?: boolean; //显示坐标单位
+    showSizeBox?: boolean; //显示宽高box
+    adsorbMin?: number; //吸附最小距离pt
+    showAdsorbLine?: boolean; //显示吸附线
+    adsorbLineMin?: number; //吸附线显示最小距离pt
+    paperNumberContinue?: boolean; //页码续排
+    disableNoDraggableSize?: boolean; //锁定元素不可修改宽高大小
+}
+
 export declare class defaultElementTypeProvider {
     constructor();
 }
 
 export declare function disAutoConnect();
 
+export declare interface FieldJson {
+    field: string;
+    text: string;
+}
+
+export declare interface FontJson {
+    title: string;
+    value: string;
+}
+
+export declare type Hiprint = hiprint;
+
 export declare class hiprint {
-    static init: (...args: any) => void;
-    static register: (...args: any) => string;
-    static setConfig: (...args: any) => void;
-    static updateElementType: (...args: any) => void;
-    static hiwebSocket: any;
-    static refreshPrinterList: (...args: any) => void;
-    static getAddress: (...args: any) => void;
+    static init: (options: InitOptions) => void;
+    static register: (options: RegisterOptions) => string;
+    static setConfig: (options: ConfigOptions) => void;
+    static getOptionItems: Record<string, any>;
+    static updateElementType: <T>(tid: string, callback: (type: T) => T) => void;
+    static hiwebSocket: HiWebSocket;
+    static refreshPrinterList: (callback: (printerList: PrinterInfo[]) => void) => void;
+    static getAddress: (type: string, callback: (addr: Record<string, any>, e: any) => void) => void;
     static ippPrint: (...args: any) => void;
     static ippRequest: (...args: any) => void;
-    static PrintElementTypeManager: any;
-    static PrintElementTypeGroup: any;
-    static PrintTemplate: PrintTemplate;
-    static print: (...args: any) => any;
-    static print2: (...args: any) => any;
-    static getHtml: (...args: any) => any;
+    static PrintElementTypeManager: PrintElementTypeManager;
+    static PrintElementTypeGroup: PrintElementTypeGroup;
+    static PrintTemplate: typeof PrintTemplate;
+    static print: (data: Templates) => void;
+    static print2: (data: Templates, printSuccess: (e: any) => void, printError: (e: any) => void) => void;
+    static getHtml: (data: Templates) => any;
+}
+
+export declare interface HiWebSocket {
+    opened: boolean;
+    host: string;
+    setHost: (host: string, token: string, callback: (connect: boolean, e: any) => void) => void;
+    start: (callback: (connect: boolean, e: any) => void) => void;
+    stop: () => void;
+}
+
+export declare interface InitOptions extends Record<string, any> {
+    providers?: any[];
+    token?: string;
+}
+
+export declare interface PanelJson {
+    index?: number;
+    name?: string;
+    paperType?: string;
+    height?: number;
+    width?: number;
+    paperHeader?: number;
+    paperFooter?: number;
+    printElements?: any[];
+    paperNumberLeft?: number;
+    paperNumberTop?: number;
+    paperNumberDisabled?: boolean;
+    paperNumberContinue?: boolean;
+    paperNumberFormat?: string;
+    panelPageRule?: string;
+    orient?: 1 | 2;
+    overPrintOptions?: {
+        content?: string;
+        opacity?: 0.7;
+        type?: 1 | 2;
+    };
+    watermarkOptions?: {
+        content?: string;
+        fillStyle?: string;
+        fontSize?: string;
+        rotate?: boolean;
+        width?: number;
+        height?: number;
+        timestamp?: boolean;
+        format?: string;
+    };
+    panelLayoutOptions?: {
+        layoutType?: "column" | "row";
+        layoutRowGap?: number;
+        layoutColumnGap?: number;
+    };
+}
+
+export declare interface PaperJson {
+    type: string;
+    width: number;
+    height: number;
+}
+
+export declare interface Print2Options extends Record<string, any> {
+    styleHandler?: () => string;
+    printer?: string;
+    silent?: boolean;
+    printBackground?: boolean;
+    color?: boolean;
+    copies?: number;
+    landscape?: boolean;
+    pageSize?:
+    | string
+    | {
+        height: number;
+        width: number;
+    };
+    scaleFactor?: number;
+    pagesPerSheet?: number;
+    collate?: boolean;
+    pageRanges?: {
+        from: number;
+        to: number;
+    }[];
+    duplexMode?: "simplex" | "shortEdge" | "longEdge";
+    dpi?: Record<string, number>;
+    margins?: {
+        /**
+         * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
+         * you will also need to specify `top`, `bottom`, `left`, and `right`.
+         */
+        marginType?: "default" | "none" | "printableArea" | "custom";
+        /**
+         * The top margin of the printed web page, in pixels.
+         */
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    };
+    header?: string;
+    footer?: string;
+}
+
+export declare type PrintData = Record<string, any> | Record<string, any>[];
+
+export declare interface PrintElementType extends Record<string, any> {
+    tid: string;
+    type: string;
+    title: string;
+    data?: any;
+    field?: any;
+    options?: Record<string, any>;
+}
+
+export declare interface PrintElementTypeGroup {
+    constructor(name: string, list: PrintElementType[]);
+}
+
+export declare interface PrintElementTypeManager {
+    buildByHtml(el: any): void;
+    build(el: any, type: string, render: (list: any) => any): void;
 }
 
-export declare interface PrintTemplate {
-    constructor(options?: any);
+export declare interface PrinterInfo {
+    name: string; // 打印机名称
+    displayName: string; // 显示名称
+    description: string; // 描述
+    isDefault: boolean; // 是否为默认打印机
+    status: number; // 状态码
+    options: Record<string, any>; // 打印机选项
+}
+
+export declare class PrintTemplate {
+    constructor(options: PrintTemplateOptions);
     id: string;
     history: boolean;
     historyPos: number;
@@ -33,40 +188,114 @@ export declare interface PrintTemplate {
     container: any;
     editingPanel: Array<any>;
     printPanels: Array<any>;
-    design: (...args: any) => any;
+    design: (container: string, { grid: boolean }) => any;
     buildPagination: (container: string) => void;
-    update: (...args: any) => any;
-    print: (...args: any) => any;
-    print2: (...args: any) => any;
-    getHtml: (...args: any) => any;
-    clear: () => any;
-    rotatePaper: () => any;
-    setPaper: () => any;
-    getOrient: () => any;
-    zoom: (...args: any) => any;
+    update: (json: PrintTemplateJson, panelIndex: number, history: boolean) => any;
+    print: (
+    data: PrintData,
+    options?: { leftOffset?: number; topOffset?: number },
+    ext?: {
+        callback?: () => void;
+        styleHandler?: () => string;
+    }
+    ) => void;
+    print2: (data: PrintData, options?: Print2Options) => void;
+    getHtml: (data: PrintData) => any;
+    toPdf: (data: PrintData, optoins?: ToPdfOptions) => any;
+    toImage: (data: PrintData, optoins?: ToImageOptions) => any;
+    clear: () => void;
+    rotatePaper: () => void;
+    setPaper: (width: number, height: number) => void;
+    getOrient: () => number;
+    zoom: (scale: number) => void;
     undo: () => any;
     redo: () => any;
-    getPrintStyle: () => any;
-    getPaperType: () => any;
-    copyJson: () => any;
-    cutJson: () => any;
+    getPrintStyle: () => string;
+    getPaperType: () => string;
+    copyJson: () => void;
+    cutJson: () => void;
     canPaste: () => boolean;
-    getSelectEls: (...args: any) => any;
-    updateOption: (...args: any) => any;
-    setElsAlign: (align: string, toPaper?: boolean) => any;
-    setElsSpace: (...args: any) => any;
+    getSelectEls: () => any[];
+    updateOption: (key: string, val: any) => void;
+    setElsAlign: (align: string, toPaper?: boolean) => void;
+    setElsSpace: (dis: number, isHor: boolean) => void;
     selectAllEls: (reverse?: boolean) => any;
     addPrintElementToPaperByTid: (tid: string, left?: number, top?: number) => any;
-    getJson: (...args: any) => any;
-    getJsonTid: (...args: any) => any;
-    getPrinterList: (...args: any) => any;
+    getJson: () => PrintTemplateJson;
+    getJsonTid: () => PrintTemplateJson;
+    getPrinterList: () => PrinterInfo[];
+    getFieldsInPanel: () => any[];
+    getTestData: () => PrintData;
     on: (...args: any) => any;
-    setFields: (...args: any) => any;
-    setFontList: (...args: any) => any;
-    setPaperList: (...args: any) => any;
-    setOnImageChooseClick: (...args: any) => any;
-    onDataChanged: (...args: any) => any;
+    setFields: (fields: FieldJson[]) => void;
+    setFontList: (fontList: FontJson[]) => void;
+    setPaperList: (paperList: PaperJson[]) => void;
+    setOnImageChooseClick: (callback: (target: HTMLElement) => void) => void;
+    setCustomDataFun: (fun: (data: any, field: string, printData: PrintData) => any) => void;
+    onDataChanged: (type: string, json: PrintTemplateJson) => void;
     onZoomChange: (zoom: number) => void;
 }
 
+export declare interface PrintTemplateJson {
+    panels?: PanelJson[];
+}
+
+export declare interface PrintTemplateOptions extends Record<string, any> {
+    template?: PrintTemplateJson | Record<string, any>;
+    settingContainer?: string;
+    paginationContainer?: string;
+    fields?: FieldJson[];
+    fontList?: FontJson[];
+    paperList?: PaperJson[];
+    history?: boolean;
+    dataMode?: 1 | 2;
+    onDataChanged?: (type: string, data: PrintData) => void;
+    onUpdateError?: (e: any) => void;
+    onImageChooseClick?: (target: HTMLElement) => void;
+    onPanelAddClick?: (panel: any, createPanel: any) => void;
+    onFunctionClick?: (option: any, printElement: any, event: any) => void;
+    onZoomChange?: (scale: number) => void;
+    customDataFun?: (ele: any, data: any, field: string, printData: PrintData) => any;
+    beforeDragIn?: (printTemplate: any, panel: any, ele: any) => boolean;
+}
+
+export declare interface RegisterOptions extends Record<string, any> {
+    authKey?: String;
+    plugins?: any[];
+}
+
+export declare interface Templates {
+    templates: {
+        templates: PrintTemplate;
+        data: PrintData;
+        options?: Record<string, any>;
+    }[];
+    options?: Print2Options;
+}
+
+export declare interface ToImageOptions {
+    isDownload?: boolean;
+    name?: string;
+    leftOffset?: number;
+    topOffset?: number;
+    onProgress?: (cur: number, total: number) => void;
+    limit?: number;
+    quality?: number;
+    pixelRatio?: number;
+    type?: string;
+    toType?: "url" | "blob" | string;
+}
+
+export declare interface ToPdfOptions {
+    isDownload?: boolean;
+    name?: string;
+    leftOffset?: number;
+    topOffset?: number;
+    onProgress?: (cur: number, total: number) => void;
+    limit?: number;
+    quality?: number;
+    pixelRatio?: number;
+    type?: string;
+}
+
 export { }