/* *
|
*
|
* (c) 2010-2019 Torstein Honsi
|
*
|
* License: www.highcharts.com/license
|
*
|
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
|
*
|
* */
|
'use strict';
|
|
var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
|
/**
|
* Function callback when a series point is clicked. Return false to cancel the
|
* action.
|
*
|
* @callback Highcharts.PointClickCallbackFunction
|
*
|
* @param {Highcharts.Point} this
|
* The point where the event occured.
|
*
|
* @param {Highcharts.PointClickEventObject} event
|
* Event arguments.
|
*/
|
/**
|
* Common information for a click event on a series point.
|
*
|
* @interface Highcharts.PointClickEventObject
|
* @extends Highcharts.PointerEventObject
|
*/ /**
|
* Clicked point.
|
* @name Highcharts.PointClickEventObject#point
|
* @type {Highcharts.Point}
|
*/
|
/**
|
* Events for each single point.
|
* @interface Highcharts.PointEventsOptionsObject
|
*/ /**
|
* Fires when a point is clicked. One parameter, event, is passed to the
|
* function, containing common event information.
|
*
|
* If the `series.allowPointSelect` option is true, the default action for the
|
* point's click event is to toggle the point's select state. Returning `false`
|
* cancels this action.
|
* @name Highcharts.PointEventsOptionsObject#click
|
* @type {Highcharts.PointClickCallbackFunction|undefined}
|
*/ /**
|
* Fires when the mouse leaves the area close to the point. One parameter,
|
* `event`, is passed to the function, containing common event information.
|
* @name Highcharts.PointEventsOptionsObject#mouseOut
|
* @type {Highcharts.PointMouseOutCallbackFunction}
|
*/ /**
|
* Fires when the mouse enters the area close to the point. One parameter,
|
* `event`, is passed to the function, containing common event information.
|
* @name Highcharts.PointEventsOptionsObject#mouseOver
|
* @type {Highcharts.PointMouseOverCallbackFunction}
|
*/ /**
|
* Fires when the point is removed using the `.remove()` method. One parameter,
|
* `event`, is passed to the function. Returning `false` cancels the operation.
|
* @name Highcharts.PointEventsOptionsObject#remove
|
* @type {Highcharts.PointRemoveCallbackFunction}
|
*/ /**
|
* Fires when the point is selected either programmatically or following a click
|
* on the point. One parameter, `event`, is passed to the function. Returning
|
* `false` cancels the operation.
|
* @name Highcharts.PointEventsOptionsObject#select
|
* @type {Highcharts.PointSelectCallbackFunction}
|
*/ /**
|
* Fires when the point is unselected either programmatically or following a
|
* click on the point. One parameter, `event`, is passed to the function.
|
* Returning `false` cancels the operation.
|
* @name Highcharts.PointEventsOptionsObject#unselect
|
* @type {Highcharts.PointUnselectCallbackFunction}
|
*/ /**
|
* Fires when the point is updated programmatically through the `.update()``
|
* method. One parameter, `event`, is passed to the function. The new point
|
* options can be accessed through event.options. Returning `false` cancels the
|
* operation.
|
* @name Highcharts.PointEventsOptionsObject#update
|
* @type {Highcharts.PointUpdateCallbackFunction}
|
*/
|
/**
|
* Configuration hash for the data label and tooltip formatters.
|
*
|
* @interface Highcharts.PointLabelObject
|
*/ /**
|
* The point's current color.
|
* @name Highcharts.PointLabelObject#color
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* The point's current color index, used in styled mode instead of `color`. The
|
* color index is inserted in class names used for styling.
|
* @name Highcharts.PointLabelObject#colorIndex
|
* @type {number}
|
*/ /**
|
* The name of the related point.
|
* @name Highcharts.PointLabelObject#key
|
* @type {string|undefined}
|
*/ /**
|
* The percentage for related points in a stacked series or pies.
|
* @name Highcharts.PointLabelObject#percentage
|
* @type {number}
|
*/ /**
|
* The related point.
|
* @name Highcharts.PointLabelObject#point
|
* @type {Highcharts.Point}
|
*/ /**
|
* The related series.
|
* @name Highcharts.PointLabelObject#series
|
* @type {Highcharts.Series}
|
*/ /**
|
* The total of values in either a stack for stacked series, or a pie in a pie
|
* series.
|
* @name Highcharts.PointLabelObject#total
|
* @type {number|undefined}
|
*/ /**
|
* For categorized axes this property holds the category name for the point. For
|
* other axes it holds the X value.
|
* @name Highcharts.PointLabelObject#x
|
* @type {number|string|undefined}
|
*/ /**
|
* The y value of the point.
|
* @name Highcharts.PointLabelObject#y
|
* @type {number|undefined}
|
*/
|
/**
|
* States for a single point marker.
|
*
|
* @interface Highcharts.PointMarkerStatesOptionsObject
|
*/ /**
|
* The hover state for a single point marker.
|
* @name Highcharts.PointMarkerStatesOptionsObject#hover
|
* @type {Highcharts.PointStatesHoverOptionsObject}
|
*/ /**
|
* @name Highcharts.PointMarkerStatesOptionsObject#inactive
|
* @type {Highcharts.PointStatesInactiveOptionsObject}
|
*/ /**
|
* The normal state of a single point marker. Currently only used for setting
|
* animation when returning to normal state from hover.
|
* @name Highcharts.PointMarkerStatesOptionsObject#normal
|
* @type {Highcharts.PointStatesNormalOptionsObject}
|
*/ /**
|
* The appearance of the point marker when selected. In order to allow a point
|
* to be selected, set the `series.allowPointSelect` option to true.
|
* @name Highcharts.PointMarkerStatesOptionsObject#select
|
* @type {Highcharts.PointStatesSelectOptionsObject}
|
*/
|
/**
|
* @interface Highcharts.PointMarkerOptionsObject
|
*/ /**
|
* Enable or disable the point marker. If `undefined`, the markers are hidden
|
* when the data is dense, and shown for more widespread data points.
|
* @name Highcharts.PointMarkerOptionsObject#enabled
|
* @type {boolean|undefined}
|
*/ /**
|
* The threshold for how dense the point markers should be before they are
|
* hidden, given that `enabled` is not defined. The number indicates the
|
* horizontal distance between the two closest points in the series, as
|
* multiples of the `marker.radius`. In other words, the default value of 2
|
* means points are hidden if overlapping horizontally.
|
* @name Highcharts.PointMarkerOptionsObject#enabledThreshold
|
* @type {number|undefined}
|
*/ /**
|
* The fill color of the point marker. When `undefined`, the series' or point's
|
* color is used.
|
* @name Highcharts.PointMarkerOptionsObject#fillColor
|
* @type {ColorString|GradientColorObject|PatternObject|undefined}
|
*/ /**
|
* Image markers only. Set the image width explicitly. When using this option,
|
* a `width` must also be set.
|
* @name Highcharts.PointMarkerOptionsObject#height
|
* @type {number|undefined}
|
*/ /**
|
* The color of the point marker's outline. When `undefined`, the series' or
|
* point's color is used.
|
* @name Highcharts.PointMarkerOptionsObject#lineColor
|
* @type {ColorString|undefined}
|
*/ /**
|
* The width of the point marker's outline.
|
* @name Highcharts.PointMarkerOptionsObject#lineWidth
|
* @type {number|undefined}
|
*/ /**
|
* The radius of the point marker.
|
* @name Highcharts.PointMarkerOptionsObject#radius
|
* @type {number|undefined}
|
*/ /**
|
* States for a single point marker.
|
* @name Highcharts.PointMarkerOptionsObject#states
|
* @type {PointStatesOptionsObject|undefined}
|
*/ /**
|
* A predefined shape or symbol for the marker. When undefined, the symbol is
|
* pulled from options.symbols. Other possible values are "circle", "square",
|
* "diamond", "triangle" and "triangle-down".
|
*
|
* Additionally, the URL to a graphic can be given on this form:
|
* "url(graphic.png)". Note that for the image to be applied to exported charts,
|
* its URL needs to be accessible by the export server.
|
*
|
* Custom callbacks for symbol path generation can also be added to
|
* `Highcharts.SVGRenderer.prototype.symbols`.
|
* @name Highcharts.PointMarkerOptionsObject#symbol
|
* @type {string|undefined}
|
*/ /**
|
* Image markers only. Set the image width explicitly. When using this option, a
|
* `height` must also be set.
|
* @name Highcharts.PointMarkerOptionsObject#width
|
* @type {number|undefined}
|
*/
|
/**
|
* Gets fired when the mouse leaves the area close to the point.
|
*
|
* @callback Highcharts.PointMouseOutCallbackFunction
|
*
|
* @param {Highcharts.Point} this
|
* Point where the event occured.
|
*
|
* @param {global.PointerEvent} event
|
* Event that occured.
|
*/
|
/**
|
* Gets fired when the mouse enters the area close to the point.
|
*
|
* @callback Highcharts.PointMouseOverCallbackFunction
|
*
|
* @param {Highcharts.Point} this
|
* Point where the event occured.
|
*
|
* @param {global.Event} event
|
* Event that occured.
|
*/
|
/**
|
* The generic point options for all series.
|
*
|
* In TypeScript you have to extend `PointOptionsObject` with an additional
|
* declaration to allow custom data options:
|
*
|
* ```
|
* declare interface PointOptionsObject {
|
* customProperty: string;
|
* }
|
* ```
|
*
|
* @interface Highcharts.PointOptionsObject
|
*/ /**
|
* An additional, individual class name for the data point's graphic
|
* representation.
|
* @name Highcharts.PointOptionsObject#className
|
* @type {string|undefined}
|
*/ /**
|
* Individual color for the point. By default the color is pulled from the
|
* global colors array. In styled mode, the color option doesn't take effect.
|
* Instead, use colorIndex.
|
* @name Highcharts.PointOptionsObject#color
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* A specific color index to use for the point, so its graphic representations
|
* are given the class name highcharts-color-{n}. In styled mode this will
|
* change the color of the graphic. In non-styled mode, the color by is set by
|
* the fill attribute, so the change in class name won't have a visual effect by
|
* default.
|
* @name Highcharts.PointOptionsObject#colorIndex
|
* @type {number|undefined}
|
*/ /**
|
* The id of a series in the drilldown.series array to use for a drilldown for
|
* this point.
|
* @name Highcharts.PointOptionsObject#drilldown
|
* @type {string|undefined}
|
*/ /**
|
* The id of a series in the drilldown.series array to use for a drilldown for
|
* this point.
|
* @name Highcharts.PointOptionsObject#events
|
* @type {Highcharts.PointEventsOptionsObject}
|
*/ /**
|
* An id for the point. This can be used after render time to get a pointer to
|
* the point object through `chart.get()`.
|
* @name Highcharts.PointOptionsObject#id
|
* @type {string|undefined}
|
*/ /**
|
* Options for the point markers of line-like series.
|
* @name Highcharts.PointOptionsObject#marker
|
* @type {Highcharts.PointMarkerOptionsObject}
|
*/ /**
|
* The name of the point as shown in the legend, tooltip, dataLabels etc.
|
* @name Highcharts.PointOptionsObject#name
|
* @type {string|undefined}
|
*/ /**
|
* Whether the data point is selected initially.
|
* @name Highcharts.PointOptionsObject#selected
|
* @type {boolean|undefined}
|
*/ /**
|
* The x value of the point. For datetime axes, the X value is the timestamp in
|
* milliseconds since 1970.
|
* @name Highcharts.PointOptionsObject#x
|
* @type {number|undefined}
|
*/ /**
|
* The y value of the point.
|
* @name Highcharts.PointOptionsObject#y
|
* @type {number|null|undefined}
|
*/
|
/**
|
* Possible option types for a data point.
|
*
|
* @typedef {number|string|Array<(number|string)>|Highcharts.PointOptionsObject|null} Highcharts.PointOptionsType
|
*/
|
/**
|
* Gets fired when the point is removed using the `.remove()` method.
|
*
|
* @callback Highcharts.PointRemoveCallbackFunction
|
*
|
* @param {Highcharts.Point} this
|
* Point where the event occured.
|
*
|
* @param {global.Event} event
|
* Event that occured.
|
*/
|
/**
|
* The hover state for a single point marker.
|
* @interface Highcharts.PointStatesHoverOptionsObject
|
*/ /**
|
* Animation when hovering over the point marker.
|
* @name Highcharts.PointStatesHoverOptionsObject#animation
|
* @type {boolean|Highcharts.AnimationOptionsObject}
|
*/ /**
|
* Enable or disable the point marker.
|
* @name Highcharts.PointStatesHoverOptionsObject#enabled
|
* @type {boolean|undefined}
|
*/ /**
|
* The fill color of the marker in hover state. When `undefined`, the series' or
|
* point's fillColor for normal state is used.
|
* @name Highcharts.PointStatesHoverOptionsObject#fillColor
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* The color of the point marker's outline. When `undefined`, the series' or
|
* point's lineColor for normal state is used.
|
* @name Highcharts.PointStatesHoverOptionsObject#lineColor
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* The width of the point marker's outline. When `undefined`, the series' or
|
* point's lineWidth for normal state is used.
|
* @name Highcharts.PointStatesHoverOptionsObject#lineWidth
|
* @type {number|undefined}
|
*/ /**
|
* The additional line width for a hovered point.
|
* @name Highcharts.PointStatesHoverOptionsObject#lineWidthPlus
|
* @type {number|undefined}
|
*/ /**
|
* The radius of the point marker. In hover state, it defaults to the normal
|
* state's radius + 2 as per the radiusPlus option.
|
* @name Highcharts.PointStatesHoverOptionsObject#radius
|
* @type {number|undefined}
|
*/ /**
|
* The number of pixels to increase the radius of the hovered point.
|
* @name Highcharts.PointStatesHoverOptionsObject#radiusPlus
|
* @type {number|undefined}
|
*/
|
/**
|
* @interface Highcharts.PointStatesInactiveOptionsObject
|
*/ /**
|
* Opacity of inactive markers.
|
* @name Highcharts.PointStatesInactiveOptionsObject#opacity
|
* @type {number|undefined}
|
*/
|
/**
|
* The normal state of a single point marker. Currently only used for setting
|
* animation when returning to normal state from hover.
|
*
|
* @interface Highcharts.PointStatesNormalOptionsObject
|
*/ /**
|
* Animation when returning to normal state after hovering.
|
* @name Highcharts.PointStatesNormalOptionsObject#animation
|
* @type {boolean|Highcharts.AnimationOptionsObject|undefined}
|
*/
|
/**
|
* States for a single point marker.
|
*
|
* @interface Highcharts.PointStatesOptionsObject
|
*/ /**
|
* The hover state for a single point marker.
|
* @name Highcharts.PointStatesOptionsObject#hover
|
* @type {Highcharts.PointStatesHoverOptionsObject|undefined}
|
*/ /**
|
* The hover state for a single point marker.
|
* @name Highcharts.PointStatesOptionsObject#inactive
|
* @type {Highcharts.PointStatesInactiveOptionsObject|undefined}
|
*/ /**
|
* The hover state for a single point marker.
|
* @name Highcharts.PointStatesOptionsObject#normal
|
* @type {Highcharts.PointStatesNormalOptionsObject|undefined}
|
*/ /**
|
* The hover state for a single point marker.
|
* @name Highcharts.PointStatesOptionsObject#select
|
* @type {Highcharts.PointStatesSelectOptionsObject|undefined}
|
*/
|
/**
|
* The appearance of the point marker when selected. In order to allow a point
|
* to be selected, set the `series.allowPointSelect` option to true.
|
*
|
* @interface Highcharts.PointStatesSelectOptionsObject
|
*/ /**
|
* Enable or disable visible feedback for selection.
|
* @name Highcharts.PointStatesSelectOptionsObject#enabled
|
* @type {boolean|undefined}
|
*/ /**
|
* The fill color of the point marker.
|
* @name Highcharts.PointStatesSelectOptionsObject#fillColor
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* The color of the point marker's outline. When `undefined`, the series' or
|
* point's color is used.
|
* @name Highcharts.PointStatesSelectOptionsObject#lineColor
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/ /**
|
* The width of the point marker's outline.
|
* @name Highcharts.PointStatesSelectOptionsObject#lineWidth
|
* @type {number|undefined}
|
*/ /**
|
* The radius of the point marker. In hover state, it defaults to the normal
|
* state's radius + 2.
|
* @name Highcharts.PointStatesSelectOptionsObject#radius
|
* @type {number|undefined}
|
*/
|
/**
|
* Gets fired when the point is updated programmatically through the `.update()`
|
* method.
|
*
|
* @callback Highcharts.PointUpdateCallbackFunction
|
*
|
* @param {Highcharts.Point} this
|
* Point where the event occured.
|
*
|
* @param {Highcharts.PointUpdateEventObject} event
|
* Event that occured.
|
*/
|
/**
|
* Information about the update event.
|
*
|
* @interface Highcharts.PointUpdateEventObject
|
* @extends global.Event
|
*/ /**
|
* Options data of the update event.
|
* @name Highcharts.PointUpdateEventObject#options
|
* @type {Highcharts.PointOptionsType}
|
*/
|
|
|
var _Globals = require('./Globals.js');
|
|
var _Globals2 = _interopRequireDefault(_Globals);
|
|
var _Utilities = require('./Utilities.js');
|
|
var _Utilities2 = _interopRequireDefault(_Utilities);
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
var defined = _Utilities2.default.defined,
|
erase = _Utilities2.default.erase,
|
isArray = _Utilities2.default.isArray,
|
isNumber = _Utilities2.default.isNumber,
|
isObject = _Utilities2.default.isObject;
|
var Point,
|
H = _Globals2.default,
|
extend = H.extend,
|
fireEvent = H.fireEvent,
|
format = H.format,
|
pick = H.pick,
|
uniqueKey = H.uniqueKey,
|
removeEvent = H.removeEvent;
|
/* eslint-disable no-invalid-this, valid-jsdoc */
|
/**
|
* The Point object. The point objects are generated from the `series.data`
|
* configuration objects or raw numbers. They can be accessed from the
|
* `Series.points` array. Other ways to instantiate points are through {@link
|
* Highcharts.Series#addPoint} or {@link Highcharts.Series#setData}.
|
*
|
* @class
|
* @name Highcharts.Point
|
*/
|
_Globals2.default.Point = Point = function Point() {};
|
_Globals2.default.Point.prototype = {
|
/**
|
* Initialize the point. Called internally based on the `series.data`
|
* option.
|
*
|
* @function Highcharts.Point#init
|
*
|
* @param {Highcharts.Series} series
|
* The series object containing this point.
|
*
|
* @param {Highcharts.PointOptionsType} options
|
* The data in either number, array or object format.
|
*
|
* @param {number} [x]
|
* Optionally, the X value of the point.
|
*
|
* @return {Highcharts.Point}
|
* The Point instance.
|
*
|
* @fires Highcharts.Point#event:afterInit
|
*/
|
init: function init(series, options, x) {
|
/**
|
* The series object associated with the point.
|
*
|
* @name Highcharts.Point#series
|
* @type {Highcharts.Series}
|
*/
|
this.series = series;
|
this.applyOptions(options, x);
|
// Add a unique ID to the point if none is assigned
|
this.id = defined(this.id) ? this.id : uniqueKey();
|
this.resolveColor();
|
series.chart.pointCount++;
|
fireEvent(this, 'afterInit');
|
return this;
|
},
|
/**
|
* @private
|
* @function Highcharts.Point#resolveColor
|
* @return {void}
|
*/
|
resolveColor: function resolveColor() {
|
var series = this.series,
|
colors,
|
optionsChart = series.chart.options.chart,
|
colorCount = optionsChart.colorCount,
|
styledMode = series.chart.styledMode,
|
colorIndex;
|
/**
|
* The point's current color.
|
*
|
* @name Highcharts.Point#color
|
* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject|undefined}
|
*/
|
if (!styledMode && !this.options.color) {
|
this.color = series.color; // #3445
|
}
|
if (series.options.colorByPoint) {
|
if (!styledMode) {
|
colors = series.options.colors || series.chart.options.colors;
|
this.color = this.color || colors[series.colorCounter];
|
colorCount = colors.length;
|
}
|
colorIndex = series.colorCounter;
|
series.colorCounter++;
|
// loop back to zero
|
if (series.colorCounter === colorCount) {
|
series.colorCounter = 0;
|
}
|
} else {
|
colorIndex = series.colorIndex;
|
}
|
/**
|
* The point's current color index, used in styled mode instead of
|
* `color`. The color index is inserted in class names used for styling.
|
*
|
* @name Highcharts.Point#colorIndex
|
* @type {number}
|
*/
|
this.colorIndex = pick(this.colorIndex, colorIndex);
|
},
|
/**
|
* Apply the options containing the x and y data and possible some extra
|
* properties. Called on point init or from point.update.
|
*
|
* @private
|
* @function Highcharts.Point#applyOptions
|
*
|
* @param {Highcharts.PointOptionsType} options
|
* The point options as defined in series.data.
|
*
|
* @param {number} [x]
|
* Optionally, the x value.
|
*
|
* @return {Highcharts.Point}
|
* The Point instance.
|
*/
|
applyOptions: function applyOptions(options, x) {
|
var point = this,
|
series = point.series,
|
pointValKey = series.options.pointValKey || series.pointValKey;
|
options = Point.prototype.optionsToObject.call(this, options);
|
// copy options directly to point
|
extend(point, options);
|
/**
|
* The point's options as applied in the initial configuration, or
|
* extended through `Point.update`.
|
*
|
* In TypeScript you have to extend `PointOptionsObject` via an
|
* additional interface to allow custom data options:
|
*
|
* ```
|
* declare interface PointOptionsObject {
|
* customProperty: string;
|
* }
|
* ```
|
*
|
* @name Highcharts.Point#options
|
* @type {Highcharts.PointOptionsObject}
|
*/
|
point.options = point.options ? extend(point.options, options) : options;
|
// Since options are copied into the Point instance, some accidental
|
// options must be shielded (#5681)
|
if (options.group) {
|
delete point.group;
|
}
|
if (options.dataLabels) {
|
delete point.dataLabels;
|
}
|
/**
|
* The y value of the point.
|
* @name Highcharts.Point#y
|
* @type {number|undefined}
|
*/
|
// For higher dimension series types. For instance, for ranges, point.y
|
// is mapped to point.low.
|
if (pointValKey) {
|
point.y = point[pointValKey];
|
}
|
point.isNull = pick(point.isValid && !point.isValid(), point.x === null || !isNumber(point.y)); // #3571, check for NaN
|
point.formatPrefix = point.isNull ? 'null' : 'point'; // #9233, #10874
|
// The point is initially selected by options (#5777)
|
if (point.selected) {
|
point.state = 'select';
|
}
|
/**
|
* The x value of the point.
|
* @name Highcharts.Point#x
|
* @type {number}
|
*/
|
// If no x is set by now, get auto incremented value. All points must
|
// have an x value, however the y value can be null to create a gap in
|
// the series
|
if ('name' in point && x === undefined && series.xAxis && series.xAxis.hasNames) {
|
point.x = series.xAxis.nameToX(point);
|
}
|
if (point.x === undefined && series) {
|
if (x === undefined) {
|
point.x = series.autoIncrement(point);
|
} else {
|
point.x = x;
|
}
|
}
|
return point;
|
},
|
/**
|
* Set a value in an object, on the property defined by key. The key
|
* supports nested properties using dot notation. The function modifies the
|
* input object and does not make a copy.
|
*
|
* @function Highcharts.Point#setNestedProperty<T>
|
*
|
* @param {T} object
|
* The object to set the value on.
|
*
|
* @param {*} value
|
* The value to set.
|
*
|
* @param {string} key
|
* Key to the property to set.
|
*
|
* @return {T}
|
* The modified object.
|
*/
|
setNestedProperty: function setNestedProperty(object, value, key) {
|
var nestedKeys = key.split('.');
|
nestedKeys.reduce(function (result, key, i, arr) {
|
var isLastKey = arr.length - 1 === i;
|
result[key] = isLastKey ? value : isObject(result[key], true) ? result[key] : {};
|
return result[key];
|
}, object);
|
return object;
|
},
|
/**
|
* Transform number or array configs into objects. Also called for object
|
* configs. Used internally to unify the different configuration formats for
|
* points. For example, a simple number `10` in a line series will be
|
* transformed to `{ y: 10 }`, and an array config like `[1, 10]` in a
|
* scatter series will be transformed to `{ x: 1, y: 10 }`.
|
*
|
* @function Highcharts.Point#optionsToObject
|
*
|
* @param {Highcharts.PointOptionsType} options
|
* The input option.
|
*
|
* @return {Highcharts.Dictionary<*>}
|
* Transformed options.
|
*/
|
optionsToObject: function optionsToObject(options) {
|
var ret = {},
|
series = this.series,
|
keys = series.options.keys,
|
pointArrayMap = keys || series.pointArrayMap || ['y'],
|
valueCount = pointArrayMap.length,
|
firstItemType,
|
i = 0,
|
j = 0;
|
if (isNumber(options) || options === null) {
|
ret[pointArrayMap[0]] = options;
|
} else if (isArray(options)) {
|
// with leading x value
|
if (!keys && options.length > valueCount) {
|
firstItemType = _typeof(options[0]);
|
if (firstItemType === 'string') {
|
ret.name = options[0];
|
} else if (firstItemType === 'number') {
|
ret.x = options[0];
|
}
|
i++;
|
}
|
while (j < valueCount) {
|
// Skip undefined positions for keys
|
if (!keys || options[i] !== undefined) {
|
if (pointArrayMap[j].indexOf('.') > 0) {
|
// Handle nested keys, e.g. ['color.pattern.image']
|
// Avoid function call unless necessary.
|
H.Point.prototype.setNestedProperty(ret, options[i], pointArrayMap[j]);
|
} else {
|
ret[pointArrayMap[j]] = options[i];
|
}
|
}
|
i++;
|
j++;
|
}
|
} else if ((typeof options === 'undefined' ? 'undefined' : _typeof(options)) === 'object') {
|
ret = options;
|
// This is the fastest way to detect if there are individual point
|
// dataLabels that need to be considered in drawDataLabels. These
|
// can only occur in object configs.
|
if (options.dataLabels) {
|
series._hasPointLabels = true;
|
}
|
// Same approach as above for markers
|
if (options.marker) {
|
series._hasPointMarkers = true;
|
}
|
}
|
return ret;
|
},
|
/**
|
* Get the CSS class names for individual points. Used internally where the
|
* returned value is set on every point.
|
*
|
* @function Highcharts.Point#getClassName
|
*
|
* @return {string}
|
* The class names.
|
*/
|
getClassName: function getClassName() {
|
return 'highcharts-point' + (this.selected ? ' highcharts-point-select' : '') + (this.negative ? ' highcharts-negative' : '') + (this.isNull ? ' highcharts-null-point' : '') + (this.colorIndex !== undefined ? ' highcharts-color-' + this.colorIndex : '') + (this.options.className ? ' ' + this.options.className : '') + (this.zone && this.zone.className ? ' ' + this.zone.className.replace('highcharts-negative', '') : '');
|
},
|
/**
|
* In a series with `zones`, return the zone that the point belongs to.
|
*
|
* @function Highcharts.Point#getZone
|
*
|
* @return {Highcharts.PlotSeriesZonesOptions}
|
* The zone item.
|
*/
|
getZone: function getZone() {
|
var series = this.series,
|
zones = series.zones,
|
zoneAxis = series.zoneAxis || 'y',
|
i = 0,
|
zone;
|
zone = zones[i];
|
while (this[zoneAxis] >= zone.value) {
|
zone = zones[++i];
|
}
|
// For resetting or reusing the point (#8100)
|
if (!this.nonZonedColor) {
|
this.nonZonedColor = this.color;
|
}
|
if (zone && zone.color && !this.options.color) {
|
this.color = zone.color;
|
} else {
|
this.color = this.nonZonedColor;
|
}
|
return zone;
|
},
|
/**
|
* Destroy a point to clear memory. Its reference still stays in
|
* `series.data`.
|
*
|
* @private
|
* @function Highcharts.Point#destroy
|
* @return {void}
|
*/
|
destroy: function destroy() {
|
var point = this,
|
series = point.series,
|
chart = series.chart,
|
hoverPoints = chart.hoverPoints,
|
prop;
|
chart.pointCount--;
|
if (hoverPoints) {
|
point.setState();
|
erase(hoverPoints, point);
|
if (!hoverPoints.length) {
|
chart.hoverPoints = null;
|
}
|
}
|
if (point === chart.hoverPoint) {
|
point.onMouseOut();
|
}
|
// Remove all events and elements
|
if (point.graphic || point.dataLabel || point.dataLabels) {
|
removeEvent(point);
|
point.destroyElements();
|
}
|
if (point.legendItem) {
|
// pies have legend items
|
chart.legend.destroyItem(point);
|
}
|
for (prop in point) {
|
// eslint-disable-line guard-for-in
|
point[prop] = null;
|
}
|
},
|
/**
|
* Destroy SVG elements associated with the point.
|
*
|
* @private
|
* @function Highcharts.Point#destroyElements
|
* @param {Highcharts.Dictionary<number>} [kinds]
|
* @return {void}
|
*/
|
destroyElements: function destroyElements(kinds) {
|
var point = this,
|
props = [],
|
prop,
|
i;
|
kinds = kinds || { graphic: 1, dataLabel: 1 };
|
if (kinds.graphic) {
|
props.push('graphic', 'shadowGroup');
|
}
|
if (kinds.dataLabel) {
|
props.push('dataLabel', 'dataLabelUpper', 'connector');
|
}
|
i = props.length;
|
while (i--) {
|
prop = props[i];
|
if (point[prop]) {
|
point[prop] = point[prop].destroy();
|
}
|
}
|
['dataLabel', 'connector'].forEach(function (prop) {
|
var plural = prop + 's';
|
if (kinds[prop] && point[plural]) {
|
point[plural].forEach(function (item) {
|
if (item.element) {
|
item.destroy();
|
}
|
});
|
delete point[plural];
|
}
|
});
|
},
|
/**
|
* Return the configuration hash needed for the data label and tooltip
|
* formatters.
|
*
|
* @function Highcharts.Point#getLabelConfig
|
*
|
* @return {Highcharts.PointLabelObject}
|
* Abstract object used in formatters and formats.
|
*/
|
getLabelConfig: function getLabelConfig() {
|
return {
|
x: this.category,
|
y: this.y,
|
color: this.color,
|
colorIndex: this.colorIndex,
|
key: this.name || this.category,
|
series: this.series,
|
point: this,
|
percentage: this.percentage,
|
total: this.total || this.stackTotal
|
};
|
},
|
/**
|
* Extendable method for formatting each point's tooltip line.
|
*
|
* @function Highcharts.Point#tooltipFormatter
|
*
|
* @param {string} pointFormat
|
* The point format.
|
*
|
* @return {string}
|
* A string to be concatenated in to the common tooltip text.
|
*/
|
tooltipFormatter: function tooltipFormatter(pointFormat) {
|
// Insert options for valueDecimals, valuePrefix, and valueSuffix
|
var series = this.series,
|
seriesTooltipOptions = series.tooltipOptions,
|
valueDecimals = pick(seriesTooltipOptions.valueDecimals, ''),
|
valuePrefix = seriesTooltipOptions.valuePrefix || '',
|
valueSuffix = seriesTooltipOptions.valueSuffix || '';
|
// Replace default point style with class name
|
if (series.chart.styledMode) {
|
pointFormat = series.chart.tooltip.styledModeFormat(pointFormat);
|
}
|
// Loop over the point array map and replace unformatted values with
|
// sprintf formatting markup
|
(series.pointArrayMap || ['y']).forEach(function (key) {
|
key = '{point.' + key; // without the closing bracket
|
if (valuePrefix || valueSuffix) {
|
pointFormat = pointFormat.replace(RegExp(key + '}', 'g'), valuePrefix + key + '}' + valueSuffix);
|
}
|
pointFormat = pointFormat.replace(RegExp(key + '}', 'g'), key + ':,.' + valueDecimals + 'f}');
|
});
|
return format(pointFormat, {
|
point: this,
|
series: this.series
|
}, series.chart.time);
|
},
|
/**
|
* Fire an event on the Point object.
|
*
|
* @private
|
* @function Highcharts.Point#firePointEvent
|
*
|
* @param {string} eventType
|
* Type of the event.
|
*
|
* @param {Highcharts.Dictionary<any>|Event} [eventArgs]
|
* Additional event arguments.
|
*
|
* @param {Highcharts.EventCallbackFunction<Highcharts.Point>|Function} [defaultFunction]
|
* Default event handler.
|
*
|
* @fires Highcharts.Point#event:*
|
*/
|
firePointEvent: function firePointEvent(eventType, eventArgs, defaultFunction) {
|
var point = this,
|
series = this.series,
|
seriesOptions = series.options;
|
// load event handlers on demand to save time on mouseover/out
|
if (seriesOptions.point.events[eventType] || point.options && point.options.events && point.options.events[eventType]) {
|
this.importEvents();
|
}
|
// add default handler if in selection mode
|
if (eventType === 'click' && seriesOptions.allowPointSelect) {
|
defaultFunction = function defaultFunction(event) {
|
// Control key is for Windows, meta (= Cmd key) for Mac, Shift
|
// for Opera.
|
if (point.select) {
|
// #2911
|
point.select(null, event.ctrlKey || event.metaKey || event.shiftKey);
|
}
|
};
|
}
|
fireEvent(this, eventType, eventArgs, defaultFunction);
|
},
|
/**
|
* For categorized axes this property holds the category name for the
|
* point. For other axes it holds the X value.
|
*
|
* @name Highcharts.Point#category
|
* @type {number|string}
|
*/
|
/**
|
* The name of the point. The name can be given as the first position of the
|
* point configuration array, or as a `name` property in the configuration:
|
*
|
* @example
|
* // Array config
|
* data: [
|
* ['John', 1],
|
* ['Jane', 2]
|
* ]
|
*
|
* // Object config
|
* data: [{
|
* name: 'John',
|
* y: 1
|
* }, {
|
* name: 'Jane',
|
* y: 2
|
* }]
|
*
|
* @name Highcharts.Point#name
|
* @type {string}
|
*/
|
/**
|
* The percentage for points in a stacked series or pies.
|
*
|
* @name Highcharts.Point#percentage
|
* @type {number}
|
*/
|
/**
|
* The total of values in either a stack for stacked series, or a pie in a
|
* pie series.
|
*
|
* @name Highcharts.Point#total
|
* @type {number}
|
*/
|
/**
|
* For certain series types, like pie charts, where individual points can
|
* be shown or hidden.
|
*
|
* @name Highcharts.Point#visible
|
* @type {boolean}
|
*/
|
visible: true
|
};
|
