gantt.src.d.ts 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. /*!*
  2. *
  3. * Copyright (c) Highsoft AS. All rights reserved.
  4. *
  5. *!*/
  6. import * as globals from "../globals.src";
  7. import * as _Highcharts from "../highcharts.src";
  8. /**
  9. * Adds the module to the imported Highcharts namespace.
  10. *
  11. * @param highcharts
  12. * The imported Highcharts namespace to extend.
  13. */
  14. export function factory(highcharts: typeof Highcharts): void;
  15. declare module "../highcharts.src" {
  16. interface Point {
  17. /**
  18. * The ending X value of the range point.
  19. */
  20. x2?: number;
  21. }
  22. interface PointOptionsObject {
  23. /**
  24. * The ending X value of the range point.
  25. */
  26. x2?: number;
  27. }
  28. /**
  29. * Factory function for Gantt charts.
  30. *
  31. * @param renderTo
  32. * The DOM element to render to, or its id.
  33. *
  34. * @param options
  35. * The chart options structure.
  36. *
  37. * @param callback
  38. * Function to run when the chart has loaded and and all external
  39. * images are loaded. Defining a chart.events.load handler is
  40. * equivalent.
  41. *
  42. * @return Returns the Chart object.
  43. */
  44. function ganttChart(renderTo: (string|HTMLDOMElement), options: Options, callback?: ChartCallbackFunction): Chart;
  45. /**
  46. * When we have vertical scrollbar, rifles and arrow in buttons should be
  47. * rotated. The same method is used in Navigator's handles, to rotate them.
  48. *
  49. * @param path
  50. * Path to be rotated.
  51. *
  52. * @param vertical
  53. * If vertical scrollbar, swap x-y values.
  54. *
  55. * @return Rotated path.
  56. */
  57. function swapXY(path: SVGPathArray, vertical?: boolean): SVGPathArray;
  58. }
  59. export default factory;
  60. export let Highcharts: typeof _Highcharts;