tupali/librerias/gantt/code/es-modules/modules/parallel-coordinates.src.js

452 lines
16 KiB
JavaScript
Raw Normal View History

2020-05-23 20:45:54 +00:00
/* *
*
* Parallel coordinates module
*
* (c) 2010-2020 Pawel Fus
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
'use strict';
import Axis from '../parts/Axis.js';
import H from '../parts/Globals.js';
import U from '../parts/Utilities.js';
var addEvent = U.addEvent, arrayMax = U.arrayMax, arrayMin = U.arrayMin, defined = U.defined, erase = U.erase, extend = U.extend, format = U.format, merge = U.merge, pick = U.pick, splat = U.splat, wrap = U.wrap;
import '../parts/Chart.js';
import '../parts/Series.js';
// Extensions for parallel coordinates plot.
var Chart = H.Chart, ChartProto = Chart.prototype;
var defaultXAxisOptions = {
lineWidth: 0,
tickLength: 0,
opposite: true,
type: 'category'
};
/* eslint-disable valid-jsdoc */
/**
* @optionparent chart
*/
var defaultParallelOptions = {
/**
* Flag to render charts as a parallel coordinates plot. In a parallel
* coordinates plot (||-coords) by default all required yAxes are generated
* and the legend is disabled. This feature requires
* `modules/parallel-coordinates.js`.
*
* @sample {highcharts} /highcharts/demo/parallel-coordinates/
* Parallel coordinates demo
* @sample {highcharts} highcharts/parallel-coordinates/polar/
* Star plot, multivariate data in a polar chart
*
* @since 6.0.0
* @product highcharts
* @requires modules/parallel-coordinates
*/
parallelCoordinates: false,
/**
* Common options for all yAxes rendered in a parallel coordinates plot.
* This feature requires `modules/parallel-coordinates.js`.
*
* The default options are:
* ```js
* parallelAxes: {
* lineWidth: 1, // classic mode only
* gridlinesWidth: 0, // classic mode only
* title: {
* text: '',
* reserveSpace: false
* },
* labels: {
* x: 0,
* y: 0,
* align: 'center',
* reserveSpace: false
* },
* offset: 0
* }
* ```
*
* @sample {highcharts} highcharts/parallel-coordinates/parallelaxes/
* Set the same tickAmount for all yAxes
*
* @extends yAxis
* @since 6.0.0
* @product highcharts
* @excluding alternateGridColor, breaks, id, gridLineColor,
* gridLineDashStyle, gridLineWidth, minorGridLineColor,
* minorGridLineDashStyle, minorGridLineWidth, plotBands,
* plotLines, angle, gridLineInterpolation, maxColor, maxZoom,
* minColor, scrollbar, stackLabels, stops
* @requires modules/parallel-coordinates
*/
parallelAxes: {
lineWidth: 1,
/**
* Titles for yAxes are taken from
* [xAxis.categories](#xAxis.categories). All options for `xAxis.labels`
* applies to parallel coordinates titles. For example, to style
* categories, use [xAxis.labels.style](#xAxis.labels.style).
*
* @excluding align, enabled, margin, offset, position3d, reserveSpace,
* rotation, skew3d, style, text, useHTML, x, y
*/
title: {
text: '',
reserveSpace: false
},
labels: {
x: 0,
y: 4,
align: 'center',
reserveSpace: false
},
offset: 0
}
};
H.setOptions({
chart: defaultParallelOptions
});
/**
* Support for parallel axes.
* @private
* @class
*/
var ParallelAxisAdditions = /** @class */ (function () {
/* *
*
* Constructors
*
* */
function ParallelAxisAdditions(axis) {
this.axis = axis;
}
/* *
*
* Functions
*
* */
/**
* Set predefined left+width and top+height (inverted) for yAxes.
* This method modifies options param.
*
* @private
*
* @param {Array<string>} axisPosition
* ['left', 'width', 'height', 'top'] or ['top', 'height', 'width', 'left']
* for an inverted chart.
*
* @param {Highcharts.AxisOptions} options
* Axis options.
*/
ParallelAxisAdditions.prototype.setPosition = function (axisPosition, options) {
var parallel = this;
var axis = parallel.axis;
var chart = axis.chart;
var fraction = ((parallel.position || 0) + 0.5) /
(chart.parallelInfo.counter + 1);
if (chart.polar) {
options.angle = 360 * fraction;
}
else {
options[axisPosition[0]] = 100 * fraction + '%';
axis[axisPosition[1]] =
options[axisPosition[1]] = 0;
// In case of chart.update(inverted), remove old options:
axis[axisPosition[2]] =
options[axisPosition[2]] = null;
axis[axisPosition[3]] =
options[axisPosition[3]] = null;
}
};
return ParallelAxisAdditions;
}());
/**
* Axis with parallel support.
* @private
* @class
*/
var ParallelAxis = /** @class */ (function () {
function ParallelAxis() {
}
/**
* Adds support for parallel axes.
* @private
*/
ParallelAxis.compose = function (AxisClass) {
/* eslint-disable no-invalid-this */
// On update, keep parallel additions.
AxisClass.keepProps.push('parallel');
// Add parallel addition
addEvent(AxisClass, 'init', function () {
var axis = this;
if (!axis.parallelCoordinates) {
axis.parallelCoordinates = new ParallelAxisAdditions(axis);
}
});
// Update default options with predefined for a parallel coords.
addEvent(AxisClass, 'afterSetOptions', function (e) {
var axis = this;
var chart = axis.chart;
var parallelCoordinates = axis.parallelCoordinates;
var axisPosition = ['left', 'width', 'height', 'top'];
if (chart.hasParallelCoordinates) {
if (chart.inverted) {
axisPosition = axisPosition.reverse();
}
if (axis.isXAxis) {
axis.options = merge(axis.options, defaultXAxisOptions, e.userOptions);
}
else {
axis.options = merge(axis.options, axis.chart.options.chart.parallelAxes, e.userOptions);
parallelCoordinates.position = pick(parallelCoordinates.position, chart.yAxis.length);
parallelCoordinates.setPosition(axisPosition, axis.options);
}
}
});
// Each axis should gather extremes from points on a particular position
// in series.data. Not like the default one, which gathers extremes from
// all series bind to this axis. Consider using series.points instead of
// series.yData.
addEvent(AxisClass, 'getSeriesExtremes', function (e) {
var axis = this;
var chart = axis.chart;
var parallelCoordinates = axis.parallelCoordinates;
if (!parallelCoordinates) {
return;
}
if (chart && chart.hasParallelCoordinates && !axis.isXAxis) {
var index = parallelCoordinates.position, currentPoints = [];
axis.series.forEach(function (series) {
if (series.visible &&
defined(series.yData[index])) {
// We need to use push() beacause of null points
currentPoints.push(series.yData[index]);
}
});
axis.dataMin = arrayMin(currentPoints);
axis.dataMax = arrayMax(currentPoints);
e.preventDefault();
}
});
/* eslint-enable no-invalid-this */
};
return ParallelAxis;
}());
ParallelAxis.compose(Axis);
export default ParallelAxis;
/* eslint-disable no-invalid-this */
// Initialize parallelCoordinates
addEvent(Chart, 'init', function (e) {
var options = e.args[0], defaultyAxis = splat(options.yAxis || {}), yAxisLength = defaultyAxis.length, newYAxes = [];
/**
* Flag used in parallel coordinates plot to check if chart has ||-coords
* (parallel coords).
*
* @requires module:modules/parallel-coordinates
*
* @name Highcharts.Chart#hasParallelCoordinates
* @type {boolean}
*/
this.hasParallelCoordinates = options.chart &&
options.chart.parallelCoordinates;
if (this.hasParallelCoordinates) {
this.setParallelInfo(options);
// Push empty yAxes in case user did not define them:
for (; yAxisLength <= this.parallelInfo.counter; yAxisLength++) {
newYAxes.push({});
}
if (!options.legend) {
options.legend = {};
}
if (typeof options.legend.enabled === 'undefined') {
options.legend.enabled = false;
}
merge(true, options,
// Disable boost
{
boost: {
seriesThreshold: Number.MAX_VALUE
},
plotOptions: {
series: {
boostThreshold: Number.MAX_VALUE
}
}
});
options.yAxis = defaultyAxis.concat(newYAxes);
options.xAxis = merge(defaultXAxisOptions, // docs
splat(options.xAxis || {})[0]);
}
});
// Initialize parallelCoordinates
addEvent(Chart, 'update', function (e) {
var options = e.options;
if (options.chart) {
if (defined(options.chart.parallelCoordinates)) {
this.hasParallelCoordinates = options.chart.parallelCoordinates;
}
this.options.chart.parallelAxes = merge(this.options.chart.parallelAxes, options.chart.parallelAxes);
}
if (this.hasParallelCoordinates) {
// (#10081)
if (options.series) {
this.setParallelInfo(options);
}
this.yAxis.forEach(function (axis) {
axis.update({}, false);
});
}
});
/* eslint-disable valid-jsdoc */
extend(ChartProto, /** @lends Highcharts.Chart.prototype */ {
/**
* Define how many parellel axes we have according to the longest dataset.
* This is quite heavy - loop over all series and check series.data.length
* Consider:
*
* - make this an option, so user needs to set this to get better
* performance
*
* - check only first series for number of points and assume the rest is the
* same
*
* @private
* @function Highcharts.Chart#setParallelInfo
* @param {Highcharts.Options} options
* User options
* @return {void}
* @requires modules/parallel-coordinates
*/
setParallelInfo: function (options) {
var chart = this, seriesOptions = options.series;
chart.parallelInfo = {
counter: 0
};
seriesOptions.forEach(function (series) {
if (series.data) {
chart.parallelInfo.counter = Math.max(chart.parallelInfo.counter, series.data.length - 1);
}
});
}
});
// Bind each series to each yAxis. yAxis needs a reference to all series to
// calculate extremes.
addEvent(H.Series, 'bindAxes', function (e) {
if (this.chart.hasParallelCoordinates) {
var series = this;
this.chart.axes.forEach(function (axis) {
series.insert(axis.series);
axis.isDirty = true;
});
series.xAxis = this.chart.xAxis[0];
series.yAxis = this.chart.yAxis[0];
e.preventDefault();
}
});
// Translate each point using corresponding yAxis.
addEvent(H.Series, 'afterTranslate', function () {
var series = this, chart = this.chart, points = series.points, dataLength = points && points.length, closestPointRangePx = Number.MAX_VALUE, lastPlotX, point, i;
if (this.chart.hasParallelCoordinates) {
for (i = 0; i < dataLength; i++) {
point = points[i];
if (defined(point.y)) {
if (chart.polar) {
point.plotX = chart.yAxis[i].angleRad || 0;
}
else if (chart.inverted) {
point.plotX = (chart.plotHeight -
chart.yAxis[i].top +
chart.plotTop);
}
else {
point.plotX = chart.yAxis[i].left - chart.plotLeft;
}
point.clientX = point.plotX;
point.plotY = chart.yAxis[i]
.translate(point.y, false, true, null, true);
if (typeof lastPlotX !== 'undefined') {
closestPointRangePx = Math.min(closestPointRangePx, Math.abs(point.plotX - lastPlotX));
}
lastPlotX = point.plotX;
point.isInside = chart.isInsidePlot(point.plotX, point.plotY, chart.inverted);
}
else {
point.isNull = true;
}
}
this.closestPointRangePx = closestPointRangePx;
}
}, { order: 1 });
// On destroy, we need to remove series from each axis.series
addEvent(H.Series, 'destroy', function () {
if (this.chart.hasParallelCoordinates) {
(this.chart.axes || []).forEach(function (axis) {
if (axis && axis.series) {
erase(axis.series, this);
axis.isDirty = axis.forceRedraw = true;
}
}, this);
}
});
/**
* @private
*/
function addFormattedValue(proceed) {
var chart = this.series && this.series.chart, config = proceed.apply(this, Array.prototype.slice.call(arguments, 1)), formattedValue, yAxisOptions, labelFormat, yAxis;
if (chart &&
chart.hasParallelCoordinates &&
!defined(config.formattedValue)) {
yAxis = chart.yAxis[this.x];
yAxisOptions = yAxis.options;
labelFormat = pick(
/**
* Parallel coordinates only. Format that will be used for point.y
* and available in [tooltip.pointFormat](#tooltip.pointFormat) as
* `{point.formattedValue}`. If not set, `{point.formattedValue}`
* will use other options, in this order:
*
* 1. [yAxis.labels.format](#yAxis.labels.format) will be used if
* set
*
* 2. If yAxis is a category, then category name will be displayed
*
* 3. If yAxis is a datetime, then value will use the same format as
* yAxis labels
*
* 4. If yAxis is linear/logarithmic type, then simple value will be
* used
*
* @sample {highcharts}
* /highcharts/parallel-coordinates/tooltipvalueformat/
* Different tooltipValueFormats's
*
* @type {string}
* @default undefined
* @since 6.0.0
* @product highcharts
* @requires modules/parallel-coordinates
* @apioption yAxis.tooltipValueFormat
*/
yAxisOptions.tooltipValueFormat, yAxisOptions.labels.format);
if (labelFormat) {
formattedValue = format(labelFormat, extend(this, { value: this.y }), chart);
}
else if (yAxis.dateTime) {
formattedValue = chart.time.dateFormat(chart.time.resolveDTLFormat(yAxisOptions.dateTimeLabelFormats[yAxis.tickPositions.info.unitName]).main, this.y);
}
else if (yAxisOptions.categories) {
formattedValue = yAxisOptions.categories[this.y];
}
else {
formattedValue = this.y;
}
config.formattedValue = config.point.formattedValue = formattedValue;
}
return config;
}
['line', 'spline'].forEach(function (seriesName) {
wrap(H.seriesTypes[seriesName].prototype.pointClass.prototype, 'getLabelConfig', addFormattedValue);
});