legend.ts 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. import angular from 'angular';
  2. import _ from 'lodash';
  3. import $ from 'jquery';
  4. import baron from 'baron';
  5. const module = angular.module('grafana.directives');
  6. module.directive('graphLegend', (popoverSrv, $timeout) => {
  7. return {
  8. link: (scope, elem) => {
  9. let firstRender = true;
  10. const ctrl = scope.ctrl;
  11. const panel = ctrl.panel;
  12. let data;
  13. let seriesList;
  14. let i;
  15. let legendScrollbar;
  16. const legendRightDefaultWidth = 10;
  17. const legendElem = elem.parent();
  18. scope.$on('$destroy', () => {
  19. destroyScrollbar();
  20. });
  21. ctrl.events.on('render-legend', () => {
  22. data = ctrl.seriesList;
  23. if (data) {
  24. render();
  25. }
  26. ctrl.events.emit('legend-rendering-complete');
  27. });
  28. function getSeriesIndexForElement(el) {
  29. return el.parents('[data-series-index]').data('series-index');
  30. }
  31. function openColorSelector(e) {
  32. // if we clicked inside poup container ignore click
  33. if ($(e.target).parents('.popover').length) {
  34. return;
  35. }
  36. const el = $(e.currentTarget).find('.fa-minus');
  37. const index = getSeriesIndexForElement(el);
  38. const series = seriesList[index];
  39. $timeout(() => {
  40. popoverSrv.show({
  41. element: el[0],
  42. position: 'bottom left',
  43. targetAttachment: 'top left',
  44. template:
  45. '<series-color-picker series="series" onToggleAxis="toggleAxis" onColorChange="colorSelected">' +
  46. '</series-color-picker>',
  47. openOn: 'hover',
  48. model: {
  49. series: series,
  50. toggleAxis: () => {
  51. ctrl.toggleAxis(series);
  52. },
  53. colorSelected: color => {
  54. ctrl.changeSeriesColor(series, color);
  55. },
  56. },
  57. });
  58. });
  59. }
  60. function toggleSeries(e) {
  61. const el = $(e.currentTarget);
  62. const index = getSeriesIndexForElement(el);
  63. const seriesInfo = seriesList[index];
  64. const scrollPosition = legendScrollbar.scroller.scrollTop;
  65. ctrl.toggleSeries(seriesInfo, e);
  66. legendScrollbar.scroller.scrollTop = scrollPosition;
  67. }
  68. function sortLegend(e) {
  69. const el = $(e.currentTarget);
  70. const stat = el.data('stat');
  71. if (stat !== panel.legend.sort) {
  72. panel.legend.sortDesc = null;
  73. }
  74. // if already sort ascending, disable sorting
  75. if (panel.legend.sortDesc === false) {
  76. panel.legend.sort = null;
  77. panel.legend.sortDesc = null;
  78. ctrl.render();
  79. return;
  80. }
  81. panel.legend.sortDesc = !panel.legend.sortDesc;
  82. panel.legend.sort = stat;
  83. ctrl.render();
  84. }
  85. function getTableHeaderHtml(statName) {
  86. if (!panel.legend[statName]) {
  87. return '';
  88. }
  89. let html = '<th class="pointer" data-stat="' + statName + '">' + statName;
  90. if (panel.legend.sort === statName) {
  91. const cssClass = panel.legend.sortDesc ? 'fa fa-caret-down' : 'fa fa-caret-up';
  92. html += ' <span class="' + cssClass + '"></span>';
  93. }
  94. return html + '</th>';
  95. }
  96. function render() {
  97. const legendWidth = legendElem.width();
  98. if (!ctrl.panel.legend.show) {
  99. elem.empty();
  100. firstRender = true;
  101. return;
  102. }
  103. if (firstRender) {
  104. elem.on('click', '.graph-legend-icon', openColorSelector);
  105. elem.on('click', '.graph-legend-alias', toggleSeries);
  106. elem.on('click', 'th', sortLegend);
  107. firstRender = false;
  108. }
  109. seriesList = data;
  110. elem.empty();
  111. // Set min-width if side style and there is a value, otherwise remove the CSS property
  112. // Set width so it works with IE11
  113. const width: any = panel.legend.rightSide && panel.legend.sideWidth ? panel.legend.sideWidth + 'px' : '';
  114. const ieWidth: any = panel.legend.rightSide && panel.legend.sideWidth ? panel.legend.sideWidth - 1 + 'px' : '';
  115. legendElem.css('min-width', width);
  116. legendElem.css('width', ieWidth);
  117. elem.toggleClass('graph-legend-table', panel.legend.alignAsTable === true);
  118. let tableHeaderElem;
  119. if (panel.legend.alignAsTable) {
  120. let header = '<tr>';
  121. header += '<th colspan="2" style="text-align:left"></th>';
  122. if (panel.legend.values) {
  123. header += getTableHeaderHtml('min');
  124. header += getTableHeaderHtml('max');
  125. header += getTableHeaderHtml('avg');
  126. header += getTableHeaderHtml('current');
  127. header += getTableHeaderHtml('total');
  128. }
  129. header += '</tr>';
  130. tableHeaderElem = $(header);
  131. }
  132. if (panel.legend.sort) {
  133. seriesList = _.sortBy(seriesList, series => {
  134. let sort = series.stats[panel.legend.sort];
  135. if (sort === null) {
  136. sort = -Infinity;
  137. }
  138. return sort;
  139. });
  140. if (panel.legend.sortDesc) {
  141. seriesList = seriesList.reverse();
  142. }
  143. }
  144. // render first time for getting proper legend height
  145. if (!panel.legend.rightSide || (panel.legend.rightSide && legendWidth !== legendRightDefaultWidth)) {
  146. renderLegendElement(tableHeaderElem);
  147. elem.empty();
  148. }
  149. renderLegendElement(tableHeaderElem);
  150. }
  151. function renderSeriesLegendElements() {
  152. const seriesElements = [];
  153. for (i = 0; i < seriesList.length; i++) {
  154. const series = seriesList[i];
  155. if (series.hideFromLegend(panel.legend)) {
  156. continue;
  157. }
  158. let html = '<div class="graph-legend-series';
  159. if (series.yaxis === 2) {
  160. html += ' graph-legend-series--right-y';
  161. }
  162. if (ctrl.hiddenSeries[series.alias]) {
  163. html += ' graph-legend-series-hidden';
  164. }
  165. html += '" data-series-index="' + i + '">';
  166. html += '<div class="graph-legend-icon">';
  167. html += '<i class="fa fa-minus pointer" style="color:' + series.color + '"></i>';
  168. html += '</div>';
  169. html +=
  170. '<a class="graph-legend-alias pointer" title="' + series.aliasEscaped + '">' + series.aliasEscaped + '</a>';
  171. if (panel.legend.values) {
  172. const avg = series.formatValue(series.stats.avg);
  173. const current = series.formatValue(series.stats.current);
  174. const min = series.formatValue(series.stats.min);
  175. const max = series.formatValue(series.stats.max);
  176. const total = series.formatValue(series.stats.total);
  177. if (panel.legend.min) {
  178. html += '<div class="graph-legend-value min">' + min + '</div>';
  179. }
  180. if (panel.legend.max) {
  181. html += '<div class="graph-legend-value max">' + max + '</div>';
  182. }
  183. if (panel.legend.avg) {
  184. html += '<div class="graph-legend-value avg">' + avg + '</div>';
  185. }
  186. if (panel.legend.current) {
  187. html += '<div class="graph-legend-value current">' + current + '</div>';
  188. }
  189. if (panel.legend.total) {
  190. html += '<div class="graph-legend-value total">' + total + '</div>';
  191. }
  192. }
  193. html += '</div>';
  194. seriesElements.push($(html));
  195. }
  196. return seriesElements;
  197. }
  198. function renderLegendElement(tableHeaderElem) {
  199. const legendWidth = elem.width();
  200. const seriesElements = renderSeriesLegendElements();
  201. if (panel.legend.alignAsTable) {
  202. const tbodyElem = $('<tbody></tbody>');
  203. tbodyElem.append(tableHeaderElem);
  204. tbodyElem.append(seriesElements);
  205. elem.append(tbodyElem);
  206. tbodyElem.wrap('<div class="graph-legend-scroll"></div>');
  207. } else {
  208. elem.append('<div class="graph-legend-scroll"></div>');
  209. elem.find('.graph-legend-scroll').append(seriesElements);
  210. }
  211. if (!panel.legend.rightSide || (panel.legend.rightSide && legendWidth !== legendRightDefaultWidth)) {
  212. addScrollbar();
  213. } else {
  214. destroyScrollbar();
  215. }
  216. }
  217. function addScrollbar() {
  218. const scrollRootClass = 'baron baron__root';
  219. const scrollerClass = 'baron__scroller';
  220. const scrollBarHTML = `
  221. <div class="baron__track">
  222. <div class="baron__bar"></div>
  223. </div>
  224. `;
  225. const scrollRoot = elem;
  226. const scroller = elem.find('.graph-legend-scroll');
  227. // clear existing scroll bar track to prevent duplication
  228. scrollRoot.find('.baron__track').remove();
  229. scrollRoot.addClass(scrollRootClass);
  230. $(scrollBarHTML).appendTo(scrollRoot);
  231. scroller.addClass(scrollerClass);
  232. const scrollbarParams = {
  233. root: scrollRoot[0],
  234. scroller: scroller[0],
  235. bar: '.baron__bar',
  236. track: '.baron__track',
  237. barOnCls: '_scrollbar',
  238. scrollingCls: '_scrolling',
  239. };
  240. if (!legendScrollbar) {
  241. legendScrollbar = baron(scrollbarParams);
  242. } else {
  243. destroyScrollbar();
  244. legendScrollbar = baron(scrollbarParams);
  245. }
  246. // #11830 - compensates for Firefox scrollbar calculation error in the baron framework
  247. scroller[0].style.marginRight = '-' + (scroller[0].offsetWidth - scroller[0].clientWidth) + 'px';
  248. legendScrollbar.scroll();
  249. }
  250. function destroyScrollbar() {
  251. if (legendScrollbar) {
  252. legendScrollbar.dispose();
  253. legendScrollbar = undefined;
  254. }
  255. }
  256. },
  257. };
  258. });