Fixed behavior when completion values display in tooltip though completion field doesn't have any field (#88)

Author: savvinsergey

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.8.4
+ * Fixed behavior when completion values display in tooltip though
+  the %Completion doesn't have any field   
 ## 1.8.3
  * Reverted 1.8.2 fix caused selection issue.
  * Fixed viewport clearing if no data in dataView

package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-gantt",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "description": "A Gantt chart is a type of bar chart which illustrates a project timeline or schedule. The Gantt Chart visual shows the Tasks, Start Dates, Durations, % Complete, and Resources for a project. The Gantt Chart visual can be used to show current schedule status using percent-complete shadings and a vertical \"TODAY\" line. The Legend may be used to group or filter tasks based upon data values.",
   "repository": {
     "type": "git",

pbiviz.json

@@ -4,7 +4,7 @@
     "displayName": "Gantt",
     "guid": "Gantt1448688115699",
     "visualClassName": "Gantt",
-    "version": "1.8.3",
+    "version": "1.8.4",
     "description": "A Gantt chart is a type of bar chart which illustrates a project timeline or schedule. The Gantt Chart visual shows the Tasks, Start Dates, Durations, % Complete, and Resources for a project. The Gantt Chart visual can be used to show current schedule status using percent-complete shadings and a vertical \"TODAY\" line. The Legend may be used to group or filter tasks based upon data values.",
     "supportUrl": "http://community.powerbi.com",
     "gitHubUrl": "https://github.com/Microsoft/powerbi-visuals-gantt"

src/gantt.ts

@@ -531,7 +531,6 @@ module powerbi.extensibility.visual {
         */
         private static getTooltipInfo(
             task: Task,
-            locale: string,
             formatters: GanttChartFormatters,
             durationUnit: string): VisualTooltipDataItem[] {
 
@@ -558,10 +557,12 @@ module powerbi.extensibility.visual {
                 value: durationLabel
             });
 
-            tooltipDataArray.push({
-                displayName: "Completion",
-                value: formatters.completionFormatter.format(task.completion)
-            });
+            if (task.completion) {
+                tooltipDataArray.push({
+                    displayName: "Completion",
+                    value: formatters.completionFormatter.format(task.completion)
+                });
+            }
 
             if (task.resource) {
                 tooltipDataArray.push({ displayName: "Resource", value: task.resource });
@@ -704,6 +705,7 @@ module powerbi.extensibility.visual {
             values.Task.forEach((categoryValue: PrimitiveValue, index: number) => {
                 let duration: number = settings.general.durationMin;
                 let durationUnit: string = settings.general.durationUnit;
+                let taskProgressShow: boolean = settings.taskCompletion.show;
                 let color: string = taskColor || Gantt.DefaultValues.TaskColor;
                 let completion: number = 0;
                 let taskType: TaskTypeMetadata = null;
@@ -737,14 +739,17 @@ module powerbi.extensibility.visual {
                             }
 
                             completion = ((group.Completion && group.Completion.values[index])
-                                && Gantt.convertToDecimal(group.Completion.values[index] as number)) || 0;
+                                && taskProgressShow
+                                && Gantt.convertToDecimal(group.Completion.values[index] as number)) || null;
 
-                            if (completion < Gantt.ComplectionMin) {
-                                completion = Gantt.ComplectionMin;
-                            }
+                            if (completion !== null) {
+                                if (completion < Gantt.ComplectionMin) {
+                                    completion = Gantt.ComplectionMin;
+                                }
 
-                            if (completion > Gantt.ComplectionMax) {
-                                completion = Gantt.ComplectionMax;
+                                if (completion > Gantt.ComplectionMax) {
+                                    completion = Gantt.ComplectionMax;
+                                }
                             }
                         }
                     });
@@ -814,7 +819,7 @@ module powerbi.extensibility.visual {
                     } while (task.daysOffList.length && datesDiff - DaysInAWeekend > DaysInAWeek);
                 }
 
-                task.tooltipInfo = Gantt.getTooltipInfo(task, host.locale, formatters, durationUnit);
+                task.tooltipInfo = Gantt.getTooltipInfo(task, formatters, durationUnit);
 
                 tasks.push(task);
             });

test/visualTest.ts

@@ -319,6 +319,48 @@ module powerbi.extensibility.visual.test {
                 });
             });
 
+            describe("Verify tooltips have no completion info", () => {
+                function checkCompletionEqualNull(done: () => void) {
+                    visualBuilder.updateRenderTimeout(dataView, () => {
+                        let tasks = d3.select(visualBuilder.element.get(0)).selectAll(".task").data();
+                        for (let task of tasks) {
+                            for (let tooltipInfo of task.tooltipInfo) {
+                                if (tooltipInfo.displayName === GanttData.ColumnCompletePrecntege) {
+                                    expect(tooltipInfo.value).toEqual(null);
+                                }
+                            }
+                        }
+
+                        done();
+                    });
+                }
+
+                it("TaskCompletion setting is switched off", (done) => {
+                    dataView = defaultDataViewBuilder.getDataView([
+                        GanttData.ColumnTask,
+                        GanttData.ColumnStartDate,
+                        GanttData.ColumnDuration,
+                        GanttData.ColumnCompletePrecntege]);
+
+                    dataView.metadata.objects = {
+                        taskCompletion: {
+                            show: false
+                        }
+                    };
+
+                    checkCompletionEqualNull(done);
+                });
+
+                it("Completion data unavailable", (done) => {
+                    dataView = defaultDataViewBuilder.getDataView([
+                        GanttData.ColumnTask,
+                        GanttData.ColumnStartDate,
+                        GanttData.ColumnDuration]);
+
+                    checkCompletionEqualNull(done);
+                });
+            });
+
             it("Verify Font Size set to default", (done) => {
                 visualBuilder.updateRenderTimeout(dataView, () => {
                     let element = d3.select(visualBuilder.element.get(0));
@@ -710,18 +752,11 @@ module powerbi.extensibility.visual.test {
             });
 
             describe("Task Completion", () => {
-                beforeEach(() => {
-                    dataView.metadata.objects = {
-                        taskCompletion: {
-                            show: true
-                        }
-                    };
-                });
-
                 it("color", (done) => {
                     let color: string = GanttBuilder.getRandomHexColor();
                     dataView.metadata.objects = {
                         taskCompletion: {
+                            show: true,
                             fill: GanttBuilder.getSolidColorStructuralObject(color)
                         }
                     };