PainterBase.ts 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. import { GradientObject } from './graphic/Gradient';
  2. import { PatternObject } from './graphic/Pattern';
  3. import { Dictionary } from './core/types';
  4. // interface PainterOption {
  5. // width?: number | string // Can be 10 / 10px / auto
  6. // height?: number | string
  7. // }
  8. export interface PainterBase {
  9. type: string
  10. // root will be undefined if ssr is true
  11. root?: HTMLElement
  12. // If ssr only
  13. ssrOnly?: boolean
  14. // constructor(dom: HTMLElement, storage: Storage, opts: PainterOption, id: number): void
  15. resize(width?: number | string, height?: number | string): void
  16. refresh(): void
  17. clear(): void
  18. // must be given if ssr is true.
  19. renderToString?(): string;
  20. getType: () => string
  21. getWidth(): number
  22. getHeight(): number
  23. dispose(): void
  24. getViewportRoot: () => HTMLElement
  25. getViewportRootOffset: () => {offsetLeft: number, offsetTop: number}
  26. refreshHover(): void
  27. configLayer(zlevel: number, config: Dictionary<any>): void
  28. setBackgroundColor(backgroundColor: string | GradientObject | PatternObject): void
  29. }