/* * * * (c) 2010-2021 Pawel Lysy * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ 'use strict'; 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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); import HLCPoint from './HLCPoint.js'; import SeriesRegistry from '../../Core/Series/SeriesRegistry.js'; var ColumnSeries = SeriesRegistry.seriesTypes.column; import U from '../../Core/Utilities.js'; var extend = U.extend, merge = U.merge; /* * * * Class * * */ /** * The hlc series type. * * @private * @class * @name Highcharts.seriesTypes.hlc * * @augments Highcharts.Series */ var HLCSeries = /** @class */ (function (_super) { __extends(HLCSeries, _super); function HLCSeries() { /* * * * 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.yData = void 0; return _this; /* eslint-enable valid-jsdoc */ } /* * * * Functions * * */ /* eslint-disable valid-jsdoc */ /** * Extend the path if close is not between high and low. * * @param {SVGPath} path the path array of the point * @param {number} halfStrokeWidth * @param {number} value value of the point to which the stem should be extended */ HLCSeries.prototype.extendStem = function (path, halfStrokeWidth, value) { var start = path[0]; var end = path[1]; // We don't need to worry about crisp - close value // is already crisped and halfStrokeWidth should remove it. if (typeof start[2] === 'number') { start[2] = Math.max(value + halfStrokeWidth, start[2]); } if (typeof end[2] === 'number') { end[2] = Math.min(value - halfStrokeWidth, end[2]); } }; /** * Function to create SVGPath of the point based on the * plot positions of this point. * @private */ HLCSeries.prototype.getPointPath = function (point, graphic) { // crisp vector coordinates var strokeWidth = graphic.strokeWidth(), series = point.series, crispCorr = (strokeWidth % 2) / 2, // #2596: crispX = Math.round(point.plotX) - crispCorr, halfWidth = Math.round(point.shapeArgs.width / 2); var path, plotClose = point.plotClose; // the vertical stem path = [ ['M', crispX, Math.round(point.yBottom)], ['L', crispX, Math.round(point.plotHigh)] ]; // close if (point.close !== null) { plotClose = Math.round(point.plotClose) + crispCorr; path.push(['M', crispX, plotClose], ['L', crispX + halfWidth, plotClose]); series.extendStem(path, strokeWidth / 2, plotClose); } return path; }; /** * Draw single point * @private */ HLCSeries.prototype.drawSinglePoint = function (point) { var series = point.series, chart = series.chart; var path, graphic = point.graphic, isNew = !graphic; if (typeof point.plotY !== 'undefined') { // Create and/or update the graphic if (!graphic) { point.graphic = graphic = chart.renderer.path() .add(series.group); } if (!chart.styledMode) { graphic.attr(series.pointAttribs(point, (point.selected && 'select'))); // #3897 } // crisp vector coordinates path = series.getPointPath(point, graphic); graphic[isNew ? 'attr' : 'animate']({ d: path }) .addClass(point.getClassName(), true); } }; /** * Draw the data points * @private */ HLCSeries.prototype.drawPoints = function () { this.points.forEach(this.drawSinglePoint); }; /** * @private * @function Highcharts.seriesTypes.hlc#init */ HLCSeries.prototype.init = function () { _super.prototype.init.apply(this, arguments); this.options.stacking = void 0; // #8817 }; /** * Postprocess mapping between options and SVG attributes * @private */ HLCSeries.prototype.pointAttribs = function (point, state) { var attribs = _super.prototype.pointAttribs.call(this, point, state); delete attribs.fill; return attribs; }; HLCSeries.prototype.toYData = function (point) { // return a plain array for speedy calculation return [point.high, point.low, point.close]; }; /** * Translate data points from raw values x and y to plotX and plotY * * @private * @function Highcharts.seriesTypes.hlc#translate */ HLCSeries.prototype.translate = function () { var series = this, yAxis = series.yAxis, names = (this.pointArrayMap && this.pointArrayMap.slice()) || [], translated = names.map(function (name) { return "plot".concat(name.charAt(0).toUpperCase() + name.slice(1)); }); translated.push('yBottom'); names.push('low'); _super.prototype.translate.apply(series); // Do the translation series.points.forEach(function (point) { names.forEach(function (name, i) { var value = point[name]; if (value !== null) { if (series.dataModify) { value = series.dataModify.modifyValue(value); } point[translated[i]] = yAxis.toPixels(value, true); } }); // Align the tooltip to the high value to avoid covering the // point point.tooltipPos[1] = point.plotHigh + yAxis.pos - series.chart.plotTop; }); }; /** * An HLC chart is a style of financial chart used to describe price * movements over time. It displays high, low and close values per * data point. * * @sample stock/demo/hlc/ * HLC chart * * @extends plotOptions.column * @excluding borderColor, borderRadius, borderWidth, crisp, stacking, * stack * @product highstock * @optionparent plotOptions.hlc */ HLCSeries.defaultOptions = merge(ColumnSeries.defaultOptions, { /** * The approximate pixel width of each group. If for example a series * with 30 points is displayed over a 600 pixel wide plot area, no * grouping is performed. If however the series contains so many points * that the spacing is less than the groupPixelWidth, Highcharts will * try to group it into appropriate groups so that each is more or less * two pixels wide. Defaults to `5`. * * @type {number} * @default 5 * @product highstock * @apioption plotOptions.hlc.dataGrouping.groupPixelWidth */ /** * @type {Highcharts.DataGroupingApproximationValue|Function} * @default hlc * @product highstock * @apioption plotOptions.hlc.dataGrouping.approximation */ /** * @default close * @apioption plotOptions.hlc.colorKey */ /** * The pixel width of the line/border. Defaults to `1`. * * @sample {highstock} stock/plotoptions/hlc-linewidth/ * A greater line width * * @type {number} * @default 1 * @product highstock * * @public */ lineWidth: 1, tooltip: { pointFormat: '\u25CF ' + ' {series.name}
' + 'High: {point.high}
' + 'Low: {point.low}
' + 'Close: {point.close}
' }, threshold: null, states: { /** * @extends plotOptions.column.states.hover * @product highstock */ hover: { /** * The pixel width of the line representing the HLC point. * * @type {number} * @default 3 * @product highstock */ lineWidth: 3 } }, /** * Determines which one of `high`, `low`, `close` values should * be represented as `point.y`, which is later used to set dataLabel * position and [compare](#plotOptions.series.compare). * * @sample {highstock} stock/plotoptions/hlc-pointvalkey/ * Possible values * * @type {string} * @default close * @validvalue ["high", "low", "close"] * @product highstock * @apioption plotOptions.hlc.pointValKey */ /** * @default close * @apioption plotOptions.hlc.colorKey */ stickyTracking: true }); return HLCSeries; }(ColumnSeries)); extend(HLCSeries.prototype, { animate: null, directTouch: false, pointArrayMap: ['high', 'low', 'close'], pointAttrToOptions: { stroke: 'color', 'stroke-width': 'lineWidth' }, pointValKey: 'close' }); HLCSeries.prototype.pointClass = HLCPoint; SeriesRegistry.registerSeriesType('hlc', HLCSeries); /* * * * Default Export * * */ export default HLCSeries; /* * * * API Options * * */ /** * A `hlc` series. If the [type](#series.hlc.type) option is not * specified, it is inherited from [chart.type](#chart.type). * * @extends series,plotOptions.hlc * @excluding dataParser, dataURL * @product highstock * @apioption series.hlc */ /** * An array of data points for the series. For the `hlc` series type, * points can be given in the following ways: * * 1. An array of arrays with 4 or 3 values. In this case, the values correspond * to `x,high,low,close`. If the first value is a string, it is applied * as the name of the point, and the `x` value is inferred. The `x` value can * also be omitted, in which case the inner arrays should be of length of 3\. * Then the `x` value is automatically calculated, either starting at 0 and * incremented by 1, or from `pointStart` and `pointInterval` given in the * series options. * ```js * data: [ * [0, 5, 6, 7], * [1, 4, 8, 2], * [2, 3, 4, 10] * ] * ``` * * 2. An array of objects with named values. The following snippet shows only a * few settings, see the complete options set below. If the total number of * data points exceeds the series' * [turboThreshold](#series.hlc.turboThreshold), this option is not * available. * ```js * data: [{ * x: 1, * high: 4, * low: 5, * close: 2, * name: "Point2", * color: "#00FF00" * }, { * x: 1, * high: 3, * low: 6, * close: 7, * name: "Point1", * color: "#FF00FF" * }] * ``` * * @type {Array|Array<(number|string),number,number,number>|*>} * @extends series.arearange.data * @excluding y, marker * @product highstock * @apioption series.hlc.data */ /** * The closing value of each data point. * * @type {number} * @product highstock * @apioption series.hlc.data.close */ ''; // adds doclets above to transpilat