/*!* * * Copyright (c) Highsoft AS. All rights reserved. * *!*/ import * as Highcharts from "../highcharts"; declare module "../highcharts" { /** * (Highcharts) Point accessibility options for a series. */ interface PlotFunnel3dAccessibilityPointOptions { /** * (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) 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) 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) 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). */ interface PlotFunnel3dDataLabelsOptions { /** * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data * label compared to the point. If `right`, the right side of the label * should be touching the point. For points with an extent, like * columns, the alignments also dictates how to align it inside the box, * as given with the inside option. Can be one of `left`, `center` or * `right`. */ align?: string; /** * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels * to overlap. To make the labels less sensitive for overlapping, the * dataLabels.padding can be set to 0. */ allowOverlap?: boolean; /** * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the * initial animation when a series is displayed for the `dataLabels`. * The animation can also be set as a configuration object. Please note * that this option only applies to the initial animation. * * 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. */ animation?: (boolean|Highcharts.PlotFunnel3dDataLabelsAnimationOptions|Partial); /** * (Highcharts, Highstock, Highmaps, Gantt) The background color or * gradient for the data label. Setting it to `auto` will use the * point's color. */ backgroundColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts, Highstock, Highmaps, Gantt) The border color for the * data label. Setting it to `auto` will use the point's color. Defaults * to `undefined`. */ borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels * for the data label. */ borderRadius?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels * for the data label. */ borderWidth?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data * label. Particularly in styled mode, this can be used to give each * series' or point's data label unique styling. In addition to this * option, a default color class name is added so that we can give the * labels a contrast text shadow. */ className?: string; /** * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated. * Use style.color instead. * * The text color for the data labels. Defaults to `undefined`. For * certain series types, like column or map, the data labels can be * drawn inside the points. In this case the data label will be drawn * with maximum contrast by default. Additionally, it will be given a * `text-outline` style with the opposite color, to further increase the * contrast. This can be overridden by setting the `text-outline` style * to `none` in the `dataLabels.style` option. * * @deprecated 10.3.0 */ color?: Highcharts.ColorType; /** * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels * that are outside the plot area. By default, the data label is moved * inside the plot area according to the overflow option. */ crop?: boolean; /** * (Highcharts, Highstock, Gantt) Whether to defer displaying the data * labels until the initial series animation has finished. Setting to * `false` renders the data label immediately. If set to `true` inherits * the defer time set in plotOptions.series.animation. */ defer?: boolean; /** * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data * labels. */ enabled?: boolean; /** * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to * control of which data labels to display. The declarative filter is * designed for use when callback functions are not available, like when * the chart options require a pure JSON structure or for use with * graphical editors. For programmatic control, use the `formatter` * instead, and return `undefined` to disable a single data label. */ filter?: Highcharts.DataLabelsFilterOptionsObject; /** * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data * label. Available variables are the same as for `formatter`. */ format?: string; /** * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function * to format the data label. Note that if a `format` is defined, the * format takes precedence and the formatter is ignored. */ formatter?: Highcharts.DataLabelsFormatterCallbackFunction; /** * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, * like columns or map areas, whether to align the data label inside the * box or to the actual value point. Defaults to `false` in most cases, * `true` in stacked columns. */ inside?: boolean; /** * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the * value of null. Works analogously to format. `nullFormat` can be * applied only to series which support displaying null points i.e * `heatmap` or `tilemap`. Does not work with series that don't display * null points, like `line`, `column`, `bar` or `pie`. */ nullFormat?: (boolean|string); /** * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function * that defines formatting for points with the value of null. Works * analogously to formatter. `nullFormatter` can be applied only to * series which support displaying null points i.e `heatmap` or * `tilemap`. Does not work with series that don't display null points, * like `line`, `column`, `bar` or `pie`. */ nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction; /** * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels * that flow outside the plot area. The default is `"justify"`, which * aligns them inside the plot area. For columns and bars, this means it * will be moved inside the bar. To display data labels outside the plot * area, set `crop` to `false` and `overflow` to `"allow"`. */ overflow?: string; /** * (Highcharts, Highstock, Highmaps, Gantt) When either the * `borderWidth` or the `backgroundColor` is set, this is the padding * within the box. */ padding?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative * to points. If `center` alignment is not possible, it defaults to * `right`. */ position?: Highcharts.AlignValue; /** * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. * Note that due to a more complex structure, backgrounds, borders and * padding will be lost on a rotated data label. */ rotation?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow * can be an object configuration containing `color`, `offsetX`, * `offsetY`, `opacity` and `width`. */ shadow?: (boolean|Highcharts.ShadowOptionsObject); /** * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use * for the border around the label. Symbols are predefined functions on * the Renderer object. */ shape?: 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. */ style?: Highcharts.CSSObject; /** * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text * which should follow marker's shape. Border and background are * disabled for a label that follows a path. * * **Note:** Only SVG-based renderer supports this option. Setting * `useHTML` to true will disable this option. */ textPath?: Highcharts.DataLabelsTextPathOptionsObject; /** * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to * render the labels. */ useHTML?: boolean; /** * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a * data label. Can be one of `top`, `middle` or `bottom`. The default * value depends on the data, for instance in a column chart, the label * is above positive values and below negative values. */ verticalAlign?: string; /** * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the * label relative to the point in pixels. */ x?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the * label relative to the point in pixels. */ y?: number; /** * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data * labels. Use a `zIndex` of 6 to display it above the series, or use a * `zIndex` of 2 to display it behind the series. */ zIndex?: number; } /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` and * `sunburst` series are supported at this moment. */ interface PlotFunnel3dOnPointOptions { /** * (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.PlotFunnel3dOnPointConnectorOptions|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.PlotFunnel3dOnPointPositionOptions); } /** * (Highcharts) A funnel3d is a 3d version of funnel series type. Funnel * charts are a type of chart often used to visualize stages in a sales * project, where the top are the initial stages with the most clients. * * It requires that the `highcharts-3d.js`, `cylinder.js` and `funnel3d.js` * module are loaded. * * In TypeScript the type option must always be set. * * 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 `funnel3d` series are defined in plotOptions.funnel3d. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) */ interface PlotFunnel3dOptions { /** * (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) 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) 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, 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, 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, Highstock, Gantt) When the series contains less points * than the crop threshold, all points are drawn, event if the points * fall outside the visible plot area at the current zoom. The advantage * of drawing all points (including markers and columns), is that * animation is performed on updates. On the other hand, when the series * contains more points than the crop threshold, the series data is * cropped to only contain points that fall within the plot area. The * advantage of cropping away invisible points is to increase * performance on large series. */ cropThreshold?: number; /** * (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; /** * (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.PlotFunnel3dDataLabelsOptions|Array); /** * (Highcharts) Depth of the columns in a 3D column chart. */ depth?: number; /** * (Highcharts) A description of the series to add to the screen reader * information about the series. */ description?: string; /** * (Highcharts) The draggable-points module allows points to be moved * around or modified in the chart. In addition to the options mentioned * under the `dragDrop` API structure, the module fires three events, * point.dragStart, point.drag and point.drop. */ dragDrop?: Highcharts.SeriesDragDropOptionsObject; /** * (Highcharts) 3D columns only. The color of the edges. Similar to * `borderColor`, except it defaults to the same color as the column. */ edgeColor?: Highcharts.ColorString; /** * (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) 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, Highstock, Gantt) Whether to use the Y extremes of the * total chart width or only the zoomed area when zooming in on parts of * the X axis. By default, the Y axis adjusts to the min and max of the * visible data. Cartesian series only. */ getExtremesFromAll?: boolean; /** * (Highcharts) By default sides fill is set to a gradient through this * option being set to `true`. Set to `false` to get solid color for the * sides. */ gradientForSides?: boolean; /** * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns * or to let them render independent of each other. Non-grouped columns * will be laid out individually and overlap each other. */ grouping?: boolean; /** * (Highcharts, Highstock, Gantt) Padding between each value groups, in * x axis units. */ groupPadding?: number; /** * (Highcharts) The spacing between columns on the Z Axis in a 3D chart. */ groupZPadding?: number; /** * (Highcharts) The height of the series. If it is a number it defines * the pixel height, if it is a percentage string it is the percentage * of the plot area height. */ height?: (number|string); /** * (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; /** * (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, 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, Highstock, Gantt) The maximum allowed pixel width for a * column, translated to the height of a bar in a bar chart. This * prevents the columns from becoming too wide when there is a small * number of points in the chart. */ maxPointWidth?: number; /** * (Highcharts, Highstock, Gantt) The minimal height for a column or * width for a bar. By default, 0 values are not shown. To visualize a 0 * (or close to zero) point, set the minimal point length to a pixel * value like 3\. In stacked column charts, minPointLength might not be * respected for tightly packed values. */ minPointLength?: number; /** * (Highcharts) The height of the neck, the lower part of the funnel. A * number defines pixel width, a percentage string defines a percentage * of the plot area height. */ neckHeight?: (number|string); /** * (Highcharts) The width of the neck, the lower part of the funnel. A * number defines pixel width, a percentage string defines a percentage * of the plot area width. */ neckWidth?: (number|string); /** * (Highcharts) The color for the parts of the graph or points that are * below the threshold. Note that `zones` takes precedence over the * negative color. Using `negativeColor` is equivalent to applying a * zone with value of 0. */ negativeColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` * and `sunburst` series are supported at this moment. */ onPoint?: (object|Highcharts.PlotFunnel3dOnPointOptions); /** * (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, Gantt) If no x values are given for the * points in a series, `pointInterval` defines the interval of the x * values. For example, if a series contains one value every decade * starting from year 0, set `pointInterval` to `10`. In true `datetime` * axes, the `pointInterval` is set in milliseconds. * * It can be also be combined with `pointIntervalUnit` to draw irregular * time intervals. * * If combined with `relativeXValue`, an x value can be set on each * point, and the `pointInterval` is added x times to the `pointStart` * setting. * * Please note that this options applies to the _series data_, not the * interval of the axis ticks, which is independent. */ pointInterval?: number; /** * (Highcharts, Highstock, Gantt) On datetime series, this allows for * setting the pointInterval to irregular time units, `day`, `month` and * `year`. A day is usually the same as 24 hours, but * `pointIntervalUnit` also takes the DST crossover into consideration * when dealing with local time. Combine this option with * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc. * * Please note that this options applies to the _series data_, not the * interval of the axis ticks, which is independent. */ pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue; /** * (Highcharts, Highstock, Gantt) Padding between each column or bar, in * x axis units. */ pointPadding?: number; /** * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`, * `number`. * * In a column chart, when pointPlacement is `"on"`, the point will not * create any padding of the X axis. In a polar column chart this means * that the first column points directly north. If the pointPlacement is * `"between"`, the columns will be laid out between ticks. This is * useful for example for visualising an amount between two points in * time or in a certain sector of a polar chart. * * Since Highcharts 3.0.2, the point placement can also be numeric, * where 0 is on the axis value, -0.5 is between this value and the * previous, and 0.5 is between this value and the next. Unlike the * textual options, numeric point placement options won't affect axis * padding. * * Note that pointPlacement needs a pointRange to work. For column * series this is computed, but for line-type series it needs to be set. * * For the `xrange` series type and gantt charts, if the Y axis is a * category axis, the `pointPlacement` applies to the Y axis rather than * the (typically datetime) X axis. * * Defaults to `undefined` in cartesian charts, `"between"` in polar * charts. */ pointPlacement?: (number|string); /** * (Highcharts, Highstock, Gantt) The X axis range that each point is * valid for. This determines the width of the column. On a categorized * axis, the range will be 1 by default (one category unit). On linear * and datetime axes, the range will be computed as the distance between * the two closest data points. * * The default `null` means it is computed automatically, but this * option can be used to override the automatic value. * * This option is set by default to 1 if data sorting is enabled. */ pointRange?: (number|null); /** * (Highcharts, Highstock, Gantt) If no x values are given for the * points in a series, pointStart defines on what value to start. For * example, if a series contains one yearly value starting from 1945, * set pointStart to 1945. * * If combined with `relativeXValue`, an x value can be set on each * point. The x value from the point options is multiplied by * `pointInterval` and added to `pointStart` to produce a modified x * value. */ pointStart?: number; /** * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width * for each column or bar point. When set to `undefined`, the width is * calculated from the `pointPadding` and `groupPadding`. The width * effects the dimension that is not based on the point value. For * column series it is the horizontal length and for bar series it is * the vertical length. */ pointWidth?: number; /** * (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) A reversed funnel has the widest area down. A reversed * funnel with no neck width and neck height is a pyramid. */ reversed?: 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, Highstock) When this is true, the series will not cause * the Y axis to cross the zero plane (or threshold option) unless the * data actually crosses the plane. * * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 * will make the Y axis show negative values according to the * `minPadding` option. If `softThreshold` is `true`, the Y axis starts * at 0. */ softThreshold?: boolean; /** * (Highcharts) Sonification/audio chart options for a series. */ sonification?: Highcharts.SeriesSonificationOptions; /** * (Highcharts, Highstock) Whether to stack the values of each series on * top of each other. Possible values are `undefined` to disable, * `"normal"` to stack by value or `"percent"`. * * When stacking is enabled, data must be sorted in ascending X order. * * Some stacking options are related to specific series types. In the * streamgraph series type, the stacking option is set to `"stream"`. * The second one is `"overlap"`, which only applies to waterfall * series. */ stacking?: Highcharts.OptionsStackingValue; 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) The Y axis value to serve as the base for the columns, * for distinguishing between values above and below a threshold. If * `null`, the columns extend from the padding Y axis minimum. */ threshold?: (number|null); /** * (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, only one dimensional arrays of numbers, or * two dimensional arrays with x and y values are allowed. Also, only * the first point is tested, and the rest are assumed to be the same * format. This saves expensive data checking and indexing in long * series. Set it to `0` disable. * * Note: In boost mode turbo threshold is forced. Only array of numbers * or two dimensional arrays are allowed. */ turboThreshold?: number; /** * (Highcharts) Set the initial visibility of the series. */ visible?: boolean; /** * (Highcharts) The max width of the series compared to the width of the * plot area, or the pixel width if it is a number. */ width?: (number|string); /** * (Highcharts, Highstock) Defines the Axis on which the zones are * applied. */ zoneAxis?: string; /** * (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, Highstock, Highmaps, Gantt) Enable or disable the initial * animation when a series is displayed for the `dataLabels`. The animation * can also be set as a configuration object. Please note that this option * only applies to the initial animation. * * 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. */ interface PlotFunnelDataLabelsAnimationOptions { /** * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in * milliseconds. Set to `0` to render the data labels immediately. As * `undefined` inherits defer time from the series.animation.defer. */ defer?: number; } /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` and * `sunburst` series are supported at this moment. */ interface PlotFunnelOnPointOptions { /** * (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.PlotFunnelOnPointConnectorOptions|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.PlotFunnelOnPointPositionOptions); } /** * (Highcharts) Funnel charts are a type of chart often used to visualize * stages in a sales project, where the top are the initial stages with the * most clients. It requires that the modules/funnel.js file is loaded. * * In TypeScript the type option must always be set. * * 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 `funnel` series are defined in plotOptions.funnel. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) */ interface PlotFunnelOptions { /** * (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) Initial animation is by default disabled for the funnel * chart. */ animation?: boolean; /** * (Highcharts, Highmaps) The color of the border surrounding each * slice. When `null`, the border takes the same color as the slice * fill. This can be used together with a `borderWidth` to fill drawing * gaps created by antialiazing artefacts in borderless pies. * * In styled mode, the border stroke is given in the `.highcharts-point` * class. */ borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts) The corner radius of the border surrounding all points * or series. A number signifies pixels. A percentage string, like for * example `50%`, signifies a size relative to the series width. */ borderRadius?: number; /** * (Highcharts, Highmaps) The width of the border surrounding each * slice. * * When setting the border width to 0, there may be small gaps between * the slices due to SVG antialiasing artefacts. To work around this, * keep the border width at 0.5 or 1, but set the `borderColor` to * `null` instead. * * In styled mode, the border stroke width is given in the * `.highcharts-point` class. */ borderWidth?: number; /** * (Highcharts, Highmaps) The center of the series. By default, it is * centered in the middle of the plot area, so it fills the plot area * height. */ center?: Array<(number|string)>; /** * (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 color of the pie series. A pie series is represented * as an empty circle if the total sum of its values is 0. Use this * property to define the color of its border. * * 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, Highmaps) When using dual or multiple color * axes, this number defines which colorAxis the particular series is * connected to. It refers to either the axis id or the index of the * axis in the colorAxis array, with 0 being the first. Set this option * to false to prevent a series from connecting to the default color * axis. * * Since v7.2.0 the option can also be an axis id or an axis index * instead of a boolean flag. */ colorAxis?: (boolean|number|string); /** * (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, Highmaps) A series specific or series type specific * color set to use instead of the global colors. */ colors?: Array<(Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject)>; /** * (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; /** * (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.SeriesPieDataLabelsOptionsObject|Array); /** * (Highcharts) The thickness of a 3D pie. */ depth?: number; /** * (Highcharts) A description of the series to add to the screen reader * information about the series. */ description?: string; /** * (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, Highmaps) The end angle of the pie in degrees where 0 is * top and 90 is right. Defaults to `startAngle` plus 360. */ endAngle?: number; /** * (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) If the total sum of the pie's values is 0, the series is * represented as an empty circle . The `fillColor` option defines the * color of that circle. Use pie.borderWidth to set the border * thickness. */ fillColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject); /** * (Highcharts) The height of the funnel or pyramid. If it is a number * it defines the pixel height, if it is a percentage string it is the * percentage of the plot area height. */ height?: (number|string); /** * (Highcharts, Highmaps) Equivalent to chart.ignoreHiddenSeries, this * option tells whether the series shall be redrawn as if the hidden * point were `null`. * * The default value changed from `false` to `true` with Highcharts 3.0. */ ignoreHiddenPoint?: boolean; /** * (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; /** * (Highcharts) What type of legend symbol to render for this series. * Can be one of `areaMarker`, `lineMarker` or `rectangle`. */ legendSymbol?: Highcharts.OptionsLegendSymbolValue; /** * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` * and `stroke-linejoin` of a line graph. Round means that lines are * rounded in the ends and bends. */ linecap?: Highcharts.SeriesLinecapValue; /** * (Highcharts, Highmaps) The minimum size for a pie in response to auto * margins. The pie will try to shrink to make room for data labels in * side the plot area, but only to this size. */ minSize?: (number|string); /** * (Highcharts) The height of the neck, the lower part of the funnel. A * number defines pixel width, a percentage string defines a percentage * of the plot area height. */ neckHeight?: (number|string); /** * (Highcharts) The width of the neck, the lower part of the funnel. A * number defines pixel width, a percentage string defines a percentage * of the plot area width. */ neckWidth?: (number|string); /** * (Highcharts) Options for the _Series on point_ feature. Only `pie` * and `sunburst` series are supported at this moment. */ onPoint?: (object|Highcharts.PlotFunnelOnPointOptions); /** * (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) A reversed funnel has the widest area down. A reversed * funnel with no neck width and neck height is a pyramid. */ reversed?: 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, Highmaps) Whether to display this particular series or * series type in the legend. Since 2.1, pies are not shown in the * legend by default. */ showInLegend?: boolean; /** * (Highcharts) If set to `true`, the accessibility module will skip * past the points in this series for keyboard navigation. */ skipKeyboardNavigation?: boolean; /** * (Highcharts, Highmaps) If a point is sliced, moved out from the * center, how many pixels should it be moved?. */ slicedOffset?: number; /** * (Highcharts) Sonification/audio chart options for a series. */ sonification?: Highcharts.SeriesSonificationOptions; /** * (Highcharts, Highmaps) The start angle of the pie slices in degrees * where 0 is top and 90 right. */ startAngle?: number; /** * (Highcharts) Options for the series states. */ states?: Highcharts.SeriesStatesOptionsObject; /** * (Highcharts, Highmaps) 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 `stickyTracking` is false and `tooltip.shared` is * false, the tooltip will be hidden when moving the mouse between * series. */ stickyTracking?: boolean; /** * (Highcharts) Thickness describing the ring size for a donut type * chart, overriding innerSize. */ thickness?: number; /** * (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) Set the initial visibility of the series. */ visible?: boolean; /** * (Highcharts) The width of the funnel compared to the width of the * plot area, or the pixel width if it is a number. */ width?: (number|string); } /** * (Highcharts, Highstock, Gantt) Enable or disable the initial animation * when a series is displayed for the `dataLabels`. The animation can also * be set as a configuration object. Please note that this option only * applies to the initial animation. * * 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. */ interface SeriesFunnel3dDataDataLabelsAnimationOptions { /** * (Highcharts, Highstock, Gantt) The animation delay time in * milliseconds. Set to `0` to render the data labels immediately. As * `undefined` inherits defer time from the series.animation.defer. */ defer?: number; } /** * (Highcharts, Highmaps) Enable or disable the initial animation when a * series is displayed for the `dataLabels`. The animation can also be set * as a configuration object. Please note that this option only applies to * the initial animation. * * 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. */ interface SeriesFunnelDataDataLabelsAnimationOptions { /** * (Highcharts, Highmaps) The animation delay time in milliseconds. Set * to `0` to render the data labels immediately. As `undefined` inherits * defer time from the series.animation.defer. */ defer?: number; } }