2.1.5 Release (#195)

## NeoDash 2.1.5
Added *New* Sankey charts:
- Visualize nodes and relationships as a flow diagram.
- Select a customizable flow value from relationship properties.
- Configure a variety of style customizations.

Parameter select:
- Fixed bug where values would randomly be deleted after changing the parameter.
- Added option to customize the number of suggested values when a user enters (part of) a property value.
- Added option to customize search type (CONTAINS, STARTS WITH, or ENDS WITH).
- Added option to enable/disable case-sensitive search.
- Added option to enable/disable removing duplicate suggestions.

Miscellaneous:
- Extended documentation with examples on running NeoDash in Kubernetes.
- Fixed issue where duplicate database names were visible when running NeoDash on an on-prem Neo4j cluster.

Author: nielsdejong

.github/workflows/master-deployment.yml

@@ -71,7 +71,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.1.4
+      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.1.5
  build-npm:
    needs: build-test
    runs-on: ubuntu-latest

.gitignore

@@ -4,7 +4,6 @@
 *.cert
 *.passphrase
 node_modules
-package-lock.json
 build
 target
 /node_modules

Dockerfile

@@ -38,4 +38,4 @@ RUN chown -R nginx:nginx /usr/share/nginx/html/
 USER nginx
 EXPOSE 5005
 HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
-LABEL version="2.1.4"
+LABEL version="2.1.5"

changelog.md

@@ -1,3 +1,25 @@
+## NeoDash 2.1.5
+Added *New* Sankey charts:
+- Visualize nodes and relationships as a flow diagram.
+- Select a customizable flow value from relationship properties.
+- Configure a variety of style customizations.
+
+Parameter select:
+- Fixed bug where values would randomly be deleted after changing the parameter.
+- Added option to customize the number of suggested values when a user enters (part of) a property value.
+- Added option to customize search type (CONTAINS, STARTS WITH, or ENDS WITH).
+- Added option to enable/disable case-sensitive search.
+- Added option to enable/disable removing duplicate suggestions.
+
+Miscellaneous:
+- Extended documentation with examples on running NeoDash in Kubernetes.
+- Fixed issue where duplicate database names were visible when running NeoDash on an on-prem Neo4j cluster.
+
+
+## NeoDash 2.1.4
+Added hotfix for missing function in map visualization (https://github.com/neo4j-labs/neodash/issues/183).
+
+
 ## NeoDash 2.1.3
 The 2.1.3 release contains updates to the map visualization, as well as a new Choropleth map report type.
 Several usability improvements were also added, including fixing all links into the new documentation pages.

cypress/fixtures/cypher_queries.js

@@ -1,4 +1,4 @@
-import { tableCypherQuery, barChartCypherQuery, mapChartCypherQuery, sunburstChartCypherQuery, iFrameText, markdownText, loadDashboardURL } from "../fixtures/cypher_queries"
+import { tableCypherQuery, barChartCypherQuery, mapChartCypherQuery, sunburstChartCypherQuery, iFrameText, markdownText, loadDashboardURL, sankeyChartCypherQuery } from "../fixtures/cypher_queries"
 
 // Ignore warnings that may appear when using the Cypress dev server
 Cypress.on('uncaught:exception', (err, runnable) => {
@@ -131,6 +131,11 @@ describe('NeoDash E2E Tests', () => {
         cy.get('main .react-grid-item:eq(2) .MuiCardContent-root svg > g > g').should('have.length', 6)
     })
 
+    it('creates a sankey chart report', () => {
+        createReportOfType('Sankey Chart', sankeyChartCypherQuery, true)
+        cy.get('main .react-grid-item:eq(2) .MuiCardContent-root svg > g > path').should('have.attr', 'fill-opacity', 0.5)
+    })
+
     it('creates a raw json report', () => {
         createReportOfType('Raw JSON', barChartCypherQuery)
         cy.get('main .react-grid-item:eq(2) .MuiCardContent-root textarea:nth-child(1)').should(($div) => {
@@ -192,11 +197,16 @@ describe('NeoDash E2E Tests', () => {
 
 })
 
-function createReportOfType(type, query) {
+function createReportOfType(type, query, fast=false) {
     cy.get('main .react-grid-item:eq(2) button').click()
     cy.get('main .react-grid-item:eq(2) button[aria-label="settings"]').click()
     cy.get('main .react-grid-item:eq(2) .MuiInputLabel-root').contains("Type").next().click()
     cy.contains(type).click()
-    cy.get('main .react-grid-item:eq(2) .ReactCodeMirror').type(query, { parseSpecialCharSequences: false })
+    if(fast){
+        cy.get('main .react-grid-item:eq(2) .ReactCodeMirror').type(query, { delay:1, parseSpecialCharSequences: false })
+    }else{
+        cy.get('main .react-grid-item:eq(2) .ReactCodeMirror').type(query, { parseSpecialCharSequences: false })
+    }
+
     cy.get('main .react-grid-item:eq(2) button[aria-label="save"]').click()
 }

cypress/integration/start_page.spec.js

@@ -12,7 +12,9 @@
 *** xref:user-guide/reports/sunburst.adoc[Sunburst]
 *** xref:user-guide/reports/circle-packing.adoc[Circle Packing]
 *** xref:user-guide/reports/treemap.adoc[Treemap]
+*** xref:user-guide/reports/sankey.adoc[Sankey Chart]
 *** xref:user-guide/reports/map.adoc[Map]
+*** xref:user-guide/reports/choropleth.adoc[Choropleth]
 *** xref:user-guide/reports/single-value.adoc[Single Value]
 *** xref:user-guide/reports/raw-json.adoc[Raw JSON]
 *** xref:user-guide/reports/parameter-select.adoc[Parameter Select]

docs/modules/ROOT/images/sankey.png

@@ -69,3 +69,38 @@ After building, you can run the image with:
 ....
 docker run -it –rm -p 5005:5005 neodash
 .... 
+
+== Run on Kubernetes
+
+An example of a pod definition YAML file to create a NeoDash pod in a cluster:
+
+....
+apiVersion: v1
+kind: Pod
+metadata:
+  name: neodash
+  labels:
+    project: neodash
+spec:
+  containers:
+    - name: neodash
+      image: nielsdejong/neodash:latest
+      ports:
+        - containerPort: 5005
+....
+
+
+Creating a Kubernetes service to expose the application:
+....
+apiVersion: v1
+kind: Service
+metadata:
+    name: neodash-svc
+spec:
+    type: LoadBalancer
+    ports:
+    - port: 5005
+      targetPort: 5005
+    selector:
+      project: neodash
+....

docs/modules/ROOT/nav.adoc

@@ -0,0 +1,67 @@
+= Sankey Chart
+
+A Sankey visualization will generate a flow diagram from nodes and links.
+Beware that cyclic dependencies are not supported.
+
+== Examples
+
+=== Basic Sankey Chart
+For a sankey chart to use the correct relationship weights - it is mandatory to set a 'Relationship Property' in the report's advanced settings.
+
+[source,cypher]
+----
+MATCH (p:Person)-[r:RATES]->(m:Movie)
+RETURN p, r, m
+----
+
+image::sankey.png[Sankey Chart]
+
+
+== Advanced Settings
+
+[width="100%",cols="15%,2%,6%,77%",options="header",]
+|===
+|Name |Type |Default Value |Description
+|Show Legend |on/off |off |If enabled, shows a legend on the bottom of
+the visualization.
+
+|Enable interactivity |on/off |on |If enabled, turn on animations when a
+user hovers over a node or link.
+
+|Relationship Property |text | value | Name of the property with an integer value that is going
+to be used to determine thickness of links.
+
+|Color Scheme |List | |The color scheme to use for the slices. Colors
+are assigned automatically (consecutively) to the different categories
+returned by the Cypher query.
+
+|Layout |List |horizontal |Sankey layout direction.
+
+|Label Position |List |inside |Control sankey label position.
+
+|Label Orientation |List |horizontal |Control sankey label orientation.
+
+|Node Border Width (px) |number |0 |Controls Node border width.
+
+|Node Spacing (px) |number |18 |Controls spacing between nodes at an identical level (px).
+
+|Node thickness (px) |number |18 |Controls Node thickness.
+
+|Margin Left (px) |number |24 |The margin in pixels on the left side of
+the visualization.
+
+|Margin Right (px) |number |24 |The margin in pixels on the right side
+of the visualization.
+
+|Margin Top (px) |number |24 |The margin in pixels on the top side of
+the visualization.
+
+|Margin Bottom (px) |number |40 |The margin in pixels on the bottom side
+of the visualization.
+
+|Auto-run query |on/off |on |when activated automatically runs the query
+when the report is displayed. When set to `off', the query is displayed
+and will need to be executed manually.
+|===
+
+