Parameter select

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

Parameter select reports provide you with an easy way to add interactivity to your dashboards.

A parameter select report lets users set a Neo4j query parameter (e.g. $neodash_person_name) dynamically. This means that you can create your reports to show different data depending on the value of a parameter.

There are five types of parameter select reports:

Node property-based selectors
Relationship property-based selectors
Free text selectors
Date picker selectors
Custom query selectors

Examples

Node property select

A node property selector lets users choose a property from a node with a given label, to be used as a parameter in the dashboard.

Relationship property select

A relationship property selector lets users choose a property from a relationship with a given type, to be used as a parameter in the dashboard.

Free text select

A free text selectors lets users enter any string value, which can then be used as a parameter inside dashboard queries.

Date select

A date selector lets users specify dates using a calendar widget, or by entering a date format.

Custom query select

A custom query selectors lets you specify a custom selector widget, where user suggestions are populated based on an $input variable that is passed down into your custom query.

Advanced settings

Name Type Default value Description

Name	Type	Default value	Description
Clear Parameter on Field Reset	on/off	off	If set, removes the global parameter completely when the field is cleared. This may break some visualizations. Otherwise, sets the parameter value to `""` (empty string) when the input field is cleared.
Multiple Selection	on/off	off	If set, allows users to select multiple choices. Then, the parameter is an array of selections.
Manual Parameter Save	on/off	off	If set, adds a confirmation button in order to propagate the selection into the dashboard parameter.
Enable Manual Label/Property Name Specification	on/off	off	If enabled, does not enforce you to select a node label or property using an auto-complete field. Instead, you can enter any value. This is useful for large datasets where the autocomplete field is too slow to render.
Helper Text (Override)	Text	(none)	Text to show above the user input field. This overrides the autogenerated text from the node or relationship property pair.
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.

Clear Parameter on Field Reset

on/off

off

If set, removes the global parameter completely when the field is cleared. This may break some visualizations. Otherwise, sets the parameter value to "" (empty string) when the input field is cleared.

Multiple Selection

on/off

off

If set, allows users to select multiple choices. Then, the parameter is an array of selections.

Manual Parameter Save

on/off

off

If set, adds a confirmation button in order to propagate the selection into the dashboard parameter.

Enable Manual Label/Property Name Specification

on/off

off

If enabled, does not enforce you to select a node label or property using an auto-complete field. Instead, you can enter any value. This is useful for large datasets where the autocomplete field is too slow to render.

Helper Text (Override)

Text

(none)

Text to show above the user input field. This overrides the autogenerated text from the node or relationship property pair.

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.