allow x-axis label truncation (re #249)

mozilla · Sep 6, 2018 · f2d5cd2 · f2d5cd2
1 parent 6362537
commit f2d5cd2
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 2 deletions.
diff --git a/client/app/visualizations/chart/chart-editor.html b/client/app/visualizations/chart/chart-editor.html
@@ -196,6 +196,12 @@
         <i class="input-helper"></i> Show Labels
       </label>
     </div>
+
+    <div class="form-group">
+      <label class="control-label">Label Length</label>
+      <input name="x-axis-label-length" type="number" class="form-control" ng-model="options.xAxisLabelLength">
+      <span class="info">How many characters should X Axis Labels be truncated at in the legend?</span>
+    </div>
   </div>
 
   <div ng-if="currentTab == 'yAxis'" class="m-t-10 m-b-10">

diff --git a/client/app/visualizations/chart/index.js b/client/app/visualizations/chart/index.js
@@ -282,6 +282,19 @@ function ChartEditor(ColorPalette, clientConfig) {
         scope.options.legend = { enabled: true };
       }
 
+      scope.$watch('options.globalSeriesType', (newType, oldType) => {
+        const defaultXAxisLength = 10;
+        if (!has(scope.options, 'xAxisLabelLength')) {
+          scope.options.xAxisLabelLength = defaultXAxisLength;
+        }
+        if (oldType !== newType) {
+          scope.options.xAxisLabelLength = defaultXAxisLength;
+          if (newType === 'pie') {
+            scope.options.xAxisLabelLength = 300;
+          }
+        }
+      }, true);
+
       if (scope.columnNames) {
         each(scope.options.columnMapping, (value, key) => {
           if (scope.columnNames.length > 0 && !includes(scope.columnNames, key)) {

diff --git a/client/app/visualizations/chart/plotly/utils.js b/client/app/visualizations/chart/plotly/utils.js
@@ -209,6 +209,19 @@ function getUnifiedXAxisValues(seriesList, sorted) {
   return sorted ? sortBy(result, identity) : result;
 }
 
+const DEFAULT_XAXIS_LABEL_LENGTH = 300;
+
+// We only truncate category x-axis labels because the other types
+// are correctly formatted by Plotly.
+function truncateCategoryAxis(oldXLabel, options) {
+  const xAxisLabelLength = parseInt(options.xAxisLabelLength, 10) || DEFAULT_XAXIS_LABEL_LENGTH;
+
+  if (options && options.xAxis && options.xAxis.type === 'category') {
+    return String(oldXLabel).substr(0, xAxisLabelLength);
+  }
+  return oldXLabel;
+}
+
 function preparePieData(seriesList, options) {
   const {
     cellWidth, cellHeight, xPadding, yPadding, cellsInRow, hasX,
@@ -260,9 +273,17 @@ function preparePieData(seriesList, options) {
       });
     });
 
+    const colorPalette = ColorPaletteArray.slice();
     return {
       values: map(serie.data, i => i.y),
-      labels: map(serie.data, row => (hasX ? normalizeValue(row.x) : `Slice ${index}`)),
+      labels: map(serie.data, (row, rowIdx) => {
+        const rowX = hasX ? truncateCategoryAxis(normalizeValue(row.x), options) : `Slice ${index}`;
+        const rowOpts = options.seriesOptions[rowX];
+        if (rowOpts) {
+          colorPalette[rowIdx] = rowOpts.color;
+        }
+        return rowX;
+      }),
       type: 'pie',
       hole: 0.4,
       marker: {
@@ -317,7 +338,7 @@ function prepareChartData(seriesList, options) {
     const yValues = [];
     const yErrorValues = [];
     each(data, (row) => {
-      const x = normalizeValue(row.x);
+      const x = truncateCategoryAxis(normalizeValue(row.x), options);
       const y = normalizeValue(row.y);
       const yError = normalizeValue(row.yError);
       const size = normalizeValue(row.size);