/*!* * * Copyright (c) Highsoft AS. All rights reserved. * *!*/ import * as Highcharts from "../highcharts"; declare module "../highcharts" { /** * (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 PlotXrangeDataLabelsAnimationOptions { /** * (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, 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 PlotXrangeDataLabelsStyleOptions { whiteSpace?: string; } /** * (Highcharts, Highstock, Gantt) Options for the _Series on point_ feature. * Only `pie` and `sunburst` series are supported at this moment. */ interface PlotXrangeOnPointOptions { /** * (Highcharts, Highstock, Gantt) 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.PlotXrangeOnPointConnectorOptions|Highcharts.SVGAttributes); /** * (Highcharts, Highstock, Gantt) 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, Highstock, Gantt) Options allowing to set a position and * an offset of the series in the _Series on point_ feature. */ position?: (object|Highcharts.PlotXrangeOnPointPositionOptions); } /** * (Highcharts, Highstock, Gantt) The X-range series displays ranges on the * X axis, typically time intervals with a start and end date. * * 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 `xrange` series are defined in plotOptions.xrange. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) */ interface PlotXrangeOptions { /** * (Highcharts, Highstock, Gantt) Accessibility options for a series. */ accessibility?: Highcharts.SeriesAccessibilityOptionsObject; /** * (Highcharts, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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; /** * (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, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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, 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, Highstock, Gantt) In an X-range series, this option * makes all points of the same Y-axis category the same color. */ colorByPoint?: boolean; /** * (Highcharts, Highstock, Gantt) 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)>; /** * (Highstock) Compare the values of the series against the first * non-null, non- zero value in the visible range. The y axis will show * percentage or absolute change depending on whether `compare` is set * to `"percent"` or `"value"`. When this is applied to multiple series, * it allows comparing the development of the series against each other. * Adds a `change` field to every point object. */ compare?: Highcharts.OptionsCompareValue; /** * (Highstock) When compare is `percent`, this option dictates whether * to use 0 or 100 as the base of comparison. */ compareBase?: (0|100); /** * (Highstock) Defines if comparison should start from the first point * within the visible range or should start from the first point * **before** the range. * * In other words, this flag determines if first point within the * visible range will have 0% (`compareStart=true`) or should have been * already calculated according to the previous point * (`compareStart=false`). */ compareStart?: boolean; /** * (Gantt) Override Pathfinder connector options for a series. Requires * Highcharts Gantt to be loaded. */ connectors?: Highcharts.SeriesConnectorsOptionsObject; /** * (Highstock) Cumulative Sum feature replaces points' values with the * following formula: `sum of all previous points' values + current * point's value`. Works only for points in a visible range. Adds the * `cumulativeSum` field to each point object that can be accessed e.g. * in the tooltip.pointFormat. * * With `dataGrouping` enabled, default grouping approximation is set to * `sum`. */ cumulative?: boolean; /** * (Highcharts, Highstock, Gantt) 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, Highstock, Gantt) 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, Gantt) 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; /** * (Highstock) Data grouping is the concept of sampling the data values * into larger blocks in order to ease readability and increase * performance of the JavaScript charts. Highcharts Stock by default * applies data grouping when the points become closer than a certain * pixel value, determined by the `groupPixelWidth` option. * * If data grouping is applied, the grouping information of grouped * points can be read from the Point.dataGroup. If point options other * than the data itself are set, for example `name` or `color` or custom * properties, the grouping logic doesn't know how to group it. In this * case the options of the first point instance are copied over to the * group point. This can be altered through a custom `approximation` * callback function. */ dataGrouping?: Highcharts.DataGroupingOptionsObject; /** * (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.PlotXrangeDataLabelsOptions|Array); /** * (Highcharts, Highstock, Gantt) A description of the series to add to * the screen reader information about the series. */ description?: string; /** * (Highcharts, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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, 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, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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; /** * (Highstock) The line marks the last price from all points. */ lastPrice?: Highcharts.SeriesLastPriceOptionsObject; /** * (Highstock) The line marks the last price from visible range of * points. */ lastVisiblePrice?: Highcharts.SeriesLastVisiblePriceOptionsObject; /** * (Highcharts, Highstock, Gantt) 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; /** * (Highstock) Options for the corresponding navigator series if * `showInNavigator` is `true` for this series. Available options are * the same as any series, documented at plotOptions and series. * * These options are merged with options in navigator.series, and will * take precedence if the same option is defined both places. */ navigatorOptions?: Highcharts.PlotSeriesOptions; /** * (Highcharts, Highstock, Gantt) Options for the _Series on point_ * feature. Only `pie` and `sunburst` series are supported at this * moment. */ onPoint?: (object|Highcharts.PlotXrangeOnPointOptions); /** * (Highcharts, Highstock, Gantt) Opacity of a series parts: line, fill * (e.g. area) and dataLabels. */ opacity?: number; /** * (Highcharts, Highstock, Gantt) A partial fill for each point, * typically used to visualize how much of a task is performed. The * partial fill object can be set either on series or point level. */ partialFill?: Highcharts.PlotXrangePartialFillOptions; /** * (Highcharts, Highstock, Gantt) Properties for each single point. */ point?: Highcharts.PlotSeriesPointOptions; /** * (Highcharts, Highstock, Gantt) Same as * accessibility.point.descriptionFormat, but for an individual series. * Overrides the chart wide configuration. */ pointDescriptionFormat?: Function; /** * (Highcharts, Highstock, Gantt) Same as * accessibility.series.descriptionFormatter, but for an individual * series. Overrides the chart wide configuration. */ pointDescriptionFormatter?: Function; /** * (Highcharts, Highstock, Gantt) Padding between each column or bar, in * x axis units. */ pointPadding?: number; pointRange?: 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, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) 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; /** * (Highstock) Whether or not to show the series in the navigator. Takes * precedence over navigator.baseSeries if defined. */ showInNavigator?: boolean; /** * (Highcharts, Highstock, Gantt) If set to `true`, the accessibility * module will skip past the points in this series for keyboard * navigation. */ skipKeyboardNavigation?: boolean; /** * (Highcharts, Highstock, Gantt) Sonification/audio chart options for a * series. */ sonification?: Highcharts.SeriesSonificationOptions; states?: Highcharts.SeriesStatesOptionsObject; /** * (Highcharts, Highstock, Gantt) 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, Highstock, Gantt) 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, Highstock, Gantt) Set the initial visibility of the * series. */ visible?: boolean; /** * (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, Gantt) An `xrange` series. If the type option is * not specified, it is inherited from chart.type. * * 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 `xrange` series are defined in plotOptions.xrange. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) * * You have to extend the `SeriesXrangeOptions` via an interface to allow * custom properties: ``` declare interface SeriesXrangeOptions { * customProperty: string; } * */ interface SeriesXrangeOptions extends Highcharts.PlotXrangeOptions, Highcharts.SeriesOptions { /** * (Highcharts, Highstock, Gantt) An array of data points for the * series. For the `xrange` series type, points can be given in the * following ways: * * 1. An array of objects with named values. The objects are point * configuration objects as seen below. (see online documentation for * example) */ data?: Array; /** * Not available */ depth?: undefined; /** * Not available */ edgeColor?: undefined; /** * Not available */ edgeWidth?: undefined; /** * (Highcharts, Highstock, Highmaps, Gantt) This property is only in * TypeScript non-optional and might be `undefined` in series objects * from unknown sources. */ type: "xrange"; } }