NeoDash

https://neo4j.com/labs/neodash/2.4/
Admin
NeoDash is an open-source, low-code dashboard builder for Neo4j that enables visualization of graph...
Tokens:9,112
Snippets:159
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Basic Markdown Report Example

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/markdown

This snippet demonstrates basic Markdown formatting, including headings, bold text, and embedding an image using a URL.

```markdown
## Hello there!
I'm a **Markdown** file.

Check out this cool image:

![image](https://hips.hearstapps.com/hmg-prod.s3.amazonaws.com/images/how-to-keep-ducks-call-ducks-1615457181.jpg?resize=240:*)
```

--------------------------------

### Example Raw JSON Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/raw-json

This Cypher query demonstrates a basic example of what can be returned by the Raw JSON report. It is typically used for debugging purposes.

```cypher
MATCH (n)
RETURN COUNT(n)
```

--------------------------------

### NeoDash Dashboard State Example

Source: https://neo4j.com/labs/neodash/2.4/developer-guide/state-management

An example of the 'dashboard' state object, detailing a simple dashboard with a title, version, settings, and a single page containing a report.

```json
{
  "dashboard": {
    "title": "A Simple Dashboard",
    "version": "2.4",
    "settings": {
      "pagenumber": 0,
      "editable": true,
      "fullscreenEnabled": true,
      "parameters": {
          "neodash_person_name": "Bob"
       }
    },
    "pages": [
        {
          title: “My Page”
          reports: [
            {
                "title": "My Report",
                "query": "MATCH (n)-[e]->(m) RETURN n,e,m",
                "type": "graph",
                "x": "1",
                "y": "2",
                "width": "6",
                "height": "3",
                "settings": {
                    "nodeColorSchmeme": "blue"
                }
            }
        ]
     }
    ]
  }
}
```

--------------------------------

### Rule-Based Styling Condition Example

Source: https://neo4j.com/labs/neodash/2.4/user-guide/extensions/rule-based-styling

Defines a rule to set the color of 'Warning' nodes to red when their 'level' property is 'critical'. This demonstrates the basic IF-THEN syntax for rule-based styling.

```text
IF Warning.level = "critical" THEN 'Node Color' = "red"
```

--------------------------------

### Basic Table Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/table

A simple Cypher query to return movie titles, release years, and the count of actors for each movie. This is a fundamental example for populating a table report.

```cypher
MATCH (n:Movie)<-[:ACTED_IN]-(p:Person)
RETURN n.title AS Title, n.released AS Released, count(p) as Actors
```

--------------------------------

### Basic Gauge Chart Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/gauge-chart

This Cypher query retrieves the CPU load percentage, scaled to be between 0 and 100, suitable for direct use with a gauge chart.

```cypher
MATCH (c:CPU)
WHERE c.id = 1
RETURN c.load_percentage * 100
```

--------------------------------

### NeoDash Application State Details

Source: https://neo4j.com/labs/neodash/2.4/developer-guide/state-management

The 'application' state object contains UI-related information, connection details, and operational settings for the NeoDash application.

```json
"application": {
    "notificationTitle": null,
    "notificationMessage": null,
    "connectionModalOpen": false,
    "welcomeScreenOpen": true,
    "aboutModalOpen": true,
    "connection": {
      "protocol": "neo4j+s",
      "url": "localhost",
      "port": "",
      "database": "",
      "username": "neo4j",
      "password": "************"
    },
    "desktopConnection": null,
    "connected": false,
    "dashboardToLoadAfterConnecting": null,
    "waitForSSO": false,
    "standalone": false,
    "oldDashboard": null,
    "ssoEnabled": false,
    "ssoProviders": [],
    "ssoDiscoveryUrl": "https://example.com",
    "standaloneProtocol": "neo4j+s",
    "standaloneHost": "localhost",
    "standalonePort": "7687",
    "standaloneDatabase": "neo4j",
    "standaloneDashboardName": "My Dashboard",
    "standaloneDashboardDatabase": "dashboards",
    "standaloneDashboardURL": "dashboards",
    "loggingMode": "0",
    "loggingDatabase": "logging",
    "standaloneAllowLoad": false,
    "standaloneLoadFromOtherDatabases ": false,
    "standaloneMultiDatabase": false,
    "standaloneDatabaseList": "neo4j",
    "notificationIsDismissable": null
}
```

--------------------------------

### Simple Button Form Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/form

Use this Cypher query for a form that acts as a simple button to perform an operation, like incrementing a counter.

```cypher
MERGE (c:Counter)
SET c.count = c.count+1
```

--------------------------------

### Basic Line Chart (Actors born by decade)

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/line-chart

Use this Cypher query to create a basic line chart showing the count of people born in each decade. Ensure the X-axis values (Decade) are sorted in ascending order.

```cypher
MATCH (p:Person)
RETURN  (p.born/10)*10 as Decade, COUNT(p) as People
ORDER BY Decade ASC
```

--------------------------------

### Form Query with Parameter

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/form

This Cypher query demonstrates how to use a parameter to dynamically delete nodes from the graph based on user input.

```cypher
MATCH (p:Person)
WHERE p.name = $neodash_person_name
DETACH DELETE p
```

--------------------------------

### Display Nodes and Relationships on Map - Cypher

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/map

Visualize both nodes and the relationships between them on the map. This query returns breweries and the connections between them.

```cypher
MATCH (b:Brewery)-[e]->(b2:Brewery)
RETURN b, e, b2
```

--------------------------------

### Basic Radar Chart Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/radar

This Cypher query retrieves skill data for multiple players to be visualized in a radar chart. Ensure the player names and skill relationships match your graph schema.

```cypher
MATCH (s:Skill)
MATCH (:Player{name:"Messi"})-[h1:HAS_SKILL]->(s)
MATCH (:Player{name:"Mbappe"})-[h2:HAS_SKILL]->(s)
MATCH (:Player{name:"Benzema"})-[h3:HAS_SKILL]->(s)
MATCH (:Player{name:"C Ronaldo"})-[h4:HAS_SKILL]->(s)
MATCH (:Player{name:"Lewandowski"})-[h5:HAS_SKILL]->(s)
RETURN s.name as Skill, h1.value as Messi, h2.value as Mbappe, h3.value as Benzema,
                        h4.value as `C Ronaldo`, h5.value as Lewandowski
```

--------------------------------

### Basic Circle Packing Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/circle-packing

This Cypher query retrieves hierarchical data suitable for a circle packing chart. It defines a path from a 'Company' to 'Department' nodes and calculates the total employees for each department.

```cypher
MATCH path=(:Company{name:'NeoDash'})-[:HAS_DEPARTMENT*]->(:Department)
WITH nodes(path) as no
WITH  no, last(no) as leaf
WITH  [n IN no[..-1] | n.name] AS result, sum(leaf.employees) as val
RETURN result, val
```

--------------------------------

### Simple Bar Chart Cypher Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/bar-chart

Use this Cypher query to create a simple bar chart. It returns a title for the bars and a count of associated people.

```cypher
MATCH (p:Person)-[e]->(m:Movie)
RETURN m.title as Title, COUNT(p) as People
```

--------------------------------

### Generate Artificial Map Data - Cypher

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/map

Create artificial nodes and relationships by returning dictionaries. This is useful when the visualization expects nodes/relationships but you are providing custom data structures.

```cypher
MATCH (l1:Location)<--(a:Person),
      (a:Person)-[:KNOWS]-(b:Person),
      (b:Person)-->(l2:Location)
RETURN {id: a.name, label: "Person", point: l1.point},
       {id: b.name, label: "Person", point: l2.point},
       {start: a.name, end: b.name, type: "KNOWS", id: 1}
```

--------------------------------

### NeoDash Application State Structure

Source: https://neo4j.com/labs/neodash/2.4/developer-guide/state-management

The top-level JSON structure encapsulating the entire application state, including dashboard and application-specific data.

```json
{
  "dashboard": {
    "title": "My Dashboard Name",
    "version": "2.4",
    "settings": {
      "pagenumber": 0,
      "editable": true,
      "parameters": {
          "...": "..."
       }
    },
    "pages": [
        ...
    ]
  },
  "application": {
        ...
   },
  "version": "2.1.0"
}
```

--------------------------------

### Display Nodes on Map - Cypher

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/map

Return nodes with spatial properties to visualize them on the map. Ensure nodes have location data stored.

```cypher
MATCH (b:Brewery)
RETURN b
```

--------------------------------

### Basic Sunburst Chart Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/sunburst

This Cypher query retrieves hierarchical data suitable for a Sunburst chart. It defines a path from a 'Company' to 'Department' nodes and aggregates employee counts.

```cypher
MATCH path=(:Company{name:'NeoDash'})-[:HAS_DEPARTMENT*]->(:Department)
WITH nodes(path) as no
WITH no, last(no) as leaf
WITH  [n IN no[..-1] | n.name] AS result, sum(leaf.employees) as val
RETURN result, val
```

--------------------------------

### Basic Pie Chart Cypher Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/pie-chart

Use this Cypher query to return categories and their associated counts for a basic pie chart. Ensure your query returns a text field for the category and a numeric field for the value.

```cypher
Match (p:Person)-[e]->(m:Movie)
RETURN m.title as Title, COUNT(p) as People
LIMIT 8
```

--------------------------------

### Donut Chart Cypher Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/pie-chart

This Cypher query demonstrates how to create data suitable for a donut chart by filtering for a specific movie and returning the count of different roles. This query is useful for showing the distribution of a specific category.

```cypher
MATCH (p:Person)-[e]->(m:Movie)
WHERE m.title = "Cloud Atlas"
WITH TYPE(e) as Role
RETURN Role, COUNT(Role) as Count
```

--------------------------------

### Display Text Value with Fraud Count

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/single-value

This query returns a person's name and the count of fraudulent transactions they created, ordered by the count. It's useful for identifying individuals with the most fraud.

```cypher
// Who's the biggest Fraudster?
MATCH (n:Person)-[:CREATED]->(t:Transaction{fraud:true})
RETURN n.name, COUNT(t)
ORDER BY COUNT(t) DESC
```

--------------------------------

### Table with Nodes and Collections

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/table

This Cypher query returns movie nodes along with a collection of actor names for each movie. It demonstrates how to display Neo4j native data types and collections within a table.

```cypher
MATCH (n:Movie)<-[:ACTED_IN]-(p:Person)
RETURN n, collect(p.name) as actors LIMIT 200
```

--------------------------------

### Use Dashboard Parameters in Markdown

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/markdown

To use dashboard parameters within Markdown, enable the 'Replace global parameters in Markdown' setting. Variables should be enclosed in backticks.

```markdown
== This is a title
My variable is equal to `$neodash_person_object['name']`
```

--------------------------------

### Multi-Line Chart (Actors born & movies released by decade)

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/line-chart

This Cypher query generates a multi-line chart to display both the count of people born and the number of movies released per decade. It requires sorting the X-axis values (Decade) in ascending order.

```cypher
MATCH (p:Person)
WITH  (p.born/10)*10 as Decade, COUNT(p) as People
ORDER BY Decade ASC
MATCH (m:Movie)
WHERE (m.released/10)*10 = Decade
RETURN Decade, People, COUNT(DISTINCT m) as Movies
```

--------------------------------

### Gantt Chart Data Retrieval

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/gantt

This Cypher query retrieves nodes and their relationships to be visualized in the Gantt chart. Ensure that the 'startDate', 'endDate', and 'title' properties are specified in the report's advanced settings.

```cypher
MATCH (a:Activity)-[r:FOLLOWS]->(a2:Activity)
RETURN a, r, a2
```

--------------------------------

### Basic Sankey Chart Cypher Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/sankey

This Cypher query is used to generate data for a basic Sankey chart. Ensure a 'Relationship Property' is set in the advanced settings for correct link thickness.

```cypher
MATCH (p:Person)-[r:RATES]->(m:Movie)
RETURN p, r, m
```

--------------------------------

### Basic Area Map Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/areamap

This Cypher query retrieves country codes and the total count of employees living in those countries, suitable for basic area map visualization.

```cypher
MATCH (:Company{name:'NeoDash'})-[:HAS_DEPARTMENT]->(:Department)<-[:IN_DEPARTMENT]-(e:Employee),
(e)-[:LIVES]->(city:City)-[:IN_COUNTRY]->(country:Country)
WITH city, country
CALL {
    WITH country
    RETURN country.countryCode as code, count(*) as value
    UNION
    WITH city
    RETURN city.countryCode as code, count(*) as value
}
WITH code, sum(value) as totalCount
RETURN code,totalCount
```

--------------------------------

### Basic Choropleth Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/choropleth

This Cypher query retrieves distinct country codes (ISO Alpha-3) and counts associated entities, suitable for rendering a basic choropleth map.

```cypher
MATCH p=(n:Wine)-[:IS_FROM|PART_OF*]->(c:Country)
WITH DISTINCT c.iso3 as country, count(DISTINCT n) as wines
RETURN country, wines
```

--------------------------------

### Stacked Bar Chart Cypher Query

Source: https://neo4j.com/labs/neodash/2.4/user-guide/reports/bar-chart

This Cypher query is used for stacked bar charts. It returns a title, a count of people, and the type of relationship (role) for grouping.

```cypher
Match (p:Person)-[e]->(m:Movie)
RETURN m.title AS Title, COUNT(p) as People, type(e) as Role
```
Tokens:
Raw