697b99bc2d620ccfebf85fe859e2686fce125716a1155996fc8e9a71ea3a0e26633e25eb34d894566cb5743971f1e627ad272066d77b987af304569d87fd35 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. import ComponentModel from '../../model/Component.js';
  2. import { ComponentOption, LabelOption, LineStyleOption, CommonTooltipOption, TooltipRenderMode, CallbackDataParams, TooltipOrderMode } from '../../util/types.js';
  3. import { AxisPointerOption } from '../axisPointer/AxisPointerModel.js';
  4. export declare type TopLevelFormatterParams = CallbackDataParams | CallbackDataParams[];
  5. export interface TooltipOption extends CommonTooltipOption<TopLevelFormatterParams>, ComponentOption {
  6. mainType?: 'tooltip';
  7. axisPointer?: AxisPointerOption & {
  8. axis?: 'auto' | 'x' | 'y' | 'angle' | 'radius';
  9. crossStyle?: LineStyleOption & {
  10. textStyle?: LabelOption;
  11. };
  12. };
  13. /**
  14. * If show popup content
  15. */
  16. showContent?: boolean;
  17. /**
  18. * Trigger only works on coordinate system.
  19. */
  20. trigger?: 'item' | 'axis' | 'none';
  21. displayMode?: 'single' | 'multipleByCoordSys';
  22. /**
  23. * 'auto': use html by default, and use non-html if `document` is not defined
  24. * 'html': use html for tooltip
  25. * 'richText': use canvas, svg, and etc. for tooltip
  26. */
  27. renderMode?: 'auto' | TooltipRenderMode;
  28. /**
  29. * If append popup dom to document.body
  30. * Only available when renderMode is html
  31. */
  32. appendToBody?: boolean;
  33. /**
  34. * specified class name of tooltip dom
  35. * Only available when renderMode is html
  36. */
  37. className?: string;
  38. order?: TooltipOrderMode;
  39. }
  40. declare class TooltipModel extends ComponentModel<TooltipOption> {
  41. static type: "tooltip";
  42. type: "tooltip";
  43. static dependencies: string[];
  44. static defaultOption: TooltipOption;
  45. }
  46. export default TooltipModel;