64 lines
2.1 KiB
TypeScript
64 lines
2.1 KiB
TypeScript
|
/*!*
|
||
|
|
*
|
||
|
|
* Copyright (c) Highsoft AS. All rights reserved.
|
||
|
|
*
|
||
|
|
*!*/
|
||
|
|
import * as globals from "../globals.src";
|
||
|
|
import * as _Highcharts from "../highcharts.src";
|
||
|
|
/**
|
||
|
|
* Adds the module to the imported Highcharts namespace.
|
||
|
|
*
|
||
|
|
* @param highcharts
|
||
|
|
* The imported Highcharts namespace to extend.
|
||
|
|
*/
|
||
|
|
export function factory(highcharts: typeof Highcharts): void;
|
||
|
|
declare module "../highcharts.src" {
|
||
|
|
interface Chart {
|
||
|
|
/**
|
||
|
|
* Exporting and offline-exporting modules required. Export a chart to
|
||
|
|
* an image locally in the user's browser.
|
||
|
|
*
|
||
|
|
* @param exportingOptions
|
||
|
|
* Exporting options, the same as in
|
||
|
|
* Highcharts.Chart#exportChart.
|
||
|
|
*
|
||
|
|
* @param chartOptions
|
||
|
|
* Additional chart options for the exported chart. For example a
|
||
|
|
* different background color can be added here, or `dataLabels`
|
||
|
|
* for export only.
|
||
|
|
*/
|
||
|
|
exportChartLocal(exportingOptions?: ExportingOptions, chartOptions?: Options): void;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Get data URL to an image of an SVG and call download on it options
|
||
|
|
* object:
|
||
|
|
*
|
||
|
|
* - **filename:** Name of resulting downloaded file without extension.
|
||
|
|
* Default is `chart`.
|
||
|
|
*
|
||
|
|
* - **type:** File type of resulting download. Default is `image/png`.
|
||
|
|
*
|
||
|
|
* - **scale:** Scaling factor of downloaded image compared to source.
|
||
|
|
* Default is `1`.
|
||
|
|
*
|
||
|
|
* - **libURL:** URL pointing to location of dependency scripts to download
|
||
|
|
* on demand. Default is the exporting.libURL option of the global
|
||
|
|
* Highcharts options pointing to our server.
|
||
|
|
*
|
||
|
|
* @param svg
|
||
|
|
* The generated SVG
|
||
|
|
*
|
||
|
|
* @param options
|
||
|
|
* The exporting options
|
||
|
|
*
|
||
|
|
* @param failCallback
|
||
|
|
* The callback function in case of errors
|
||
|
|
*
|
||
|
|
* @param successCallback
|
||
|
|
* The callback function in case of success
|
||
|
|
*/
|
||
|
|
function downloadSVGLocal(svg: string, options: ExportingOptions, failCallback: Function, successCallback?: Function): void;
|
||
|
|
}
|
||
|
|
export default factory;
|
||
|
|
export let Highcharts: typeof _Highcharts;
|