Form

This is a preview of the documentation of Neodash version 3.0.2. For the latest release, refer to Neodash commercial 3.0.1.

A form report lets users run predefined, parameterized queries. It can consist of:

When creating a form, you write the Cypher® query that is called when the submit button is clicked. This query can then use the parameters specified as input.

Here is an example of a form:

Complex Form

The settings used to define the form are on the left, while the right shows a preview of the form as visible to the user.

Examples

Simple button

A form without parameters is a button that runs a specified query. One or more buttons can be used to perform simple operations in the graph. Here is an example of a button form that executes a query to increment a counter when it is pressed:

MERGE (c:Counter)
SET c.count = c.count+1
Button Form

A parameter and a button

To create a form with dynamic input, use both a parameter and a button. Here is an example of a form that deletes nodes from the graph when its button is pressed:

MATCH (p:Person)
WHERE p.name = $neodash_person_name
DETACH DELETE p
Simple Form

Parameters only

By hiding the submit button, a form can also be used as a space-efficient way to embed multiple parameter selectors. Disable the option "Has submit button" in the advanced settings of the report, and add two or more parameter selectors to the form.

Parameter-only Form

Advanced settings

Name Type Default value Description

Form Button Text

Text

Submit

Text displayed on the button that submits the form.

Reset Vutton Text

Text

Reset form

Text displayed on the button that resets the form to data entry mode.

Confirmation Message

Multiline text

Form submitted.

Text displayed to the user after the form is submitted successfully.

Clear parameters after submit

on/off

on

Clears all dashboard parameters in the form after submitting.

Has Submit Button

on/off

on

If set, lets the user submit the form with a button. Disabling turns the form into parameters-only mode.

Has Reset Vutton

on/off

on

If set, lets the user reset the form to enter more data.

Has Submit Message

on/off

on

If set, shows a submit message to the user after submitting the form. Otherwise, always stays in data entry mode.

Report Description

Markdown text

If set, adds a button to the report header that opens a pop-up. The pop-up contains the rendered Markdown from this setting.