index.d.ts 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. import { Adaptor } from '../core/adaptor';
  2. import { PickOptions, Plot } from '../core/plot';
  3. /**
  4. * 给 G2Plot 提供非常简单的开放开发的机制。目的是能够让社区和业务上自己基于 G2Plot 开发自己的定制图表库。主要分成几类图表:
  5. * 1. 领域专业的图表,内部同学因为没有场景,不一定能做的完善。
  6. * 2. 定制业务的图表,不具备通用性
  7. * 3. 趣味性的可视化组件
  8. * 然后官方可以根据社区的情况,可以进行一些官方推荐和采纳。
  9. *
  10. * 如果使用?
  11. *
  12. * ```ts
  13. * import { P } from '@antv/g2plot';
  14. * import { GeoWorldMap, GeoWorldMapOptions } from 'g2plot-geo-world-map';
  15. *
  16. * const plot = new P('container', {
  17. * geoJson: '',
  18. * longitude: '',
  19. * latitude: '',
  20. * }, GeoWorldMap, defaultOptions);
  21. *
  22. * plot.render();
  23. * ```
  24. */
  25. export declare class P<O extends PickOptions> extends Plot<O> {
  26. /** 统一为 any plot */
  27. readonly type = "g2-plot";
  28. /** 外部传入的 defaultOptions */
  29. private defaultOptions;
  30. /** 外部传入的 adaptor 函数 */
  31. private adaptor;
  32. /**
  33. * 相比普通图表增加 adaptor 参数。
  34. * @param container
  35. * @param options
  36. * @param adaptor
  37. * @param defaultOptions
  38. */
  39. constructor(container: string | HTMLElement, options: O, adaptor: Adaptor<O>, defaultOptions?: Partial<O>);
  40. /**
  41. * 实现父类方法,直接使用传入的
  42. */
  43. protected getDefaultOptions(): Partial<O>;
  44. /**
  45. * 实现父类方法,直接使用传入的
  46. */
  47. protected getSchemaAdaptor(): Adaptor<O>;
  48. }