highcharts
Version:
JavaScript charting framework
197 lines (186 loc) • 7.1 kB
JavaScript
// SPDX-License-Identifier: LicenseRef-Highcharts
/**
* @license Highcharts Gantt JS v13.0.1 (2026-08-17)
* @module highcharts/modules/current-date-indicator
* @requires highcharts
*
* CurrentDateIndicator
*
* (c) 2010-2026 Highsoft AS
* Author: Lars A. V. Cabrera
*
* A commercial license may be required depending on use,
* see www.highcharts.com/license
*/
import * as __WEBPACK_EXTERNAL_MODULE__highcharts_src_js_8202131d__ from "../highcharts.src.js";
/******/ // The require scope
/******/ const __webpack_require__ = {};
/******/
/************************************************************************/
/******/ /* webpack/runtime/compat get default export */
/******/ (() => {
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = (module) => {
/******/ const getter = module && module.__esModule ?
/******/ () => (module['default']) :
/******/ () => (module);
/******/ __webpack_require__.d(getter, { a: getter });
/******/ return getter;
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/define property getters */
/******/ (() => {
/******/ // define getter/value functions for harmony exports
/******/ __webpack_require__.d = (exports, definition) => {
/******/ if(Array.isArray(definition)) {
/******/ var i = 0;
/******/ while(i < definition.length) {
/******/ var key = definition[i++];
/******/ var binding = definition[i++];
/******/ if(!__webpack_require__.o(exports, key)) {
/******/ if(binding === 0) {
/******/ Object.defineProperty(exports, key, { enumerable: true, value: definition[i++] });
/******/ } else {
/******/ Object.defineProperty(exports, key, { enumerable: true, get: binding });
/******/ }
/******/ } else if(binding === 0) { i++; }
/******/ }
/******/ } else {
/******/ for(var key in definition) {
/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
/******/ }
/******/ }
/******/ }
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/hasOwnProperty shorthand */
/******/ (() => {
/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
/******/ })();
/******/
/************************************************************************/
;// external ["../highcharts.src.js","default"]
const external_highcharts_src_js_default_namespaceObject = __WEBPACK_EXTERNAL_MODULE__highcharts_src_js_8202131d__["default"];
var external_highcharts_src_js_default_default = /*#__PURE__*/__webpack_require__.n(external_highcharts_src_js_default_namespaceObject);
;// ./code/es-modules/Extensions/CurrentDateIndication.js
/* *
*
* (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
*
*
* */
const { composed } = (external_highcharts_src_js_default_default());
/* *
*
* 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 */
function composeCurrentDateIndication(AxisClass, PlotLineOrBandClass) {
if ((0,external_highcharts_src_js_default_namespaceObject.pushUnique)(composed, 'CurrentDateIndication')) {
(0,external_highcharts_src_js_default_namespaceObject.addEvent)(AxisClass, 'afterSetOptions', onAxisAfterSetOptions);
(0,external_highcharts_src_js_default_namespaceObject.addEvent)(PlotLineOrBandClass, 'render', onPlotLineOrBandRender);
(0,external_highcharts_src_js_default_namespaceObject.wrap)(PlotLineOrBandClass.prototype, 'getLabelText', wrapPlotLineOrBandGetLabelText);
}
}
/** @internal */
function onAxisAfterSetOptions() {
const options = this.options, cdiOptions = options.currentDateIndicator;
if (cdiOptions) {
const plotLineOptions = typeof cdiOptions === 'object' ?
(0,external_highcharts_src_js_default_namespaceObject.merge)(defaultOptions, cdiOptions) :
(0,external_highcharts_src_js_default_namespaceObject.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);
}
;// ./code/es-modules/masters/modules/current-date-indicator.src.js
const G = (external_highcharts_src_js_default_default());
composeCurrentDateIndication(G.Axis, G.PlotLineOrBand);
/* harmony default export */ const current_date_indicator_src = ((external_highcharts_src_js_default_default()));
export { current_date_indicator_src as default };