highcharts

/*!* * * Copyright (c) Highsoft AS. All rights reserved. * *!*/ import * as Highcharts from "../highcharts.src"; declare module "../highcharts.src" { /** * (Highcharts, Highstock, Gantt) Styles for the series label. The color * defaults to the series color, or a contrast color if `onArea`. */ interface PlotWordcloudLabelStyleOptions { fontSize?: (number|string); } /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` and * `sunburst` series are supported at this moment. */ interface PlotWordcloudOnPointOptions { /** * (Highcharts) Options for the connector in the _Series on point_ * feature. * * In styled mode, the connector can be styled with the * `.highcharts-connector-seriesonpoint` class name. */ connectorOptions?: (Highcharts.PlotWordcloudOnPointConnectorOptions|Highcharts.SVGAttributes); /** * (Highcharts) The `id` of the point that we connect the series to. * Only points with a given `plotX` and `plotY` values and map points * are valid. */ id?: string; /** * (Highcharts) Options allowing to set a position and an offset of the * series in the _Series on point_ feature. */ position?: (object|Highcharts.PlotWordcloudOnPointPositionOptions); } /** * (Highcharts) A word cloud is a visualization of a set of words, where the * size and placement of a word is determined by how it is weighted. * * Configuration options for the series are given in three levels: * * 1. Options for all series in a chart are defined in the * plotOptions.series object. * * 2. Options for all `wordcloud` series are defined in * plotOptions.wordcloud. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) * * **TypeScript:** * * - the type option must always be set. * * - when accessing an array of series, the combined set of all series types * is represented by Highcharts.SeriesOptionsType . Narrowing down to the * specific type can be done by checking the `type` property. (see online * documentation for example) */ interface PlotWordcloudOptions { /** * (Highcharts) Accessibility options for a series. */ accessibility?: Highcharts.SeriesAccessibilityOptionsObject; /** * (Highcharts) Allow this series' points to be selected by clicking on * the graphic (columns, point markers, pie slices, map areas etc). * * The selected points can be handled by point select and unselect * events, or collectively by the getSelectedPoints function. * * And alternative way of selecting points is through dragging. */ allowPointSelect?: boolean; /** * (Highcharts) Enable or disable the initial animation when a series is * displayed. The animation can also be set as a configuration object. * Please note that this option only applies to the initial animation of * the series itself. For other animations, see chart.animation and the * animation parameter under the API methods. The following properties * are supported: * * - `defer`: The animation delay time in milliseconds. * * - `duration`: The duration of the animation in milliseconds. * (Defaults to `1000`) * * - `easing`: Can be a string reference to an easing function set on * the `Math` object or a function. See the _Custom easing function_ * demo below. (Defaults to `easeInOutSine`) * * Due to poor performance, animation is disabled in old IE browsers for * several chart types. */ animation?: (boolean|Highcharts.AnimationOptionsObject); /** * (Highcharts) For some series, there is a limit that shuts down * animation by default when the total number of points in the chart is * too high. For example, for a column chart and its derivatives, * animation does not run if there is more than 250 points totally. To * disable this cap, set `animationLimit` to `Infinity`. This option * works if animation is fired on individual points, not on a group of * points like e.g. during the initial animation. */ animationLimit?: number; /** * (Highcharts, Highstock, Gantt) The color of the border surrounding * each column or bar. * * In styled mode, the border stroke can be set with the * `.highcharts-point` rule. */ borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts, Highstock, Gantt) The corner radius of the border * surrounding each column or bar. A number signifies pixels. A * percentage string, like for example `50%`, signifies a relative size. * For columns this is relative to the column width, for pies it is * relative to the radius and the inner radius. */ borderRadius?: (number|string|Highcharts.BorderRadiusOptionsObject); /** * (Highcharts, Highstock, Gantt) The width of the border surrounding * each column or bar. Defaults to `1` when there is room for a border, * but to `0` when the columns are so dense that a border would cover * the next column. * * In styled mode, the stroke width can be set with the * `.highcharts-point` rule. */ borderWidth?: number; /** * (Highcharts, Highstock, Gantt) When `true`, the columns will center * in the category, ignoring null or missing points. When `false`, space * will be reserved for null or missing points. */ centerInCategory?: boolean; /** * (Highcharts) An additional class name to apply to the series' * graphical elements. This option does not replace default class names * of the graphical element. Changes to the series' color will also be * reflected in a chart's legend and tooltip. */ className?: string; /** * (Highcharts) The main color of the series. In line type series it * applies to the line and the point markers unless otherwise specified. * In bar type series it applies to the bars unless a color is specified * per point. The default value is pulled from the `options.colors` * array. * * In styled mode, the color can be defined by the colorIndex option. * Also, the series color can be set with the `.highcharts-series`, * `.highcharts-color-{n}`, `.highcharts-{type}-series` or * `.highcharts-series-{n}` class, or individual classes given by the * `className` option. */ color?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts, Highstock, Gantt) When using automatic point colors * pulled from the global colors or series-specific * plotOptions.column.colors collections, this option determines whether * the chart should receive one color per series or one color per point. * * In styled mode, the `colors` or `series.colors` arrays are not * supported, and instead this option gives the points individual color * class names on the form `highcharts-color-{n}`. */ colorByPoint?: boolean; /** * (Highcharts) Styled mode only. A specific color index to use for the * series, so its graphic representations are given the class name * `highcharts-color-{n}`. * * Since v11, CSS variables on the form `--highcharts-color-{n}` make * changing the color scheme very convenient. */ colorIndex?: number; /** * (Highcharts, Highstock, Highmaps) Determines what data value should * be used to calculate point color if `colorAxis` is used. Requires to * set `min` and `max` if some custom point property is used or if * approximation for data grouping is set to `'sum'`. */ colorKey?: string; /** * (Highcharts, Highstock, Gantt) A series specific or series type * specific color set to apply instead of the global colors when * colorByPoint is true. */ colors?: Array<(Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject)>; /** * (Highcharts) You can set the cursor to "pointer" if you have click * events attached to the series, to signal to the user that the points * and lines can be clicked. * * In styled mode, the series cursor can be set with the same classes as * listed under series.color. */ cursor?: (string|Highcharts.CursorValue); /** * (Highcharts) A reserved subspace to store options and values for * customized functionality. Here you can add additional data for your * own event callbacks and formatter callbacks. */ custom?: Highcharts.Dictionary<any>; /** * (Highcharts) Name of the dash style to use for the graph, or for some * series types the outline of each shape. * * In styled mode, the stroke dash-array can be set with the same * classes as listed under series.color. */ dashStyle?: Highcharts.DashStyleValue; /** * (Highcharts) A description of the series to add to the screen reader * information about the series. */ description?: string; /** * (Highcharts) 3D columns only. The width of the colored edges. */ edgeWidth?: number; /** * (Highcharts) Enable or disable the mouse tracking for a specific * series. This includes point tooltips and click events on graphs and * points. For large datasets it improves performance. */ enableMouseTracking?: boolean; /** * (Highcharts) General event handlers for the series items. These event * hooks can also be attached to the series at run time using the * `Highcharts.addEvent` function. */ events?: Highcharts.SeriesEventsOptionsObject; /** * (Highcharts) Highlight only the hovered point and fade the remaining * points. * * Scatter-type series require enabling the 'inactive' marker state and * adjusting opacity. Note that this approach could affect performance * with large datasets. */ inactiveOtherPoints?: boolean; /** * (Highcharts) When set to `false` will prevent the series data from * being included in any form of data export. * * Since version 6.0.0 until 7.1.0 the option was existing undocumented * as `includeInCSVExport`. */ includeInDataExport?: boolean; /** * (Highcharts) An array specifying which option maps to which key in * the data point array. This makes it convenient to work with * unstructured data arrays from different sources. */ keys?: Array<string>; /** * (Highcharts, Highstock, Gantt) Series labels are placed as close to * the series as possible in a natural way, seeking to avoid other * series. The goal of this feature is to make the chart more easily * readable, like if a human designer placed the labels in the optimal * position. * * The series labels currently work with series types having a `graph` * or an `area`. */ label?: Highcharts.SeriesLabelOptionsObject; /** * (Highcharts) What type of legend symbol to render for this series. * Can be one of `areaMarker`, `lineMarker` or `rectangle`. */ legendSymbol?: Highcharts.OptionsLegendSymbolValue; /** * (Highcharts, Highstock, Highmaps) Defines the color of the legend * symbol for this series. Defaults to undefined, in which case the * series color is used. Does not work with styled mode. */ legendSymbolColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts, Highstock, Gantt) The id of another series to link to. * Additionally, the value can be ":previous" to link to the previous * series. When two series are linked, only the first one appears in the * legend. Toggling the visibility of this also toggles the linked * series. * * If master series uses data sorting and linked series does not have * its own sorting definition, the linked series will be sorted in the * same order as the master one. */ linkedTo?: string; /** * (Highcharts) The word with the largest weight will have a font size * equal to this value. The font size of a word is the ratio between its * weight and the largest occuring weight, multiplied with the value of * maxFontSize. */ maxFontSize?: number; /** * (Highcharts) A threshold determining the minimum font size that can * be applied to a word. */ minFontSize?: number; /** * (Highcharts, Highstock) Whether or not data-points with the value of * `null` should be interactive. When this is set to `true`, tooltips * may highlight these points, and this option also enables keyboard * navigation for such points. Format options for such points include * `nullFormat` and `nullFormater`. Works for these series: `line`, * `spline`, `area`, `area-spline`, `column`, `bar`, and* `timeline`. */ nullInteraction?: (boolean|undefined); /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` * and `sunburst` series are supported at this moment. */ onPoint?: (object|Highcharts.PlotWordcloudOnPointOptions); /** * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and * dataLabels. */ opacity?: number; /** * (Highcharts) This option decides which algorithm is used for * placement, and rotation of a word. The choice of algorith is * therefore a crucial part of the resulting layout of the wordcloud. It * is possible for users to add their own custom placement strategies * for use in word cloud. Read more about it in our documentation */ placementStrategy?: Highcharts.OptionsPlacementStrategyValue; /** * (Highcharts) Properties for each single point. */ point?: Highcharts.PlotSeriesPointOptions; /** * (Highcharts) Same as accessibility.point.descriptionFormat, but for * an individual series. Overrides the chart wide configuration. */ pointDescriptionFormat?: Function; /** * (Highcharts) Same as accessibility.series.descriptionFormatter, but * for an individual series. Overrides the chart wide configuration. */ pointDescriptionFormatter?: Function; /** * (Highcharts, Highstock) When true, X values in the data set are * relative to the current `pointStart`, `pointInterval` and * `pointIntervalUnit` settings. This allows compression of the data for * datasets with irregular X values. * * The real X values are computed on the formula `f(x) = ax + b`, where * `a` is the `pointInterval` (optionally with a time unit given by * `pointIntervalUnit`), and `b` is the `pointStart`. */ relativeXValue?: boolean; /** * (Highcharts) Rotation options for the words in the wordcloud. */ rotation?: Highcharts.PlotWordcloudRotationOptions; /** * (Highcharts) Whether to select the series initially. If * `showCheckbox` is true, the checkbox next to the series name in the * legend will be checked for a selected series. */ selected?: boolean; /** * (Highcharts) Whether to display this particular series or series type * in the legend. Standalone series are shown in legend by default, and * linked series are not. Since v7.2.0 it is possible to show series * that use colorAxis by setting this option to `true`. */ showInLegend?: boolean; /** * (Highcharts) If set to `true`, the accessibility module will skip * past the points in this series for keyboard navigation. */ skipKeyboardNavigation?: boolean; /** * (Highcharts) Sonification/audio chart options for a series. */ sonification?: Highcharts.SeriesSonificationOptions; /** * (Highcharts) Spiral used for placing a word after the initial * position experienced a collision with either another word or the * borders. It is possible for users to add their own custom spiralling * algorithms for use in word cloud. Read more about it in our * documentation */ spiral?: Highcharts.OptionsSpiralValue; states?: Highcharts.SeriesStatesOptionsObject; /** * (Highcharts) Sticky tracking of mouse events. When true, the * `mouseOut` event on a series isn't triggered until the mouse moves * over another series, or out of the plot area. When false, the * `mouseOut` event on a series is triggered when the mouse leaves the * area around the series' graph or markers. This also implies the * tooltip when not shared. When `stickyTracking` is false and * `tooltip.shared` is false, the tooltip will be hidden when moving the * mouse between series. Defaults to true for line and area type series, * but to false for columns, pies etc. * * **Note:** The boost module will force this option because of * technical limitations. */ stickyTracking?: boolean; /** * (Highcharts) CSS styles for the words. */ style?: Highcharts.CSSObject; /** * (Highcharts) A configuration object for the tooltip rendering of each * single series. Properties are inherited from tooltip, but only the * following properties can be defined on a series level. */ tooltip?: Highcharts.SeriesTooltipOptionsObject; /** * (Highcharts, Highstock, Gantt) When a series contains a `data` array * that is longer than this, the Series class looks for data * configurations of plain numbers or arrays of numbers. The first and * last valid points are checked. If found, the rest of the data is * assumed to be the same. This saves expensive data checking and * indexing in long series, and makes data-heavy charts render faster. * * Set it to `0` disable. * * Note: * * - In boost mode turbo threshold is forced. Only array of numbers or * two dimensional arrays are allowed. * * - In version 11.4.3 and earlier, if object configurations were passed * beyond the turbo threshold, a warning was logged in the console and * the data series didn't render. */ turboThreshold?: number; /** * (Highcharts) Set the initial visibility of the series. */ visible?: boolean; } /** * (Highcharts) Positioning options for fixed tooltip, taking effect only * when tooltip.fixed is `true`. */ interface PlotWordcloudTooltipPositionOptions { /** * (Highcharts) The horizontal alignment of the fixed tooltip. */ align?: Highcharts.AlignValue; /** * (Highcharts) What the fixed tooltip alignment should be relative to. * * The default, `pane`, means that it is aligned within the plot area * for that given series. If the tooltip is split (as default in Stock * charts), each partial tooltip is aligned within the series' pane. */ relativeTo?: Highcharts.OptionsRelativeToValue; /** * (Highcharts) The vertical alignment of the fixed tooltip. */ verticalAlign?: Highcharts.VerticalAlignValue; /** * (Highcharts) X pixel offset from the given position. Can be used to * shy away from axis lines, grid lines etc to avoid the tooltip * overlapping other elements. */ x?: number; /** * (Highcharts) Y pixel offset from the given position. Can be used to * shy away from axis lines, grid lines etc to avoid the tooltip * overlapping other elements. */ y?: number; } /** * (Highcharts) A `wordcloud` series. If the type option is not specified, * it is inherited from chart.type. * * Configuration options for the series are given in three levels: * * 1. Options for all series in a chart are defined in the * plotOptions.series object. * * 2. Options for all `wordcloud` series are defined in * plotOptions.wordcloud. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) * * **TypeScript:** * * - the type option must always be set. * * - when accessing an array of series, the combined set of all series types * is represented by Highcharts.SeriesOptionsType . Narrowing down to the * specific type can be done by checking the `type` property. (see online * documentation for example) * * You have to extend the `SeriesWordcloudOptions` via an interface to allow * custom properties: ``` declare interface SeriesWordcloudOptions { * customProperty: string; } * */ interface SeriesWordcloudOptions extends Highcharts.PlotWordcloudOptions, Highcharts.SeriesOptions { /** * (Highcharts) An array of data points for the series. For the * `wordcloud` series type, points can be given in the following ways: * * 1. An array of arrays with 2 values. In this case, the values * correspond to `name,weight`. (see online documentation for example) * * 2. An array of objects with named values. The following snippet shows * only a few settings, see the complete options set below. If the total * number of data points exceeds the series' turboThreshold, this option * is not available. (see online documentation for example) */ data?: Array<([string, number]|Highcharts.PointOptionsObject)>; /** * (Highcharts, Highstock, Highmaps, Gantt) This property is only in * TypeScript non-optional and might be `undefined` in series objects * from unknown sources. */ type: "wordcloud"; } }