743 lines
33 KiB
TypeScript
743 lines
33 KiB
TypeScript
|
/*!*
|
||
|
|
*
|
||
|
|
* Copyright (c) Highsoft AS. All rights reserved.
|
||
|
|
*
|
||
|
|
*!*/
|
||
|
|
import * as Highcharts from "../highcharts.src";
|
||
|
|
declare module "../highcharts.src" {
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Point accessibility options for a series.
|
||
|
|
*/
|
||
|
|
interface PlotTilemapAccessibilityPointOptions {
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) Formatter function to determine the date/time
|
||
|
|
* format used with points on datetime axes when describing them to
|
||
|
|
* screen reader users. Receives one argument, `point`, referring to the
|
||
|
|
* point to describe. Should return a date format string compatible with
|
||
|
|
* dateFormat.
|
||
|
|
*/
|
||
|
|
dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Whether or not to describe points with the
|
||
|
|
* value `null` to assistive technology, such as screen readers.
|
||
|
|
*/
|
||
|
|
describeNull?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) Formatter function to use instead of the
|
||
|
|
* default for point descriptions. Same as
|
||
|
|
* `accessibility.point.descriptionFormatter`, but applies to a series
|
||
|
|
* instead of the whole chart.
|
||
|
|
*
|
||
|
|
* Note: Prefer using accessibility.point.valueDescriptionFormat instead
|
||
|
|
* if possible, as default functionality such as describing annotations
|
||
|
|
* will be preserved.
|
||
|
|
*/
|
||
|
|
descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Decimals to use for the values in the point
|
||
|
|
* descriptions. Uses tooltip.valueDecimals if not defined.
|
||
|
|
*/
|
||
|
|
valueDecimals?: number;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) Prefix to add to the values in the point
|
||
|
|
* descriptions. Uses tooltip.valuePrefix if not defined.
|
||
|
|
*/
|
||
|
|
valuePrefix?: string;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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 PlotTilemapDataLabelsOptions {
|
||
|
|
/**
|
||
|
|
* (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?: (Highcharts.AlignValue|null);
|
||
|
|
/**
|
||
|
|
* (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.PlotTilemapDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
|
||
|
|
/**
|
||
|
|
* (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?: 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 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, Highmaps) Options for the _Series on point_ feature. Only
|
||
|
|
* `pie` and `sunburst` series are supported at this moment.
|
||
|
|
*/
|
||
|
|
interface PlotTilemapOnPointOptions {
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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.PlotTilemapOnPointConnectorOptions|Highcharts.SVGAttributes);
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) Options allowing to set a position and an
|
||
|
|
* offset of the series in the _Series on point_ feature.
|
||
|
|
*/
|
||
|
|
position?: (object|Highcharts.PlotTilemapOnPointPositionOptions);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) A tilemap series is a type of heatmap where the
|
||
|
|
* tile shapes are configurable.
|
||
|
|
*
|
||
|
|
* 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 `tilemap` series are defined in plotOptions.tilemap.
|
||
|
|
*
|
||
|
|
* 3. Options for one single series are given in the series instance array.
|
||
|
|
* (see online documentation for example)
|
||
|
|
*/
|
||
|
|
interface PlotTilemapOptions {
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Accessibility options for a series.
|
||
|
|
*/
|
||
|
|
accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) Animation is disabled by default on the
|
||
|
|
* heatmap series.
|
||
|
|
*/
|
||
|
|
animation?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highmaps) The border color of the map areas.
|
||
|
|
*
|
||
|
|
* In styled mode, the border stroke is given in the `.highcharts-point`
|
||
|
|
* class.
|
||
|
|
*/
|
||
|
|
borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) The border radius for each heatmap item. The
|
||
|
|
* border's color and width can be set in marker options.
|
||
|
|
*/
|
||
|
|
borderRadius?: number;
|
||
|
|
/**
|
||
|
|
* (Highmaps) The border width for each heatmap item.
|
||
|
|
*/
|
||
|
|
borderWidth?: number;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) 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 heat maps this color is
|
||
|
|
* rarely used, as we mostly use the color to denote the value of each
|
||
|
|
* point. Unless options are set in the colorAxis, the default value is
|
||
|
|
* pulled from the options.colors array.
|
||
|
|
*/
|
||
|
|
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, Highmaps) 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) The column size - how many X axis units each
|
||
|
|
* column in the tilemap should span. Works as in Heatmaps.
|
||
|
|
*/
|
||
|
|
colsize?: number;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highstock, Gantt) When true, each point or column edge
|
||
|
|
* is rounded to its nearest pixel in order to render sharp on screen.
|
||
|
|
* In some cases, when there are a lot of densely packed columns, this
|
||
|
|
* leads to visible difference in column widths or distance between
|
||
|
|
* columns. In these cases, setting `crisp` to `false` may look better,
|
||
|
|
* even though each column is rendered blurry.
|
||
|
|
*/
|
||
|
|
crisp?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) A reserved subspace to store options and
|
||
|
|
* values for customized functionality. Here you can add additional data
|
||
|
|
* for your own event callbacks and formatter callbacks.
|
||
|
|
*/
|
||
|
|
custom?: Highcharts.Dictionary<any>;
|
||
|
|
/**
|
||
|
|
* (Highcharts, 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.PlotTilemapDataLabelsOptions|Array<Highcharts.PlotTilemapDataLabelsOptions>);
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) A description of the series to add to the
|
||
|
|
* screen reader information about the series.
|
||
|
|
*/
|
||
|
|
description?: string;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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) 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, Highmaps) 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, Highmaps) 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, Highmaps) Make the heatmap render its data points as an
|
||
|
|
* interpolated image.
|
||
|
|
*/
|
||
|
|
interpolation?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) An array specifying which option maps to which
|
||
|
|
* key in the data point array. This makes it convenient to work with
|
||
|
|
* unstructured data arrays from different sources.
|
||
|
|
*/
|
||
|
|
keys?: Array<string>;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highstock, Gantt) Series labels are placed as close to
|
||
|
|
* the series as possible in a natural way, seeking to avoid other
|
||
|
|
* series. The goal of this feature is to make the chart more easily
|
||
|
|
* readable, like if a human designer placed the labels in the optimal
|
||
|
|
* position.
|
||
|
|
*
|
||
|
|
* The series labels currently work with series types having a `graph`
|
||
|
|
* or an `area`.
|
||
|
|
*/
|
||
|
|
label?: Highcharts.SeriesLabelOptionsObject;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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;
|
||
|
|
marker?: any;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) The color applied to null points. In styled
|
||
|
|
* mode, a general CSS class is applied instead.
|
||
|
|
*/
|
||
|
|
nullColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Options for the _Series on point_ feature.
|
||
|
|
* Only `pie` and `sunburst` series are supported at this moment.
|
||
|
|
*/
|
||
|
|
onPoint?: (object|Highcharts.PlotTilemapOnPointOptions);
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Opacity of a series parts: line, fill (e.g.
|
||
|
|
* area) and dataLabels.
|
||
|
|
*/
|
||
|
|
opacity?: number;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Properties for each single point.
|
||
|
|
*/
|
||
|
|
point?: Highcharts.PlotSeriesPointOptions;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Same as accessibility.point.descriptionFormat,
|
||
|
|
* but for an individual series. Overrides the chart wide configuration.
|
||
|
|
*/
|
||
|
|
pointDescriptionFormat?: Function;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Same as
|
||
|
|
* accessibility.series.descriptionFormatter, but for an individual
|
||
|
|
* series. Overrides the chart wide configuration.
|
||
|
|
*/
|
||
|
|
pointDescriptionFormatter?: Function;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) The padding between points in the tilemap.
|
||
|
|
*/
|
||
|
|
pointPadding?: 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, Highmaps) The row size - how many Y axis units each
|
||
|
|
* tilemap row should span. Analogous to colsize.
|
||
|
|
*/
|
||
|
|
rowsize?: number;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) 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, Highmaps) 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. 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, Highmaps) If set to `true`, the accessibility module
|
||
|
|
* will skip past the points in this series for keyboard navigation.
|
||
|
|
*/
|
||
|
|
skipKeyboardNavigation?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highmaps) Sonification/audio chart options for a series.
|
||
|
|
*/
|
||
|
|
sonification?: Highcharts.SeriesSonificationOptions;
|
||
|
|
states?: Highcharts.SeriesStatesOptionsObject;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highstock, 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, Highmaps) The shape of the tiles in the tilemap.
|
||
|
|
* Possible values are `hexagon`, `circle`, `diamond`, and `square`.
|
||
|
|
*/
|
||
|
|
tileShape?: Highcharts.TilemapShapeValue;
|
||
|
|
/**
|
||
|
|
* (Highcharts, Highstock, Highmaps) A configuration object for the
|
||
|
|
* tooltip rendering of each single series. Properties are inherited
|
||
|
|
* from tooltip. Overridable properties are `headerFormat`,
|
||
|
|
* `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
|
||
|
|
* Unlike other series, in a scatter plot the series.name by default
|
||
|
|
* shows in the headerFormat and point.x and point.y in the pointFormat.
|
||
|
|
*/
|
||
|
|
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, Highmaps) Set the initial visibility of the series.
|
||
|
|
*/
|
||
|
|
visible?: boolean;
|
||
|
|
/**
|
||
|
|
* (Highmaps) Define the z index of the series.
|
||
|
|
*/
|
||
|
|
zIndex?: 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.SeriesZonesOptionsObject>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* (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 SeriesTilemapDataDataLabelsAnimationOptions {
|
||
|
|
/**
|
||
|
|
* (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;
|
||
|
|
}
|
||
|
|
}
|