zrender.d.ts 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. /*!
  2. * ZRender, a high performance 2d drawing library.
  3. *
  4. * Copyright (c) 2013, Baidu Inc.
  5. * All rights reserved.
  6. *
  7. * LICENSE
  8. * https://github.com/ecomfe/zrender/blob/master/LICENSE.txt
  9. */
  10. import Handler from './Handler';
  11. import Storage from './Storage';
  12. import { PainterBase } from './PainterBase';
  13. import Animation from './animation/Animation';
  14. import Element, { ElementEventCallback } from './Element';
  15. import { ElementEventName, WithThisType } from './core/types';
  16. import { LayerConfig } from './canvas/Layer';
  17. import { GradientObject } from './graphic/Gradient';
  18. import { PatternObject } from './graphic/Pattern';
  19. import { EventCallback } from './core/Eventful';
  20. import TSpan from './graphic/TSpan';
  21. import ZRImage from './graphic/Image';
  22. import Displayable from './graphic/Displayable';
  23. import Path from './graphic/Path';
  24. declare type PainterBaseCtor = {
  25. new (dom: HTMLElement, storage: Storage, ...args: any[]): PainterBase;
  26. };
  27. declare class ZRender {
  28. dom: HTMLElement;
  29. id: number;
  30. storage: Storage;
  31. painter: PainterBase;
  32. handler: Handler;
  33. animation: Animation;
  34. private _sleepAfterStill;
  35. private _stillFrameAccum;
  36. private _needsRefresh;
  37. private _needsRefreshHover;
  38. private _darkMode;
  39. private _backgroundColor;
  40. constructor(id: number, dom: HTMLElement, opts?: ZRenderInitOpt);
  41. add(el: Element): void;
  42. remove(el: Element): void;
  43. configLayer(zLevel: number, config: LayerConfig): void;
  44. setBackgroundColor(backgroundColor: string | GradientObject | PatternObject): void;
  45. getBackgroundColor(): string | GradientObject | PatternObject;
  46. setDarkMode(darkMode: boolean): void;
  47. isDarkMode(): boolean;
  48. refreshImmediately(fromInside?: boolean): void;
  49. refresh(): void;
  50. flush(): void;
  51. private _flush;
  52. setSleepAfterStill(stillFramesCount: number): void;
  53. wakeUp(): void;
  54. addHover(el: Displayable): void;
  55. removeHover(el: Path | TSpan | ZRImage): void;
  56. clearHover(): void;
  57. refreshHover(): void;
  58. refreshHoverImmediately(): void;
  59. resize(opts?: {
  60. width?: number | string;
  61. height?: number | string;
  62. }): void;
  63. clearAnimation(): void;
  64. getWidth(): number;
  65. getHeight(): number;
  66. pathToImage(e: Path, dpr: number): ZRImage;
  67. setCursorStyle(cursorStyle: string): void;
  68. findHover(x: number, y: number): {
  69. target: Displayable;
  70. topTarget: Displayable;
  71. };
  72. on<Ctx>(eventName: ElementEventName, eventHandler: ElementEventCallback<Ctx, ZRenderType>, context?: Ctx): this;
  73. on<Ctx>(eventName: string, eventHandler: WithThisType<EventCallback<any[]>, unknown extends Ctx ? ZRenderType : Ctx>, context?: Ctx): this;
  74. off(eventName?: string, eventHandler?: EventCallback): void;
  75. trigger(eventName: string, event?: unknown): void;
  76. clear(): void;
  77. dispose(): void;
  78. }
  79. export interface ZRenderInitOpt {
  80. renderer?: string;
  81. devicePixelRatio?: number;
  82. width?: number | string;
  83. height?: number | string;
  84. useDirtyRect?: boolean;
  85. }
  86. export declare function init(dom: HTMLElement, opts?: ZRenderInitOpt): ZRender;
  87. export declare function dispose(zr: ZRender): void;
  88. export declare function disposeAll(): void;
  89. export declare function getInstance(id: number): ZRender;
  90. export declare function registerPainter(name: string, Ctor: PainterBaseCtor): void;
  91. export declare const version = "5.2.1";
  92. export interface ZRenderType extends ZRender {
  93. }
  94. export {};