123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818 |
- /**
- * @license Highcharts JS v9.1.1 (2021-06-04)
- *
- * Timeline series
- *
- * (c) 2010-2021 Highsoft AS
- * Author: Daniel Studencki
- *
- * License: www.highcharts.com/license
- */
- 'use strict';
- (function (factory) {
- if (typeof module === 'object' && module.exports) {
- factory['default'] = factory;
- module.exports = factory;
- } else if (typeof define === 'function' && define.amd) {
- define('highcharts/modules/timeline', ['highcharts'], function (Highcharts) {
- factory(Highcharts);
- factory.Highcharts = Highcharts;
- return factory;
- });
- } else {
- factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
- }
- }(function (Highcharts) {
- var _modules = Highcharts ? Highcharts._modules : {};
- function _registerModule(obj, path, args, fn) {
- if (!obj.hasOwnProperty(path)) {
- obj[path] = fn.apply(null, args);
- }
- }
- _registerModule(_modules, 'Series/Timeline/TimelinePoint.js', [_modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (SeriesRegistry, U) {
- /* *
- *
- * Timeline Series.
- *
- * (c) 2010-2021 Highsoft AS
- *
- * Author: Daniel Studencki
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var __extends = (this && this.__extends) || (function () {
- var extendStatics = function (d,
- b) {
- extendStatics = Object.setPrototypeOf ||
- ({ __proto__: [] } instanceof Array && function (d,
- b) { d.__proto__ = b; }) ||
- function (d,
- b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
- return extendStatics(d, b);
- };
- return function (d, b) {
- extendStatics(d, b);
- function __() { this.constructor = d; }
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
- };
- })();
- var Series = SeriesRegistry.series,
- PiePoint = SeriesRegistry.seriesTypes.pie.prototype.pointClass;
- var defined = U.defined,
- isNumber = U.isNumber,
- merge = U.merge,
- objectEach = U.objectEach,
- pick = U.pick;
- /* *
- *
- * Class
- *
- * */
- var TimelinePoint = /** @class */ (function (_super) {
- __extends(TimelinePoint, _super);
- function TimelinePoint() {
- /* *
- *
- * Properties
- *
- * */
- var _this = _super !== null && _super.apply(this,
- arguments) || this;
- _this.options = void 0;
- _this.series = void 0;
- return _this;
- /* eslint-enable valid-jsdoc */
- }
- /* *
- *
- * Functions
- *
- * */
- /* eslint-disable valid-jsdoc */
- TimelinePoint.prototype.alignConnector = function () {
- var point = this,
- series = point.series,
- connector = point.connector,
- dl = point.dataLabel,
- dlOptions = point.dataLabel.options = merge(series.options.dataLabels,
- point.options.dataLabels),
- chart = point.series.chart,
- bBox = connector.getBBox(),
- plotPos = {
- x: bBox.x + dl.translateX,
- y: bBox.y + dl.translateY
- },
- isVisible;
- // Include a half of connector width in order to run animation,
- // when connectors are aligned to the plot area edge.
- if (chart.inverted) {
- plotPos.y -= dl.options.connectorWidth / 2;
- }
- else {
- plotPos.x += dl.options.connectorWidth / 2;
- }
- isVisible = chart.isInsidePlot(plotPos.x, plotPos.y);
- connector[isVisible ? 'animate' : 'attr']({
- d: point.getConnectorPath()
- });
- if (!series.chart.styledMode) {
- connector.attr({
- stroke: dlOptions.connectorColor || point.color,
- 'stroke-width': dlOptions.connectorWidth,
- opacity: dl[defined(dl.newOpacity) ? 'newOpacity' : 'opacity']
- });
- }
- };
- TimelinePoint.prototype.drawConnector = function () {
- var point = this,
- series = point.series;
- if (!point.connector) {
- point.connector = series.chart.renderer
- .path(point.getConnectorPath())
- .attr({
- zIndex: -1
- })
- .add(point.dataLabel);
- }
- if (point.series.chart.isInsidePlot(// #10507
- point.dataLabel.x, point.dataLabel.y)) {
- point.alignConnector();
- }
- };
- TimelinePoint.prototype.getConnectorPath = function () {
- var point = this,
- chart = point.series.chart,
- xAxisLen = point.series.xAxis.len,
- inverted = chart.inverted,
- direction = inverted ? 'x2' : 'y2',
- dl = point.dataLabel,
- targetDLPos = dl.targetPosition,
- coords = {
- x1: point.plotX,
- y1: point.plotY,
- x2: point.plotX,
- y2: isNumber(targetDLPos.y) ? targetDLPos.y : dl.y
- },
- negativeDistance = ((dl.alignAttr || dl)[direction[0]] <
- point.series.yAxis.len / 2),
- path;
- // Recalculate coords when the chart is inverted.
- if (inverted) {
- coords = {
- x1: point.plotY,
- y1: xAxisLen - point.plotX,
- x2: targetDLPos.x || dl.x,
- y2: xAxisLen - point.plotX
- };
- }
- // Subtract data label width or height from expected coordinate so
- // that the connector would start from the appropriate edge.
- if (negativeDistance) {
- coords[direction] += dl[inverted ? 'width' : 'height'];
- }
- // Change coordinates so that they will be relative to data label.
- objectEach(coords, function (_coord, i) {
- coords[i] -= (dl.alignAttr || dl)[i[0]];
- });
- path = chart.renderer.crispLine([
- ['M', coords.x1, coords.y1],
- ['L', coords.x2, coords.y2]
- ], dl.options.connectorWidth);
- return path;
- };
- TimelinePoint.prototype.init = function () {
- var point = _super.prototype.init.apply(this,
- arguments);
- point.name = pick(point.name, 'Event');
- point.y = 1;
- return point;
- };
- TimelinePoint.prototype.isValid = function () {
- return this.options.y !== null;
- };
- TimelinePoint.prototype.setState = function () {
- var proceed = _super.prototype.setState;
- // Prevent triggering the setState method on null points.
- if (!this.isNull) {
- proceed.apply(this, arguments);
- }
- };
- TimelinePoint.prototype.setVisible = function (visible, redraw) {
- var point = this,
- series = point.series;
- redraw = pick(redraw, series.options.ignoreHiddenPoint);
- PiePoint.prototype.setVisible.call(point, visible, false);
- // Process new data
- series.processData();
- if (redraw) {
- series.chart.redraw();
- }
- };
- return TimelinePoint;
- }(Series.prototype.pointClass));
- /* *
- *
- * Default Export
- *
- * */
- return TimelinePoint;
- });
- _registerModule(_modules, 'Series/Timeline/TimelineSeries.js', [_modules['Mixins/LegendSymbol.js'], _modules['Core/Color/Palette.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Core/Renderer/SVG/SVGElement.js'], _modules['Series/Timeline/TimelinePoint.js'], _modules['Core/Utilities.js']], function (LegendSymbolMixin, palette, SeriesRegistry, SVGElement, TimelinePoint, U) {
- /* *
- *
- * Timeline Series.
- *
- * (c) 2010-2021 Highsoft AS
- *
- * Author: Daniel Studencki
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var __extends = (this && this.__extends) || (function () {
- var extendStatics = function (d,
- b) {
- extendStatics = Object.setPrototypeOf ||
- ({ __proto__: [] } instanceof Array && function (d,
- b) { d.__proto__ = b; }) ||
- function (d,
- b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
- return extendStatics(d, b);
- };
- return function (d, b) {
- extendStatics(d, b);
- function __() { this.constructor = d; }
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
- };
- })();
- var _a = SeriesRegistry.seriesTypes,
- ColumnSeries = _a.column,
- LineSeries = _a.line;
- var addEvent = U.addEvent,
- arrayMax = U.arrayMax,
- arrayMin = U.arrayMin,
- defined = U.defined,
- extend = U.extend,
- merge = U.merge,
- pick = U.pick;
- /* *
- *
- * Class
- *
- * */
- /**
- * The timeline series type.
- *
- * @private
- * @class
- * @name Highcharts.seriesTypes.timeline
- *
- * @augments Highcharts.Series
- */
- var TimelineSeries = /** @class */ (function (_super) {
- __extends(TimelineSeries, _super);
- function TimelineSeries() {
- /* *
- *
- * Static Properties
- *
- * */
- var _this = _super !== null && _super.apply(this,
- arguments) || this;
- /* *
- *
- * Properties
- *
- * */
- _this.data = void 0;
- _this.options = void 0;
- _this.points = void 0;
- _this.userOptions = void 0;
- _this.visibilityMap = void 0;
- return _this;
- /* eslint-enable valid-jsdoc */
- }
- /* *
- *
- * Functions
- *
- * */
- /* eslint-disable valid-jsdoc */
- TimelineSeries.prototype.alignDataLabel = function (point, dataLabel, _options, _alignTo) {
- var series = this,
- isInverted = series.chart.inverted,
- visiblePoints = series.visibilityMap.filter(function (point) {
- return point;
- }), visiblePointsCount = series.visiblePointsCount, pointIndex = visiblePoints.indexOf(point), isFirstOrLast = (!pointIndex || pointIndex === visiblePointsCount - 1), dataLabelsOptions = series.options.dataLabels, userDLOptions = point.userDLOptions || {},
- // Define multiplier which is used to calculate data label
- // width. If data labels are alternate, they have two times more
- // space to adapt (excepting first and last ones, which has only
- // one and half), than in case of placing all data labels side
- // by side.
- multiplier = dataLabelsOptions.alternate ?
- (isFirstOrLast ? 1.5 : 2) :
- 1, distance, availableSpace = Math.floor(series.xAxis.len / visiblePointsCount), pad = dataLabel.padding, targetDLWidth, styles;
- // Adjust data label width to the currently available space.
- if (point.visible) {
- distance = Math.abs(userDLOptions.x || point.options.dataLabels.x);
- if (isInverted) {
- targetDLWidth = ((distance - pad) * 2 - (point.itemHeight / 2));
- styles = {
- width: targetDLWidth + 'px',
- // Apply ellipsis when data label height is exceeded.
- textOverflow: dataLabel.width / targetDLWidth *
- dataLabel.height / 2 > availableSpace * multiplier ?
- 'ellipsis' : 'none'
- };
- }
- else {
- styles = {
- width: (userDLOptions.width ||
- dataLabelsOptions.width ||
- availableSpace * multiplier - (pad * 2)) + 'px'
- };
- }
- dataLabel.css(styles);
- if (!series.chart.styledMode) {
- dataLabel.shadow(dataLabelsOptions.shadow);
- }
- }
- _super.prototype.alignDataLabel.apply(series, arguments);
- };
- TimelineSeries.prototype.bindAxes = function () {
- var series = this;
- _super.prototype.bindAxes.call(series);
- ['xAxis', 'yAxis'].forEach(function (axis) {
- // Initially set the linked xAxis type to category.
- if (axis === 'xAxis' && !series[axis].userOptions.type) {
- series[axis].categories = series[axis].hasNames = true;
- }
- });
- };
- TimelineSeries.prototype.distributeDL = function () {
- var series = this,
- dataLabelsOptions = series.options.dataLabels,
- options,
- pointDLOptions,
- newOptions = {},
- visibilityIndex = 1,
- distance = dataLabelsOptions.distance;
- series.points.forEach(function (point) {
- if (point.visible && !point.isNull) {
- options = point.options;
- pointDLOptions = point.options.dataLabels;
- if (!series.hasRendered) {
- point.userDLOptions =
- merge({}, pointDLOptions);
- }
- newOptions[series.chart.inverted ? 'x' : 'y'] =
- dataLabelsOptions.alternate && visibilityIndex % 2 ?
- -distance : distance;
- options.dataLabels = merge(newOptions, point.userDLOptions);
- visibilityIndex++;
- }
- });
- };
- TimelineSeries.prototype.generatePoints = function () {
- var series = this;
- _super.prototype.generatePoints.apply(series);
- series.points.forEach(function (point, i) {
- point.applyOptions({
- x: series.xData[i]
- }, series.xData[i]);
- });
- };
- TimelineSeries.prototype.getVisibilityMap = function () {
- var series = this,
- map = (series.data.length ?
- series.data : series.userOptions.data).map(function (point) {
- return (point &&
- point.visible !== false &&
- !point.isNull) ? point : false;
- });
- return map;
- };
- TimelineSeries.prototype.getXExtremes = function (xData) {
- var series = this,
- filteredData = xData.filter(function (x,
- i) {
- return series.points[i].isValid() &&
- series.points[i].visible;
- });
- return {
- min: arrayMin(filteredData),
- max: arrayMax(filteredData)
- };
- };
- TimelineSeries.prototype.init = function () {
- var series = this;
- _super.prototype.init.apply(series, arguments);
- series.eventsToUnbind.push(addEvent(series, 'afterTranslate', function () {
- var lastPlotX,
- closestPointRangePx = Number.MAX_VALUE;
- series.points.forEach(function (point) {
- // Set the isInside parameter basing also on the real point
- // visibility, in order to avoid showing hidden points
- // in drawPoints method.
- point.isInside = point.isInside && point.visible;
- // New way of calculating closestPointRangePx value, which
- // respects the real point visibility is needed.
- if (point.visible && !point.isNull) {
- if (defined(lastPlotX)) {
- closestPointRangePx = Math.min(closestPointRangePx, Math.abs(point.plotX - lastPlotX));
- }
- lastPlotX = point.plotX;
- }
- });
- series.closestPointRangePx = closestPointRangePx;
- }));
- // Distribute data labels before rendering them. Distribution is
- // based on the 'dataLabels.distance' and 'dataLabels.alternate'
- // property.
- series.eventsToUnbind.push(addEvent(series, 'drawDataLabels', function () {
- // Distribute data labels basing on defined algorithm.
- series.distributeDL(); // @todo use this scope for series
- }));
- series.eventsToUnbind.push(addEvent(series, 'afterDrawDataLabels', function () {
- var dataLabel; // @todo use this scope for series
- // Draw or align connector for each point.
- series.points.forEach(function (point) {
- dataLabel = point.dataLabel;
- if (dataLabel) {
- // Within this wrap method is necessary to save the
- // current animation params, because the data label
- // target position (after animation) is needed to align
- // connectors.
- dataLabel.animate = function (params) {
- if (this.targetPosition) {
- this.targetPosition = params;
- }
- return SVGElement.prototype.animate.apply(this, arguments);
- };
- // Initialize the targetPosition field within data label
- // object. It's necessary because there is need to know
- // expected position of specific data label, when
- // aligning connectors. This field is overrided inside
- // of SVGElement.animate() wrapped method.
- if (!dataLabel.targetPosition) {
- dataLabel.targetPosition = {};
- }
- return point.drawConnector();
- }
- });
- }));
- series.eventsToUnbind.push(addEvent(series.chart, 'afterHideOverlappingLabel', function () {
- series.points.forEach(function (p) {
- if (p.connector &&
- p.dataLabel &&
- p.dataLabel.oldOpacity !== p.dataLabel.newOpacity) {
- p.alignConnector();
- }
- });
- }));
- };
- TimelineSeries.prototype.markerAttribs = function (point, state) {
- var series = this,
- seriesMarkerOptions = series.options.marker,
- seriesStateOptions,
- pointMarkerOptions = point.marker || {},
- symbol = (pointMarkerOptions.symbol || seriesMarkerOptions.symbol),
- pointStateOptions,
- width = pick(pointMarkerOptions.width,
- seriesMarkerOptions.width,
- series.closestPointRangePx),
- height = pick(pointMarkerOptions.height,
- seriesMarkerOptions.height),
- radius = 0,
- attribs;
- // Call default markerAttribs method, when the xAxis type
- // is set to datetime.
- if (series.xAxis.dateTime) {
- return _super.prototype.markerAttribs.call(this, point, state);
- }
- // Handle hover and select states
- if (state) {
- seriesStateOptions =
- seriesMarkerOptions.states[state] || {};
- pointStateOptions = pointMarkerOptions.states &&
- pointMarkerOptions.states[state] || {};
- radius = pick(pointStateOptions.radius, seriesStateOptions.radius, radius + (seriesStateOptions.radiusPlus || 0));
- }
- point.hasImage = (symbol && symbol.indexOf('url') === 0);
- attribs = {
- x: Math.floor(point.plotX) - (width / 2) - (radius / 2),
- y: point.plotY - (height / 2) - (radius / 2),
- width: width + radius,
- height: height + radius
- };
- return attribs;
- };
- TimelineSeries.prototype.processData = function () {
- var series = this,
- visiblePoints = 0,
- i;
- series.visibilityMap = series.getVisibilityMap();
- // Calculate currently visible points.
- series.visibilityMap.forEach(function (point) {
- if (point) {
- visiblePoints++;
- }
- });
- series.visiblePointsCount = visiblePoints;
- for (i = 0; i < series.xData.length; i++) {
- series.yData[i] = 1;
- }
- _super.prototype.processData.call(this, arguments);
- return;
- };
- /**
- * The timeline series presents given events along a drawn line.
- *
- * @sample highcharts/series-timeline/alternate-labels
- * Timeline series
- * @sample highcharts/series-timeline/inverted
- * Inverted timeline
- * @sample highcharts/series-timeline/datetime-axis
- * With true datetime axis
- *
- * @extends plotOptions.line
- * @since 7.0.0
- * @product highcharts
- * @excluding animationLimit, boostThreshold, connectEnds, connectNulls,
- * cropThreshold, dashStyle, findNearestPointBy,
- * getExtremesFromAll, lineWidth, negativeColor,
- * pointInterval, pointIntervalUnit, pointPlacement,
- * pointStart, softThreshold, stacking, step, threshold,
- * turboThreshold, zoneAxis, zones, dataSorting,
- * boostBlending
- * @requires modules/timeline
- * @optionparent plotOptions.timeline
- */
- TimelineSeries.defaultOptions = merge(LineSeries.defaultOptions, {
- colorByPoint: true,
- stickyTracking: false,
- ignoreHiddenPoint: true,
- /**
- * @ignore
- * @private
- */
- legendType: 'point',
- lineWidth: 4,
- tooltip: {
- headerFormat: '<span style="color:{point.color}">\u25CF</span> ' +
- '<span style="font-size: 10px"> {point.key}</span><br/>',
- pointFormat: '{point.description}'
- },
- states: {
- hover: {
- lineWidthPlus: 0
- }
- },
- /**
- * @declare Highcharts.TimelineDataLabelsOptionsObject
- *
- * @private
- */
- dataLabels: {
- enabled: true,
- allowOverlap: true,
- /**
- * Whether to position data labels alternately. For example, if
- * [distance](#plotOptions.timeline.dataLabels.distance)
- * is set equal to `100`, then data labels will be positioned
- * alternately (on both sides of the point) at a distance of 100px.
- *
- * @sample {highcharts} highcharts/series-timeline/alternate-disabled
- * Alternate disabled
- */
- alternate: true,
- backgroundColor: palette.backgroundColor,
- borderWidth: 1,
- borderColor: palette.neutralColor40,
- borderRadius: 3,
- color: palette.neutralColor80,
- /**
- * The color of the line connecting the data label to the point.
- * The default color is the same as the point's color.
- *
- * In styled mode, the connector stroke is given in the
- * `.highcharts-data-label-connector` class.
- *
- * @sample {highcharts} highcharts/series-timeline/connector-styles
- * Custom connector width and color
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @apioption plotOptions.timeline.dataLabels.connectorColor
- */
- /**
- * The width of the line connecting the data label to the point.
- *
- * In styled mode, the connector stroke width is given in the
- * `.highcharts-data-label-connector` class.
- *
- * @sample {highcharts} highcharts/series-timeline/connector-styles
- * Custom connector width and color
- */
- connectorWidth: 1,
- /**
- * A pixel value defining the distance between the data label and
- * the point. Negative numbers puts the label on top of the point.
- */
- distance: 100,
- // eslint-disable-next-line valid-jsdoc
- /**
- * @type {Highcharts.TimelineDataLabelsFormatterCallbackFunction}
- * @default function () {
- * let format;
- *
- * if (!this.series.chart.styledMode) {
- * format = '<span style="color:' + this.point.color +
- * '">● </span>';
- * } else {
- * format = '<span>● </span>';
- * }
- * format += '<span>' + (this.key || '') + '</span><br/>' +
- * (this.point.label || '');
- * return format;
- * }
- */
- formatter: function () {
- var format;
- if (!this.series.chart.styledMode) {
- format = '<span style="color:' + this.point.color +
- '">● </span>';
- }
- else {
- format = '<span>● </span>';
- }
- format += '<span class="highcharts-strong">' +
- (this.key || '') + '</span><br/>' +
- (this.point.label || '');
- return format;
- },
- style: {
- /** @internal */
- textOutline: 'none',
- /** @internal */
- fontWeight: 'normal',
- /** @internal */
- fontSize: '12px'
- },
- /**
- * Shadow options for the data label.
- *
- * @type {boolean|Highcharts.CSSObject}
- */
- shadow: false,
- /**
- * @type {number}
- * @apioption plotOptions.timeline.dataLabels.width
- */
- verticalAlign: 'middle'
- },
- marker: {
- enabledThreshold: 0,
- symbol: 'square',
- radius: 6,
- lineWidth: 2,
- height: 15
- },
- showInLegend: false,
- colorKey: 'x'
- });
- return TimelineSeries;
- }(LineSeries));
- extend(TimelineSeries.prototype, {
- // Use a simple symbol from LegendSymbolMixin
- drawLegendSymbol: LegendSymbolMixin.drawRectangle,
- // Use a group of trackers from TrackerMixin
- drawTracker: ColumnSeries.prototype.drawTracker,
- pointClass: TimelinePoint,
- trackerGroups: ['markerGroup', 'dataLabelsGroup']
- });
- SeriesRegistry.registerSeriesType('timeline', TimelineSeries);
- /* *
- *
- * Default Export
- *
- * */
- /* *
- *
- * API Declarations
- *
- * */
- /**
- * Callback JavaScript function to format the data label as a string. Note that
- * if a `format` is defined, the format takes precedence and the formatter is
- * ignored.
- *
- * @callback Highcharts.TimelineDataLabelsFormatterCallbackFunction
- *
- * @param {Highcharts.PointLabelObject|Highcharts.TimelineDataLabelsFormatterContextObject} this
- * Data label context to format
- *
- * @return {number|string|null|undefined}
- * Formatted data label text
- */
- /**
- * @interface Highcharts.TimelineDataLabelsFormatterContextObject
- * @extends Highcharts.PointLabelObject
- */ /**
- * @name Highcharts.TimelineDataLabelsFormatterContextObject#key
- * @type {string|undefined}
- */ /**
- * @name Highcharts.TimelineDataLabelsFormatterContextObject#point
- * @type {Highcharts.Point}
- */ /**
- * @name Highcharts.TimelineDataLabelsFormatterContextObject#series
- * @type {Highcharts.Series}
- */
- ''; // dettach doclets above
- /* *
- *
- * API Options
- *
- * */
- /**
- * The `timeline` series. If the [type](#series.timeline.type) option is
- * not specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends series,plotOptions.timeline
- * @excluding animationLimit, boostThreshold, connectEnds, connectNulls,
- * cropThreshold, dashStyle, dataParser, dataURL, findNearestPointBy,
- * getExtremesFromAll, lineWidth, negativeColor,
- * pointInterval, pointIntervalUnit, pointPlacement, pointStart,
- * softThreshold, stacking, stack, step, threshold, turboThreshold,
- * zoneAxis, zones, dataSorting, boostBlending
- * @product highcharts
- * @requires modules/timeline
- * @apioption series.timeline
- */
- /**
- * An array of data points for the series. For the `timeline` series type,
- * points can be given with three general parameters, `name`, `label`,
- * and `description`:
- *
- * Example:
- *
- * ```js
- * series: [{
- * type: 'timeline',
- * data: [{
- * name: 'Jan 2018',
- * label: 'Some event label',
- * description: 'Description to show in tooltip'
- * }]
- * }]
- * ```
- * If all points additionally have the `x` values, and xAxis type is set to
- * `datetime`, then events are laid out on a true time axis, where their
- * placement reflects the actual time between them.
- *
- * @sample {highcharts} highcharts/series-timeline/alternate-labels
- * Alternate labels
- * @sample {highcharts} highcharts/series-timeline/datetime-axis
- * Real time intervals
- *
- * @type {Array<*>}
- * @extends series.line.data
- * @excluding marker, y
- * @product highcharts
- * @apioption series.timeline.data
- */
- /**
- * The name of event.
- *
- * @type {string}
- * @product highcharts
- * @apioption series.timeline.data.name
- */
- /**
- * The label of event.
- *
- * @type {string}
- * @product highcharts
- * @apioption series.timeline.data.label
- */
- /**
- * The description of event. This description will be shown in tooltip.
- *
- * @type {string}
- * @product highcharts
- * @apioption series.timeline.data.description
- */
- ''; // adds doclets above to transpiled file
- return TimelineSeries;
- });
- _registerModule(_modules, 'masters/modules/timeline.src.js', [], function () {
- });
- }));
|