highcharts
Version:
JavaScript charting framework
117 lines (116 loc) • 3.68 kB
JavaScript
/* *
*
* (c) 2016-2026 Highsoft AS
*
* Author: Lars A. V. Cabrera
*
* Integration of this software requires a license.
* - For commercial use, see www.highcharts.com/license
* - For non-commercial, see www.highcharts.com/license-eula
*
*
* */
;
import H from '../Core/Globals.js';
const { composed } = H;
import { addEvent, merge, pushUnique, wrap } from '../Shared/Utilities.js';
/* *
*
* Constants
*
* */
/**
* Show an indicator on the axis for the current date and time. Can be a
* boolean or a configuration object similar to
* [xAxis.plotLines](#xAxis.plotLines).
*
* @sample gantt/current-date-indicator/demo
* Current date indicator enabled
* @sample gantt/current-date-indicator/object-config
* Current date indicator with custom options
*
* @declare Highcharts.CurrentDateIndicatorOptions
* @type {boolean|CurrentDateIndicatorOptions}
* @default true
* @extends xAxis.plotLines
* @excluding className, value
* @product gantt
* @apioption xAxis.currentDateIndicator
*/
const defaultOptions = {
/**
* @type {Highcharts.ColorType}
*/
color: 'var(--highcharts-highlight-color-20)',
width: 2,
/**
* @declare Highcharts.AxisCurrentDateIndicatorLabelOptions
*/
label: {
/**
* Format of the label. This options is passed as the first argument to
* [dateFormat](/class-reference/Highcharts.Time#dateFormat) function.
*
* @type {string|Intl.DateTimeFormatOptions}
* @product gantt
* @default %[abdYHM]
* @apioption xAxis.currentDateIndicator.label.format
*/
format: '%[abdYHM]',
formatter: function (value, format) {
return this.axis.chart.time.dateFormat(format || '', value, true);
},
rotation: 0,
/**
* @type {Highcharts.CSSObject}
*/
style: {
/** @internal */
fontSize: '0.7em'
}
}
};
/* *
*
* Functions
*
* */
/** @internal */
export function composeCurrentDateIndication(AxisClass, PlotLineOrBandClass) {
if (pushUnique(composed, 'CurrentDateIndication')) {
addEvent(AxisClass, 'afterSetOptions', onAxisAfterSetOptions);
addEvent(PlotLineOrBandClass, 'render', onPlotLineOrBandRender);
wrap(PlotLineOrBandClass.prototype, 'getLabelText', wrapPlotLineOrBandGetLabelText);
}
}
/** @internal */
function onAxisAfterSetOptions() {
const options = this.options, cdiOptions = options.currentDateIndicator;
if (cdiOptions) {
const plotLineOptions = typeof cdiOptions === 'object' ?
merge(defaultOptions, cdiOptions) :
merge(defaultOptions);
plotLineOptions.value = Date.now();
plotLineOptions.className = 'highcharts-current-date-indicator';
options.plotLines ?? (options.plotLines = []);
options.plotLines.push(plotLineOptions);
}
}
/** @internal */
function onPlotLineOrBandRender() {
// If the label already exists, update its text
this.label?.attr({
text: this.getLabelText(this.options.label || {})
});
}
/** @internal */
function wrapPlotLineOrBandGetLabelText(defaultMethod, defaultLabelOptions) {
if (this.options.className &&
this.options.className.indexOf('highcharts-current-date-indicator') !== -1 &&
typeof this.options.label?.formatter === 'function') {
const options = this.options;
options.value = Date.now();
return options.label?.formatter?.call(this, options.value, options.label.format, this) || '';
}
return defaultMethod.call(this, defaultLabelOptions);
}