draw-poster.d.ts 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. import { Canvas, DrawPosterCanvasCtx, CreateImagePathOptions, DrawPosterBuildOpts, DrawPosterUseOpts, drawPosterExtends, DrawPosterUseCtxOpts } from "./utils/interface";
  2. declare type DrawPosterInstanceType = InstanceType<typeof DrawPoster> & drawPosterExtends;
  3. declare class DrawPoster {
  4. canvas: Canvas;
  5. ctx: DrawPosterCanvasCtx;
  6. canvasId: string;
  7. loading: boolean;
  8. debugging: boolean;
  9. loadingText: string;
  10. createText: string;
  11. [key: string]: any;
  12. private executeOnions;
  13. private stopStatus;
  14. private drawType;
  15. /** 构建器, 构建返回当前实例, 并挂载多个方法 */
  16. constructor(canvas: Canvas, ctx: DrawPosterCanvasCtx, canvasId: string, loading: boolean, debugging: boolean, loadingText: string, createText: string, tips: boolean);
  17. /** 提示器, 传入消息与数据 */
  18. private debuggingLog;
  19. /** 传入挂载配置对象, 添加扩展方法 */
  20. static use: (opts: DrawPosterUseOpts) => void;
  21. /** 传入挂载配置对象, 添加绘画扩展方法 */
  22. static useCtx: (opts: DrawPosterUseCtxOpts) => void;
  23. /** 构建绘制海报矩形方法, 传入canvas选择器或配置对象, 返回绘制对象 */
  24. static build: (options: string | DrawPosterBuildOpts, tips?: boolean) => Promise<DrawPosterInstanceType>;
  25. /** 构建多个绘制海报矩形方法, 传入选择器或配置对象的数组, 返回多个绘制对象 */
  26. static buildAll: (optionsAll: (string | DrawPosterBuildOpts)[]) => Promise<{
  27. [key: string]: DrawPosterInstanceType;
  28. }>;
  29. /** 绘制器, 接收执行器函数, 添加到绘制容器中 */
  30. draw: (execute: (ctx: DrawPosterCanvasCtx) => Promise<any> | void) => void;
  31. /** 等待创建绘画, 成功后清空绘制器容器 */
  32. awaitCreate: () => Promise<boolean[]>;
  33. /** 创建canvas本地地址 @returns {string} 本地地址 */
  34. createImagePath: (baseOptions?: CreateImagePathOptions) => Promise<string>;
  35. /** 停止当前绘画, 调用则停止当前绘画堆栈的绘画 */
  36. stop: () => void;
  37. }
  38. export default DrawPoster;