/* * * (c) 2010-2019 Torstein Honsi * * Scatter 3D series. * * License: www.highcharts.com/license */ 'use strict'; import H from '../parts/Globals.js'; import '../parts/Utilities.js'; var Point = H.Point, seriesType = H.seriesType, seriesTypes = H.seriesTypes; /** * @private * @class * @name Highcharts.seriesTypes.scatter3d * * @augments Highcharts.Series */ seriesType( 'scatter3d', 'scatter', /** * A 3D scatter plot uses x, y and z coordinates to display values for three * variables for a set of data. * * @sample {highcharts} highcharts/3d/scatter/ * Simple 3D scatter * @sample {highcharts} highcharts/demo/3d-scatter-draggable * Draggable 3d scatter * * @extends plotOptions.scatter * @product highcharts * @optionparent plotOptions.scatter3d */ { tooltip: { pointFormat: 'x: {point.x}
y: {point.y}
z: {point.z}
' } // Series class }, { pointAttribs: function (point) { var attribs = seriesTypes.scatter.prototype.pointAttribs .apply(this, arguments); if (this.chart.is3d() && point) { attribs.zIndex = H.pointCameraDistance(point, this.chart); } return attribs; }, axisTypes: ['xAxis', 'yAxis', 'zAxis'], pointArrayMap: ['x', 'y', 'z'], parallelArrays: ['x', 'y', 'z'], // Require direct touch rather than using the k-d-tree, because the // k-d-tree currently doesn't take the xyz coordinate system into // account (#4552) directTouch: true // Point class }, { applyOptions: function () { Point.prototype.applyOptions.apply(this, arguments); if (this.z === undefined) { this.z = 0; } return this; } } ); /** * A `scatter3d` series. If the [type](#series.scatter3d.type) option is * not specified, it is inherited from [chart.type](#chart.type). * * scatter3d](#plotOptions.scatter3d). * * @extends series,plotOptions.scatter3d * @product highcharts * @apioption series.scatter3d */ /** * An array of data points for the series. For the `scatter3d` series * type, points can be given in the following ways: * * 1. An array of arrays with 3 values. In this case, the values correspond * to `x,y,z`. If the first value is a string, it is applied as the name * of the point, and the `x` value is inferred. * * ```js * data: [ * [0, 0, 1], * [1, 8, 7], * [2, 9, 2] * ] * ``` * * 3. 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.scatter3d.turboThreshold), this option is not * available. * * ```js * data: [{ * x: 1, * y: 2, * z: 24, * name: "Point2", * color: "#00FF00" * }, { * x: 1, * y: 4, * z: 12, * name: "Point1", * color: "#FF00FF" * }] * ``` * * @sample {highcharts} highcharts/chart/reflow-true/ * Numerical values * @sample {highcharts} highcharts/series/data-array-of-arrays/ * Arrays of numeric x and y * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/ * Arrays of datetime x and y * @sample {highcharts} highcharts/series/data-array-of-name-value/ * Arrays of point.name and y * @sample {highcharts} highcharts/series/data-array-of-objects/ * Config objects * * @type {Array|*>} * @extends series.scatter.data * @product highcharts * @apioption series.scatter3d.data */ /** * The z value for each data point. * * @type {number} * @product highcharts * @apioption series.scatter3d.data.z */