Merge pull request #14 from qlik-oss/caele-test

Simplification of Network chart data

gulpfile.js

@@ -17,6 +17,10 @@ gulp.task('zip-build', function(){
     .pipe(gulp.dest(settings.buildDestination));
 });
 
+gulp.task('add-assets', function(){
+  return gulp.src("./assets/**/*").pipe(gulp.dest(settings.buildDestination));
+});
+
 gulp.task('webpack-build', done => {
   webpack(webpackConfig, (error, statistics) => {
     const compilationErrors = statistics && statistics.compilation.errors;
@@ -42,7 +46,7 @@ gulp.task('update-qext-version', function () {
 });
 
 gulp.task('build',
-  gulp.series('remove-build-folder', 'webpack-build', 'update-qext-version', 'zip-build')
+  gulp.series('remove-build-folder', 'webpack-build', 'update-qext-version', 'add-assets', 'zip-build')
 );
 
 gulp.task('watch', () => new Promise((resolve, reject) => {

readme.md

@@ -8,9 +8,9 @@ Tested with Qlik Sense 2.2.3.
 ### Dimensions
 4 dimensions are mandatory :
 
-  1. node identifier
-  2. node label
-  3. node parent identifier
+  1. node identifier (consecutive numbers starting at 0)
+  2. node label (Any text)
+  3. node parent identifier (Refers to node indentifier)
   4. node group
 
 ### Measures
@@ -28,6 +28,8 @@ The measures are optional
 * Display Shadow : switch to enable shadow effects behind edge and nodes
 
 ### Sample
+A data sample can be found here: https://github.com/qlik-oss/network-vis-chart/blob/master/resources/Network%20data.xlsx
+
 QVF based on characters from Victor Hugo's novel , Les Misérables.
 ![Network chart](resources/network_chart_v1.png)
 

scripts/create-release.sh

@@ -3,7 +3,7 @@ set -o errexit
 
 echo "Creating release for version: $VERSION"
 echo "Artifact name: ./build/${3}_${VERSION}.zip"
-$HOME/bin/ghr -t ${ghoauth} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} -delete ${VERSION} "./build/${3}_${4}.zip"
+$HOME/bin/ghr -t ${ghoauth} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} ${VERSION} "./build/${3}_${4}.zip"
 
 
 # Usage

src/index.js

@@ -9,6 +9,30 @@ import "@babel/polyfill";
 import paint from './paint';
 import './styles/main.less';
 
+const dimDesc = [
+  "Node Identifier",
+  "Node Label",
+  "Node Parent",
+  "Node Group"
+];
+
+const dimLongDesc = [
+  "Node Identifier - a field in the dataset which should be presented as a node in the network diagram."
+  + " these control the actual elements presented in the network diagram.",
+  "Node Label - controls what field holds the data that described the nodes in the network"
+  + " diagram. The field content will be presented as label.",
+  "Node Parent - is used to determine the ancestor node for the individual nodes."
+  + " This field will be used for describing the relationships between network elements.",
+  "Node Group - is a field which describes groups of a node in the network."
+  + " This is used to apply the same color to several nodes."
+];
+
+const measureDesc = [
+  "Tooltip",
+  "Node size",
+  "Edge size"
+];
+
 const component = {
   initialProperties: {
     version: 1.0,
@@ -22,30 +46,62 @@ const component = {
     }
   },
   //property panel
+  data: {
+    dimensions: {
+      min: 3,
+      max: 4,
+      description(properties, index) {
+        return dimDesc[index];
+      }
+      /*
+      1. Dimension: Node ID, numeric (Event ID or else) or String
+      2. Dimension: Node Label
+      3. Dimension: Node Parent ID, numeric (Event ID or else) or String
+      4. Dimension: Node Cluster
+      */
+    },
+    measures: {
+      min: 0,
+      max: 3,
+      description(properties, index) {
+        return measureDesc[index];
+      }
+      /*
+      1. Measure: title text for tooltip (optional)
+      2. Measure: node value
+      3. Measure: edge value
+      */
+    }
+  },
   definition: {
     type: "items",
     component: "accordion",
     items: {
-      dimensions: {
-        uses: "dimensions",
-        min: 4,
-        max: 4
-        /*
-        1. Dimension: Node ID, numeric (Event ID or else) or String
-        2. Dimension: Node Label
-        3. Dimension: Node Parent ID, numeric (Event ID or else) or String
-        4. Dimension: Node Cluster
-        */
-      },
-      measures: {
-        uses: "measures",
-        min: 0,
-        max: 3
-        /*
-        1. Measure: title text for tooltip (optional)
-        2. Measure: node value
-        3. Measure: edge value
-        */
+      data: {
+        uses: "data",
+        items:{
+          dimensions:{
+            disabledRef: "",
+            items: {
+              helpDesc: {
+                component: 'text',
+                style: 'qlik-network-chart-italic-property',
+                label: function(properties, handler) {
+                  var index;
+                  handler.getDimensions().forEach((element, i) => {
+                    if(element.qDef.cId === properties.qDef.cId) {
+                      index = i;
+                    }
+                  });
+                  return dimLongDesc[index];
+                }
+              }
+            }
+          },
+          measures: {
+            disabledRef: ""
+          }
+        }
       },
       sorting: {
         uses: "sorting"
@@ -59,13 +115,14 @@ const component = {
         }
       },
       settings: {
-        uses: "settings",
+        type: "items",
+        label: "Settings",
         items: {
           edgeType: {
             ref: "edgeType",
             type: "string",
             component: "dropdown",
-            label: "Egde Type",
+            label: "Edge Type",
             options: [
               { value: 'dynamic' },
               { value: 'continuous' },
@@ -138,10 +195,11 @@ const component = {
     }
   },
   support: {
-    export: true
+    export: true,
+    snapshot: false
   },
   snapshot: {
-    canTakeSnapshot: true
+    canTakeSnapshot: false
   },
   paint: paint
 };

src/paint.js

@@ -3,20 +3,18 @@ import qlik from 'qlik';
 import { createTooltipHTML } from './tooltip';
 import { escapeHTML } from './utilities';
 
-const colorScheme = 'Diverging Classes';
-
 function isTextCellNotEmpty(c) {
   return (c.qText && !(c.qIsNull || c.qText.trim() == ''));
 }
 
-function paint ( $element, layout, qTheme, component ) {
-  const colorScale = qTheme.properties.scales
-    .find(scale => scale.name === colorScheme).scale;
-  const colors = colorScale[colorScale.length - 1];
+function getColor (index, colors) {
+  return colors[index % colors.length];
+}
 
-  function getColor (number) {
-    return colors[number % colors.length];
-  }
+function paint ( $element, layout, qTheme, component ) {
+  const colorScale = qTheme.properties.palettes.data[0];
+  const numDimensions = layout.qHyperCube.qDimensionInfo.length;
+  const numMeasures = layout.qHyperCube.qMeasureInfo.length;
 
   var qData = layout.qHyperCube.qDataPages[0],
     id = layout.qInfo.qId,
@@ -34,24 +32,30 @@ function paint ( $element, layout, qTheme, component ) {
 
     var dataSet = qData.qMatrix.map(function(e){
       const nodeName = e[1].qText;
-      const groupNumber = e[3].qText;
+      let groupNumber;
 
       const dataItem = {
-        id: e[0].qNum,
+        id: e[0].qText,
+        eNum: e[0].qElemNumber,
         label: nodeName,
-        group: groupNumber,
-        parentid : e[2].qNum
+        parentid : e[2].qText
       };
 
+      if(numDimensions === 4) {
+        groupNumber = e[3].qText;
+        dataItem.group = groupNumber;
+      }
+
       // optional measures set
-      if (e.length > 4) {
-        const tooltip = e[4];
+      if (numMeasures > 0) {
+        const tooltip = e[numDimensions];
 
         if (isTextCellNotEmpty(tooltip)) {
           const tooltipText = tooltip.qText;
           dataItem.title = escapeHTML(tooltipText);
-        } else {
-          const nodeMeasure = e[5].qText;
+        } else if(numMeasures > 1) {
+          // This part is a bit fishy and should be tested
+          const nodeMeasure = e[numDimensions+1].qText;
           dataItem.title = createTooltipHTML({
             name: nodeName,
             groupNumber,
@@ -60,17 +64,17 @@ function paint ( $element, layout, qTheme, component ) {
         }
       }
 
-      if (e.length > 5) {
-        if (e[5].qNum) {
+      if (numMeasures > 1) {
+        if (e[numDimensions+1].qNum) {
           // node value - to scale node shape size
           dataItem.nodeValue = e[5].qNum;
         }
       }
 
-      if (e.length > 6) {
-        if (e[6].qNum) {
+      if (numMeasures > 2) {
+        if (e[numDimensions+2].qNum) {
           // edge value - to scale edge width
-          dataItem.edgeValue = e[6].qNum;
+          dataItem.edgeValue = e[numDimensions+2].qNum;
         }
       }
 
@@ -84,7 +88,7 @@ function paint ( $element, layout, qTheme, component ) {
     const groups = {};
 
     for(let i = 0; i< dataSet.length; i++){
-      if (layout.displayEdgeLabel) {
+      if (layout.displayEdgeLabel && dataSet[i].edgeValue !== undefined) {
         edges.push({
           "from":dataSet[i].id,
           "to":dataSet[i].parentid,
@@ -105,17 +109,20 @@ function paint ( $element, layout, qTheme, component ) {
 
         var nodeItem = {
           id: dataSet[i].id,
+          eNum: dataSet[i].eNum,
           label: dataSet[i].label,
           title: dataSet[i].title,
           group: dataSet[i].group,
           value: dataSet[i].nodeValue
         };
         nodes.push(nodeItem); // create node
-        groups[nodeItem.group] = {
-          color: getColor(nodeItem.group)
-        };
       }
     }
+    const colors = colorScale.scale[Math.max(Object.keys(groups).length-1, colorScale.scale.length-1)];
+
+    Object.keys(groups).forEach(function(g,i) {
+      groups[g].color = getColor(i, colors);
+    });
 
     // create dataset for \\
     var data = {
@@ -174,9 +181,22 @@ function paint ( $element, layout, qTheme, component ) {
           var connectedNodes = network.getConnectedNodes(properties.nodes[0]);
           // append node to the array
           connectedNodes.push(properties.nodes[0]);
-
+          const toSelect = [];
+          connectedNodes.forEach(function(node) {
+            var id;
+            data.nodes.forEach(function(dataNode) {
+              // Find match, ignore null
+              if(dataNode.id === node && node !== "-") {
+                id = dataNode.eNum;
+              }
+            });
+            if(id !== undefined) {
+              // Remove duplicates
+              toSelect.indexOf(id) === -1 && toSelect.push(id);
+            }
+          });
           //Make the selections
-          component.backendApi.selectValues(0,connectedNodes,false);
+          component.backendApi.selectValues(0,toSelect,false);
         }
       }
     });

src/qlik-network-chart.qext

@@ -1,7 +1,7 @@
 {
 	"name" : "Network chart",
-	"description" : "Network chart",
-	"icon" : "extension",
+	"description" : "Displays hierarchical or relational dimensions as nodes and edges´, with measures to show the significance of its links.",
+	"icon" : "bubbles",
 	"type" : "visualization",
 	"version": "X.Y.Z",
 	"preview" : "network.png",

src/styles/main.less

@@ -11,3 +11,7 @@
   padding: 10px;
   max-width: 200px;
 }
+
+.qlik-network-chart-italic-property {
+  font-style: italic;
+}