highcharts

/*!* * * Copyright (c) Highsoft AS. All rights reserved. * *!*/ import * as Highcharts from "../highcharts.src"; declare module "../highcharts.src" { /** * (Highcharts) Point accessibility options for a series. */ interface PlotNetworkgraphAccessibilityPointOptions { /** * (Highcharts) Date format to use for points on datetime axes when * describing them to screen reader users. * * Defaults to the same format as in tooltip. * * For an overview of the replacement codes, see dateFormat. */ dateFormat?: string; /** * (Highcharts) Formatter function to determine the date/time format * used with points on datetime axes when describing them to screen * reader users. Receives one argument, `point`, referring to the point * to describe. Should return a date format string compatible with * dateFormat. */ dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>; /** * (Highcharts) Whether or not to describe points with the value `null` * to assistive technology, such as screen readers. */ describeNull?: boolean; /** * (Highcharts) A format string to use instead of the default for point * descriptions. * * The context of the format string is the point instance. * * As opposed to accessibility.point.valueDescriptionFormat, this option * replaces the whole description. */ descriptionFormat?: string; /** * (Highcharts) Formatter function to use instead of the default for * point descriptions. Same as * `accessibility.point.descriptionFormatter`, but applies to a series * instead of the whole chart. * * Note: Prefer using accessibility.point.valueDescriptionFormat instead * if possible, as default functionality such as describing annotations * will be preserved. */ descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>; /** * (Highcharts) Decimals to use for the values in the point * descriptions. Uses tooltip.valueDecimals if not defined. */ valueDecimals?: number; /** * (Highcharts) Format to use for describing the values of data points * to assistive technology - including screen readers. The point context * is available as `{point}`. * * Other available context variables include `{index}`, `{value}`, and * `{xDescription}`. * * Additionally, the series name, annotation info, and description added * in `point.accessibility.description` is added by default if relevant. * To override this, use the accessibility.point.descriptionFormatter * option. */ valueDescriptionFormat?: string; /** * (Highcharts) Prefix to add to the values in the point descriptions. * Uses tooltip.valuePrefix if not defined. */ valuePrefix?: string; /** * (Highcharts) Suffix to add to the values in the point descriptions. * Uses tooltip.valueSuffix if not defined. */ valueSuffix?: string; } /** * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The * default `color` setting is `"contrast"`, which is a pseudo color that * Highcharts picks up and applies the maximum contrast to the underlying * point item, for example the bar in a bar chart. * * The `textOutline` is a pseudo property that applies an outline of the * given width with the given color, which by default is the maximum * contrast to the text. So a bright text color will result in a black text * outline for maximum readability on a mixed background. In some cases, * especially with grayscale text, the text outline doesn't work well, in * which cases it can be disabled by setting it to `"none"`. When `useHTML` * is true, the `textOutline` will not be picked up. In this, case, the same * effect can be acheived through the `text-shadow` CSS property. * * For some series types, where each point has an extent, like for example * tree maps, the data label may overflow the point. There are two * strategies for handling overflow. By default, the text will wrap to * multiple lines. The other strategy is to set `style.textOverflow` to * `ellipsis`, which will keep the text on one line plus it will break * inside long words. */ interface PlotNetworkgraphDataLabelsStyleOptions { transition?: string; } /** * (Highcharts) Link style options */ interface PlotNetworkgraphLinkOptions { /** * (Highcharts) Color of the link between two nodes. */ color?: string; /** * (Highcharts) A name for the dash style to use for links. */ dashStyle?: string; /** * (Highcharts) Opacity of the link between two nodes. */ opacity?: number; /** * (Highcharts) Width (px) of the link between two nodes. */ width?: number; } /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` and * `sunburst` series are supported at this moment. */ interface PlotNetworkgraphOnPointOptions { /** * (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.PlotNetworkgraphOnPointConnectorOptions|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.PlotNetworkgraphOnPointPositionOptions); } /** * (Highcharts) A networkgraph is a type of relationship chart, where * connnections (links) attracts nodes (points) and other nodes repulse each * other. * * 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 `networkgraph` series are defined in * plotOptions.networkgraph. * * 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 PlotNetworkgraphOptions { /** * (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) 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) Disable this option to allow series rendering in the * whole plotting area. * * **Note:** Clipping should be always enabled when chart.zoomType is * set */ clip?: boolean; /** * (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) 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, Gantt) When true, each point or column edge * is rounded to its nearest pixel in order to render sharp on screen. * In some cases, when there are a lot of densely packed columns, this * leads to visible difference in column widths or distance between * columns. In these cases, setting `crisp` to `false` may look better, * even though each column is rendered blurry. */ crisp?: boolean; /** * (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, Highstock, Highmaps, Gantt) Options for the series data * labels, appearing next to each data point. * * Since v6.2.0, multiple data labels can be applied to each single * point by defining them as an array of configs. * * In styled mode, the data labels can be styled with the * `.highcharts-data-label-box` and `.highcharts-data-label` class names * (see example). */ dataLabels?: (Highcharts.SeriesNetworkgraphDataLabelsOptionsObject|Array<Highcharts.SeriesNetworkgraphDataLabelsOptionsObject>); /** * (Highcharts) A description of the series to add to the screen reader * information about the series. */ description?: string; /** * (Highcharts) Flag to determine if nodes are draggable or not. */ draggable?: boolean; /** * (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) Determines whether the series should look for the * nearest point in both dimensions or just the x-dimension when * hovering the series. Defaults to `'xy'` for scatter series and `'x'` * for most other series. If the data has duplicate x-values, it is * recommended to set this to `'xy'` to allow hovering over all points. * * Applies only to series types using nearest neighbor search (not * direct hover) for tooltip. */ findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue; /** * (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>; layoutAlgorithm?: Highcharts.PlotNetworkgraphLayoutAlgorithmOptions; /** * (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) Pixel width of the graph line. */ lineWidth?: number; /** * (Highcharts) Link style options */ link?: Highcharts.PlotNetworkgraphLinkOptions; /** * (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) Options for the point markers of line and scatter-like * series. Properties like `fillColor`, `lineColor` and `lineWidth` * define the visual appearance of the markers. The `symbol` option * defines the shape. Other series types, like column series, don't have * markers, but have visual options on the series level instead. * * In styled mode, the markers can be styled with the * `.highcharts-point`, `.highcharts-point-hover` and * `.highcharts-point-select` class names. */ marker?: Highcharts.PointMarkerOptionsObject; /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` * and `sunburst` series are supported at this moment. */ onPoint?: (object|Highcharts.PlotNetworkgraphOnPointOptions); /** * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and * dataLabels. */ opacity?: number; /** * (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) 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 apply a drop shadow to the graph line. Since * 2.3 the shadow can be an object configuration containing `color`, * `offsetX`, `offsetY`, `opacity` and `width`. * * Note that in some cases, like stacked columns or other dense layouts, * the series may cast shadows on each other. In that case, the * `chart.seriesGroupShadow` allows applying a common drop shadow to the * whole series group. */ shadow?: (boolean|Highcharts.ShadowOptionsObject); /** * (Highcharts) If true, a checkbox is displayed next to the legend item * to allow selecting the series. The state of the checkbox is * determined by the `selected` option. */ showCheckbox?: 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; 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) 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, Highstock) An array defining zones within a series. * Zones can be applied to the X axis, Y axis or Z axis for bubbles, * according to the `zoneAxis` option. The zone definitions have to be * in ascending order regarding to the value. * * In styled mode, the color zones are styled with the * `.highcharts-zone-{n}` class, or custom classed from the `className` * option (view live demo). */ zones?: Array<Highcharts.SeriesZonesOptionsObject>; } /** * (Highcharts) A collection of options for the individual nodes. The nodes * in a networkgraph diagram are auto-generated instances of * `Highcharts.Point`, but options can be applied here and linked by the * `id`. */ interface SeriesNetworkgraphNodesOptions { /** * (Highcharts) The color of the auto generated node. */ color?: Highcharts.ColorString; /** * (Highcharts) The color index of the auto generated node, especially * for use in styled mode. */ colorIndex?: number; /** * (Highcharts) Individual data label for each node. The options are the * same as the ones for series.networkgraph.dataLabels. */ dataLabels?: (Highcharts.SeriesNetworkgraphDataLabelsOptionsObject|Array<Highcharts.SeriesNetworkgraphDataLabelsOptionsObject>); /** * (Highcharts) The id of the auto-generated node, referring to the * `from` or `to` setting of the link. */ id?: string; /** * (Highcharts) Options for the node markers. */ marker?: Highcharts.PointMarkerOptionsObject; /** * (Highcharts) Mass of the node. By default, each node has mass equal * to it's marker radius . Mass is used to determine how two connected * nodes should affect each other: * * Attractive force is multiplied by the ratio of two connected nodes; * if a big node has weights twice as the small one, then the small one * will move towards the big one twice faster than the big one to the * small one . */ mass?: number; /** * (Highcharts) The name to display for the node in data labels and * tooltips. Use this when the name is different from the `id`. Where * the id must be unique for each node, this is not necessary for the * name. */ name?: string; } }