highcharts
Version:
JavaScript charting framework
71 lines (70 loc) • 2.22 kB
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" {
/**
* Formatter callback function.
*
* @param this
* Data label context to format
*
* @return Formatted data label text
*/
type PlotPackedBubbleDataLabelsFormatterCallbackFunction = (this: (DataLabelsFormatterContextObject|PlotPackedBubbleDataLabelsFormatterContextObject)) => string;
/**
* Context for the formatter function.
*/
interface PlotPackedBubbleDataLabelsFormatterContextObject extends DataLabelsFormatterContextObject {
/**
* The color of the node.
*/
color: ColorString;
/**
* The ID of the node.
*/
key: string;
/**
* Callback to format data labels for _parentNodes_. The
* `parentNodeFormat` option takes precedence over the
* `parentNodeFormatter`.
*/
parentNodeFormatter: FormatterCallbackFunction<DataLabelsFormatterContextObject>;
/**
* Options for a _parentNode_ label text.
*/
parentNodeTextPath: PlotPackedBubbleDataLabelsTextPath;
/**
* The point (node) object. The node name, if defined, is available
* through `this.point.name`. Arrays: `this.point.linksFrom` and
* `this.point.linksTo` contains all nodes connected to this point.
*/
point: Point;
}
/**
* **Note:** Only SVG-based renderer supports this option.
*/
interface PlotPackedBubbleDataLabelsTextPath {
/**
* Presentation attributes for the text path.
*/
attributes: SVGAttributes;
/**
* Enable or disable `textPath` option for link's or marker's data
* labels.
*/
enabled?: boolean;
}
}
export default factory;
export let Highcharts: typeof _Highcharts;