/*!* * * Copyright (c) Highsoft AS. All rights reserved. * *!*/ import * as Highcharts from "../highcharts"; declare module "../highcharts" { /** * (Highcharts, Highstock) Point accessibility options for a series. */ interface PlotWindbarbAccessibilityPointOptions { /** * (Highcharts, Highstock) 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, Highstock) 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, Highstock) Whether or not to describe points with the * value `null` to assistive technology, such as screen readers. */ describeNull?: boolean; /** * (Highcharts, Highstock) 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, Highstock) 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, Highstock) Decimals to use for the values in the point * descriptions. Uses tooltip.valueDecimals if not defined. */ valueDecimals?: number; /** * (Highcharts, Highstock) 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, Highstock) Prefix to add to the values in the point * descriptions. Uses tooltip.valuePrefix if not defined. */ valuePrefix?: string; /** * (Highcharts, Highstock) 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 PlotWindbarbDataLabelsOptions { /** * (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) Alignment method for data * labels. If set to `plotEdges`, the labels are aligned within the plot * area in the direction of the y-axis. So in a regular column chart, * the labels are aligned vertically according to the `verticalAlign` * setting. In a bar chart, which is inverted, the labels are aligned * horizontally according to the `align` setting. Applies to cartesian * series only. */ alignTo?: 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.PlotWindbarbDataLabelsAnimationOptions|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.ColorType; /** * (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.ColorType; /** * (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. (see * online documentation for example) */ 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) The rank for this point's * data label in case of collision. If two data labels are about to * overlap, only the one with the highest `labelrank` will be drawn. */ labelrank?: number; /** * (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. * `heatmap` and `tilemap` supports `nullFormat` by default while the * following series requires [#series.nullInteraction] set to `true`: * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and * `timeline`. Does not work with series that don't display null points, * like `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. `heatmap` and `tilemap` * supports `nullFormatter` by default while the following series * requires (series.nullInteraction)[#series.nullInteraction] set to * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and * `timeline`. Does not work with series that don't display null points, * like `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?: Highcharts.DataLabelsOverflowValue; /** * (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 achieved 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, Gantt) Styles for the series label. The color * defaults to the series color, or a contrast color if `onArea`. */ interface PlotWindbarbLabelStyleOptions { fontSize?: (number|string); } /** * (Highcharts, Highstock) Options for the _Series on point_ feature. Only * `pie` and `sunburst` series are supported at this moment. */ interface PlotWindbarbOnPointOptions { /** * (Highcharts, Highstock) 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.PlotWindbarbOnPointConnectorOptions|Highcharts.SVGAttributes); /** * (Highcharts, Highstock) 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) Options allowing to set a position and an * offset of the series in the _Series on point_ feature. */ position?: (object|Highcharts.PlotWindbarbOnPointPositionOptions); } /** * (Highcharts, Highstock) Wind barbs are a convenient way to represent wind * speed and direction in one graphical form. Wind direction is given by the * stem direction, and wind speed by the number and shape of barbs. * * 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 `windbarb` series are defined in plotOptions.windbarb. * * 3. Options for one single series are given in the series instance array. * (see online documentation for example) * * **TypeScript:** * * - type option should always be set, otherwise a broad set of unsupported * options is allowed. * * - 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 PlotWindbarbOptions { /** * (Highcharts, Highstock) Accessibility options for a series. */ accessibility?: Highcharts.SeriesAccessibilityOptionsObject; /** * (Highcharts, Highstock) 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) 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) 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.ColorType; /** * (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, Highstock) 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) 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) 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.ColorType; /** * (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) 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, Highstock) 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; /** * (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. If a `compare` value is * not set on a linked series, it will be inherited from the parent * series. */ 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 last 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; /** * (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; /** * (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; /** * (Highstock) Defines if cumulation should start from the first point * within the visible range or should start from the last point * **before** the range. * * In other words, this flag determines if first point within the * visible range will start at 0 (`cumulativeStart=true`) or should have * been already calculated according to the previous point * (`cumulativeStart=false`). */ cumulativeStart?: boolean; /** * (Highcharts, Highstock) 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) 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) Data grouping options for the wind barbs. In * Highcharts, this requires the `modules/datagrouping.js` module to be * loaded. In Highcharts Stock, data grouping is included. */ 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.PlotWindbarbDataLabelsOptions|Array); /** * (Highcharts, Highstock) Options for the series data sorting. */ dataSorting?: (Highcharts.DataSortingOptionsObject|Highcharts.PlotWindbarbDataSortingOptions); /** * (Highcharts) Depth of the columns in a 3D column chart. */ depth?: number; /** * (Highcharts, Highstock) Deprecated. Use * plotOptions.series.accessibility.description instead. * * A description of the series to add to the screen reader information * about the series. * * @deprecated 8.0.0 */ description?: string; /** * (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, Highstock) 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) 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) 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, 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) 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) 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) 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) 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.ColorType; /** * (Highcharts, Highstock) The line width of the wind barb symbols. */ lineWidth?: number; /** * (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. * * If a `compare` value is not set on a linked series, it will be * inherited from the parent series. */ 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) 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.ColorType; /** * (Highcharts, Highstock) Whether or not data-points with the value of * `null` should be interactive. When this is set to `true`, tooltips * may highlight these points, and this option also enables keyboard * navigation for such points. Format options for such points include * `nullFormat` and `nullFormatter`. Works for these series: `line`, * `spline`, `area`, `area-spline`, `column`, `bar`, and `timeline`. */ nullInteraction?: (boolean|undefined); /** * (Highcharts, Highstock) Options for the _Series on point_ feature. * Only `pie` and `sunburst` series are supported at this moment. */ onPoint?: (object|Highcharts.PlotWindbarbOnPointOptions); /** * (Highcharts, Highstock) The id of another series in the chart that * the wind barbs are projected on. When `null`, the wind symbols are * drawn on the X axis, but offset up or down by the `yOffset` setting. */ onSeries?: (string|null); /** * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. * area) and dataLabels. */ opacity?: number; /** * (Highcharts, Highstock) Properties for each single point. */ point?: Highcharts.PlotSeriesPointOptions; /** * (Highcharts, Highstock) Deprecated. Use * series.accessibility.point.descriptionFormat instead. * * Same as accessibility.point.descriptionFormat, but for an individual * series. Overrides the chart wide configuration. */ pointDescriptionFormat?: Function; /** * (Highcharts, Highstock) Deprecated. Use * series.accessibility.point.descriptionFormatter instead. * * Same as accessibility.series.descriptionFormatter, but for an * individual series. Overrides the chart wide configuration. * * @deprecated 8.0.0 */ 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 visualizing 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. * * The `pointStart` setting can be a number, or a datetime string that * is parsed according to the `time.timezone` setting. * * 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|string); /** * (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) 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) 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) 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) Deprecated. Use * series.accessibility.keyboardNavigation instead. * * If set to `true`, the accessibility module will skip past the points * in this series for keyboard navigation. * * @deprecated 8.0.0 */ 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, Highstock) Sonification/audio chart options for a * series. */ sonification?: Highcharts.SeriesSonificationOptions; /** * (Highcharts, Highstock) A collection of options for different series * states. */ states?: Highcharts.SeriesStatesOptionsObject; /** * (Highcharts, Highstock) 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, Highstock) 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, Highstock) Pixel length of the stems. */ vectorLength?: number; /** * (Highcharts, Highstock) Set the initial visibility of the series. */ visible?: boolean; /** * (Highcharts, Highstock) Horizontal offset from the cartesian * position, in pixels. When the chart is inverted, this option allows * translation like yOffset in non inverted charts. */ xOffset?: number; /** * (Highcharts, Highstock) Vertical offset from the cartesian position, * in pixels. The default value makes sure the symbols don't overlap the * X axis when `onSeries` is `null`, and that they don't overlap the * linked series when `onSeries` is given. */ yOffset?: number; /** * (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) Whether to zoom non-cartesian series. If * `chart.zooming` is set, the option allows to disable zooming on an * individual non-cartesian series. By default zooming is enabled for * all series. * * **Note**: This option works only for non-cartesian series. */ zoomEnabled?: boolean; } /** * (Highcharts, Highstock) Animation when not hovering over the marker. */ interface PlotWindbarbStatesInactiveAnimationOptions { duration?: number; } /** * (Highcharts, Highstock) Positioning options for fixed tooltip, taking * effect only when tooltip.fixed is `true`. */ interface PlotWindbarbTooltipPositionOptions { /** * (Highcharts, Highstock) The horizontal alignment of the fixed * tooltip. */ align?: Highcharts.AlignValue; /** * (Highcharts, Highstock) What the fixed tooltip alignment should be * relative to. * * The default, `pane`, means that it is aligned within the plot area * for that given series. If the tooltip is split (as default in Stock * charts), each partial tooltip is aligned within the series' pane. */ relativeTo?: Highcharts.OptionsRelativeToValue; /** * (Highcharts, Highstock) The vertical alignment of the fixed tooltip. */ verticalAlign?: Highcharts.VerticalAlignValue; /** * (Highcharts, Highstock) X pixel offset from the given position. Can * be used to shy away from axis lines, grid lines etc to avoid the * tooltip overlapping other elements. */ x?: number; /** * (Highcharts, Highstock) Y pixel offset from the given position. Can * be used to shy away from axis lines, grid lines etc to avoid the * tooltip overlapping other elements. */ y?: number; } /** * (Highcharts, Highstock) Animation when hovering over the marker. */ interface SeriesWindbarbDataMarkerStatesHoverAnimationOptions { duration?: number; } }