UNPKG

@netdata/charts

Version:

Netdata frontend SDK and chart utilities

495 lines (494 loc) 23.8 kB
"use strict"; function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); } Object.defineProperty(exports, "__esModule", { value: true }); exports.useVisibleDimensionId = exports.useValue = exports.useUnits = exports.useUnitSign = exports.useTitle = exports.usePayload = exports.useOnResize = exports.useName = exports.useLoadingColor = exports.useLatestValue = exports.useLatestRowValue = exports.useLatestConvertedValue = exports.useIsMinimal = exports.useIsFetching = exports.useInitialLoading = exports.useImmediateListener = exports.useFormatTime = exports.useFormatDate = exports.useForceUpdate = exports.useFilteredNodeIds = exports.useEmpty = exports.useDimensionIds = exports.useConvertedValue = exports.useConverted = exports.useColor = exports.useChartError = exports.useChart = exports.useAttributeValue = exports.useAttribute = exports.getValueByPeriod = exports.convert = void 0; var _react = require("react"); var _d3Scale = require("d3-scale"); var _makeListeners = require("../../helpers/makeListeners"); var _annotations = require("../../helpers/annotations"); var _statistics = require("../../helpers/statistics"); var _chartTitleByContextMap = _interopRequireDefault(require("../helpers/chartTitleByContextMap")); var _context = _interopRequireDefault(require("./context")); var _excluded = ["key"], _excluded2 = ["chart", "id"]; function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; } function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; } function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; } function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; } function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; } function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; } function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); } function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } } function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } } function _arrayWithHoles(r) { if (Array.isArray(r)) return r; } var useChart = exports.useChart = function useChart() { return (0, _react.useContext)(_context["default"]); }; var dispatch = function dispatch(s) { return s + 1; }; var useForceUpdate = exports.useForceUpdate = function useForceUpdate() { var _useReducer = (0, _react.useReducer)(dispatch, 0), _useReducer2 = _slicedToArray(_useReducer, 2), forceUpdate = _useReducer2[1]; return forceUpdate; }; var useImmediateListener = exports.useImmediateListener = function useImmediateListener(func, deps) { var off = (0, _react.useMemo)(func, deps); (0, _react.useLayoutEffect)(function () { return off; }, [off]); }; var useAttributeValue = exports.useAttributeValue = function useAttributeValue(name, defaultValue) { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange(name, forceUpdate); }, [chart]); return chart.getAttribute(name, defaultValue); }; var useFilteredNodeIds = exports.useFilteredNodeIds = function useFilteredNodeIds() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { chart.onAttributeChange("selectedNodeLabelsFilter", forceUpdate); chart.onAttributeChange("selectedNodes", forceUpdate); }, [chart]); return chart.getFilteredNodeIds(); }; var useInitialLoading = exports.useInitialLoading = function useInitialLoading() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("loaded", forceUpdate); }, [chart]); return !chart.getAttribute("loaded"); }; var useLoadingColor = exports.useLoadingColor = function useLoadingColor() { var defaultColor = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "themeNeutralBackground"; var chart = useChart(); var _useState = (0, _react.useState)(defaultColor), _useState2 = _slicedToArray(_useState, 2), color = _useState2[0], setColor = _useState2[1]; var fetchStartedAt = useAttributeValue("fetchStartedAt"); var loading = useAttributeValue("loading"); (0, _react.useLayoutEffect)(function () { if (!loading) { setColor(defaultColor); return; } var getColor = (0, _d3Scale.scaleLinear)().domain([0, 1000, 2000, 3000, 100000]).range([chart.getThemeAttribute(defaultColor), chart.getThemeAttribute(defaultColor), chart.getThemeAttribute("themeLoadingStart"), chart.getThemeAttribute("themeNetdata"), chart.getThemeAttribute("themeNetdata")]); var id = setInterval(function () { setColor(getColor(Date.now() - fetchStartedAt)); }, 500); return function () { return clearInterval(id); }; }, [loading, fetchStartedAt, chart]); return color; }; var useColor = exports.useColor = function useColor(name) { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("theme", forceUpdate); }, [chart]); return chart.getThemeAttribute(name); }; var useIsFetching = exports.useIsFetching = function useIsFetching() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("loading", forceUpdate); }, [chart]); return chart.getAttribute("loading"); }; var useEmpty = exports.useEmpty = function useEmpty() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.on("finishFetch", forceUpdate); }, [chart]); var _chart$getPayload = chart.getPayload(), data = _chart$getPayload.data; return data.length === 0; }; var useAttribute = exports.useAttribute = function useAttribute(name) { var chart = useChart(); var forceUpdate = useForceUpdate(); var getValue = function getValue() { return chart.getAttribute(name); }; useImmediateListener(function () { return chart.onAttributeChange(name, forceUpdate); }, [chart]); var updateValue = (0, _react.useCallback)(function (nextValue) { return chart.updateAttribute(name, typeof nextValue === "function" ? nextValue(getValue()) : nextValue); }, [chart]); return [getValue(), updateValue]; }; var useTitle = exports.useTitle = function useTitle() { var title = useAttributeValue("title"); var contextScope = useAttributeValue("contextScope"); var titleByContext = contextScope.length === 1 && _chartTitleByContextMap["default"][contextScope[0]]; if (titleByContext) return titleByContext; return title; }; var useName = exports.useName = function useName() { var name = useAttributeValue("name"); var contextScope = useAttributeValue("contextScope"); return name || (contextScope && contextScope.length ? contextScope.join(", ") : ""); }; var useVisibleDimensionId = exports.useVisibleDimensionId = function useVisibleDimensionId(id) { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return (0, _makeListeners.unregister)(chart.onAttributeChange("selectedDimensions", forceUpdate), chart.on("visibleDimensionsChanged", forceUpdate)); }, [chart]); return chart.isDimensionVisible(id); }; var usePayload = exports.usePayload = function usePayload() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.on("payloadChanged", forceUpdate); }, [chart]); return chart.getPayload(); }; var useChartError = exports.useChartError = function useChartError() { var _useState3 = (0, _react.useState)(null), _useState4 = _slicedToArray(_useState3, 2), error = _useState4[0], setError = _useState4[1]; var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { var handleFetch = function handleFetch(errorMessage) { setError(errorMessage); forceUpdate(); }; return chart.on("successFetch", function () { return handleFetch(chart.getAttribute("error")); }).on("failFetch", function () { return handleFetch(chart.getAttribute("error")); }); }, [chart]); return error; }; var useFormatTime = exports.useFormatTime = function useFormatTime(value) { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("timezone", forceUpdate); }, [chart]); return (0, _react.useMemo)(function () { return chart.formatTime(value); }, [value, chart.getAttribute("timezone")]); }; var useFormatDate = exports.useFormatDate = function useFormatDate(value) { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("timezone", forceUpdate); }, [chart]); return (0, _react.useMemo)(function () { return chart.formatDate(value); }, [value, chart.getAttribute("timezone")]); }; var useOnResize = exports.useOnResize = function useOnResize(uiName) { var chart = useChart(); var _useState5 = (0, _react.useState)(1), _useState6 = _slicedToArray(_useState5, 2), invalidated = _useState6[0], invalidate = _useState6[1]; var forceUpdate = useForceUpdate(); useImmediateListener(function () { return (0, _makeListeners.unregister)(chart.on("mountChartUI", function () { setTimeout(function () { invalidate(function (prev) { return prev + 1; }); forceUpdate(); }, 300); }), chart.getUI(uiName).on("rendered", forceUpdate).on("resize", forceUpdate)); }, [uiName, chart, invalidated]); return { width: chart.getUI(uiName).getChartWidth(), height: chart.getUI(uiName).getChartHeight(), parentWidth: chart.getAttribute("containerWidth") }; }; var useDimensionIds = exports.useDimensionIds = function useDimensionIds() { var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.on("dimensionChanged", forceUpdate); }, [chart]); return chart.getDimensionIds(); }; var useUnitSign = exports.useUnitSign = function useUnitSign() { var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}, _ref$key = _ref.key, key = _ref$key === void 0 ? "units" : _ref$key, options = _objectWithoutProperties(_ref, _excluded); var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("".concat(key, "ConversionPrefix"), forceUpdate); }, [chart, key]); return chart.getUnitSign(_objectSpread({ key: key }, options)); }; var useUnits = exports.useUnits = function useUnits() { var key = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "units"; var chart = useChart(); var forceUpdate = useForceUpdate(); useImmediateListener(function () { return chart.onAttributeChange("".concat(key, "ConversionPrefix"), forceUpdate); }, [chart, key]); return chart.getUnits(key); }; var formatPercentage = function formatPercentage(value, _ref2) { var fractionDigits = _ref2.fractionDigits; return value === 0 ? "-" : (Math.round((value + Number.EPSILON) * 100) / 100).toFixed(fractionDigits || 2); }; var formatPercentageWithSymbol = function formatPercentageWithSymbol(value, _ref3) { var fractionDigits = _ref3.fractionDigits; if (value == null || value === 0) return "-"; return (Math.round((value + Number.EPSILON) * 100) / 100).toFixed(fractionDigits || 1) + "%"; }; var formatInteger = function formatInteger(value) { return Math.round(value).toString(); }; var formatAnomalyParts = function formatAnomalyParts(value) { return _annotations.parts.reduce(function (h, a) { return (0, _annotations.check)(value, _annotations.enums[a]) ? _objectSpread(_objectSpread({}, h), {}, _defineProperty({}, a, _annotations.colors[a])) : h; }, {}); }; var formatByType = { arp: formatPercentage, percent: formatPercentage, cv: formatPercentageWithSymbol, count: formatInteger, points: formatInteger, dimensions: formatInteger, pa: formatAnomalyParts }; var convert = exports.convert = function convert(chart, value) { var _ref4 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {}, valueKey = _ref4.valueKey, fractionDigits = _ref4.fractionDigits, dimensionId = _ref4.dimensionId, _ref4$unitsKey = _ref4.unitsKey, unitsKey = _ref4$unitsKey === void 0 ? "units" : _ref4$unitsKey; if (value === null || value === "-") return "-"; var formatter = formatByType[valueKey]; if (formatter) { return formatter(value, { fractionDigits: fractionDigits, dimensionId: dimensionId, unitsKey: unitsKey }); } return chart.getConvertedValue(value, { fractionDigits: fractionDigits, key: unitsKey, dimensionId: dimensionId }); }; var useConverted = exports.useConverted = function useConverted(value) { var _ref5 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}, valueKey = _ref5.valueKey, fractionDigits = _ref5.fractionDigits, dimensionId = _ref5.dimensionId, _ref5$unitsKey = _ref5.unitsKey, unitsKey = _ref5$unitsKey === void 0 ? "units" : _ref5$unitsKey; var chart = useChart(); var unitsConversionPrefix = useAttributeValue("".concat(unitsKey, "ConversionPrefix")); return (0, _react.useMemo)(function () { return convert(chart, value, { valueKey: valueKey, fractionDigits: fractionDigits, dimensionId: dimensionId, unitsKey: unitsKey }); }, [chart, value, valueKey, unitsConversionPrefix]); }; var useLatestRowValue = exports.useLatestRowValue = function useLatestRowValue() { var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}; var chart = useChart(); var _useState7 = (0, _react.useState)(null), _useState8 = _slicedToArray(_useState7, 2), value = _useState8[0], setState = _useState8[1]; (0, _react.useLayoutEffect)(function () { var getValue = function getValue() { var hover = chart.getAttribute("hoverX"); var _chart$getPayload2 = chart.getPayload(), all = _chart$getPayload2.all; if (all.length === 0) return ""; var index = hover ? chart.getClosestRow(hover[0]) : -1; index = index === -1 ? all.length - 1 : index; var dimensionIds = chart.getVisibleDimensionIds(); return dimensionIds.map(function (id) { return { label: id, value: chart.getDimensionValue(id, index, options), color: chart.selectDimensionColor(id) }; }); }; return (0, _makeListeners.unregister)(chart.onAttributeChange("hoverX", function () { return setState(getValue()); }), chart.on("dimensionChanged", function () { return setState(getValue()); }), chart.on("render", function () { return setState(getValue()); })); }, [chart]); return value; }; var calculateClientSideStats = function calculateClientSideStats(chart, id, valueKey, period) { var _allStats$valueKey; var _chart$getPayload3 = chart.getPayload(), data = _chart$getPayload3.data; if (!(data !== null && data !== void 0 && data.length)) return null; var filteredData = data; if (period === "highlight") { var _chart$getAttribute = chart.getAttribute("overlays"), highlight = _chart$getAttribute.highlight; if (!(highlight !== null && highlight !== void 0 && highlight.range)) return null; var _highlight$range = _slicedToArray(highlight.range, 2), start = _highlight$range[0], end = _highlight$range[1]; filteredData = data.filter(function (row) { var timestamp = row[0] / 1000; return timestamp >= start && timestamp <= end; }); } if (!filteredData.length) return null; id = chart.isDimensionVisible(id) ? id : chart.getVisibleDimensionIds()[0]; if (!id) return null; var dimensionIndex = chart.getDimensionIndex(id); if (dimensionIndex === -1) return null; var values = filteredData.map(function (row) { return row[dimensionIndex + 1]; }).filter(function (val) { return val !== null && !isNaN(val) && isFinite(val); }); if (!values.length) return null; var allStats = (0, _statistics.calculateAllStats)(values); return (_allStats$valueKey = allStats[valueKey]) !== null && _allStats$valueKey !== void 0 ? _allStats$valueKey : null; }; var getValueByPeriod = exports.getValueByPeriod = { latest: function latest(_ref6) { var chart = _ref6.chart, id = _ref6.id, options = _objectWithoutProperties(_ref6, _excluded2); var hover = chart.getAttribute("hoverX"); var _chart$getPayload4 = chart.getPayload(), all = _chart$getPayload4.all; if (!all.length) return null; var index = hover ? chart.getClosestRow(hover[0]) : -1; index = index === -1 ? all.length - 1 : index; id = chart.isDimensionVisible(id) ? id : chart.getVisibleDimensionIds()[0]; if (!id) return null; var dimValue = chart.getDimensionValue(id, index, options); return dimValue; }, window: function window(_ref7) { var chart = _ref7.chart, id = _ref7.id, _ref7$valueKey = _ref7.valueKey, valueKey = _ref7$valueKey === void 0 ? "value" : _ref7$valueKey, _ref7$objKey = _ref7.objKey, objKey = _ref7$objKey === void 0 ? "viewDimensions" : _ref7$objKey; if (["value", "min", "avg", "max", "arp"].includes(valueKey)) { var dimensions = chart.getAttribute(objKey).sts; var values = dimensions[valueKey]; if (values !== null && values !== void 0 && values.length) { id = chart.isDimensionVisible(id) ? id : chart.getVisibleDimensionIds()[0]; if (id) return values[chart.getDimensionIndex(id)]; } } return calculateClientSideStats(chart, id, valueKey, "window"); }, highlight: function highlight(_ref8) { var chart = _ref8.chart, id = _ref8.id, _ref8$valueKey = _ref8.valueKey, valueKey = _ref8$valueKey === void 0 ? "value" : _ref8$valueKey; return calculateClientSideStats(chart, id, valueKey, "highlight"); } }; var useValue = exports.useValue = function useValue(id) { var period = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "latest"; var _ref9 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {}, _ref9$valueKey = _ref9.valueKey, valueKey = _ref9$valueKey === void 0 ? "value" : _ref9$valueKey, _ref9$objKey = _ref9.objKey, objKey = _ref9$objKey === void 0 ? "viewDimensions" : _ref9$objKey, abs = _ref9.abs, _ref9$unitsKey = _ref9.unitsKey, unitsKey = _ref9$unitsKey === void 0 ? "units" : _ref9$unitsKey, allowNull = _ref9.allowNull; var chart = useChart(); abs = typeof abs === "boolean" ? abs : chart.getAttribute("abs"); var _useState9 = (0, _react.useState)(null), _useState10 = _slicedToArray(_useState9, 2), value = _useState10[0], setState = _useState10[1]; (0, _react.useLayoutEffect)(function () { var getValue = function getValue() { return (getValueByPeriod[period] || getValueByPeriod.latest)({ chart: chart, id: id, valueKey: valueKey, objKey: objKey, abs: abs, allowNull: allowNull }); }; setState(getValue()); return (0, _makeListeners.unregister)(chart.onAttributeChange("hoverX", function () { return setState(getValue()); }), chart.on("dimensionChanged", function () { return setState(getValue()); }), chart.onAttributeChange("".concat(unitsKey, "Conversion"), function () { return setState(getValue()); }), chart.on("render", function () { return setState(getValue()); })); }, [chart, id, valueKey, period, objKey, unitsKey]); return value; }; var useLatestValue = exports.useLatestValue = function useLatestValue(id) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; return useValue(id, "latest", options); }; var useConvertedValue = exports.useConvertedValue = function useConvertedValue(id) { var period = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "latest"; var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {}; var value = useValue(id, period, options); return useConverted(value, _objectSpread(_objectSpread({}, options), {}, { dimensionId: id })); }; var useLatestConvertedValue = exports.useLatestConvertedValue = function useLatestConvertedValue(id) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; return useConvertedValue(id, "latest", _objectSpread({ allowNull: true, dimensionId: id }, options)); }; var useIsMinimal = exports.useIsMinimal = function useIsMinimal() { return useAttributeValue("designFlavour") === "minimal"; };