Skip to content

Dashboard - Parameters and Filters #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: neo4j-dashboards-in-aura
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ Generic Start
*** xref:dashboards/visualizations/table.adoc[Table]
*** xref:dashboards/visualizations/linechart.adoc[Line chart]
*** xref:dashboards/visualizations/barchart.adoc[Bar chart]
//** xref:dashboards/advanced-features/index.adoc[Advanced features]
//*** xref:dashboards/advanced-features/parameters.adoc[Parameters and interactivity]
** xref:dashboards/advanced-features/index.adoc[Advanced features]
*** xref:dashboards/advanced-features/filters-and-parameters.adoc[Filters and parameters]
//*** xref:dashboards/advanced-features/rule-based-styling.adoc[Rule-based styling]
//*** xref:dashboards/advanced-features/report-actions.adoc[Report actions]
//** xref:dashboards/integrations.adoc[Integrations]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
= Filters and parameters
:description: Use parameters in your dashboards to further customize queries or use them in filters for node and relationship properties.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe 'customize' should be 'generalize' / 'optimize'?



== Parameters

Parameters are associated with a specific dashboard.
Each parameter has a value and type both of which you can set initially.

Display the parameters of a dashboard by using the parentheses button to show the **Parameters** drawer.

.The parameters drawer
image::dashboards/parameters-drawer.png[]

The drawer shows the dashboard parameters in alphabetical order.
Each parameter has an icon next to it hinting at its data type:

* A text icon for strings,
* A hashtag icon for numbers,
* A calendar icon for dates,
* A filter icon for unspecified data types.


=== Creating a parameter

. From the **Parameters** drawer, use the **Add** button.
. In the dialog, enter a parameter name, select a data type and optionally an initial value for the parameter, then **Save**.


=== Editing a parameter

. From the **Parameters** drawer, hover over the parameter you wish to edit.
. Use the pen button that appears.
. In the dialog, edit the parameter name, data type and/or initial value, then **Save**.


=== Using a parameter in a query

To use a parameter in a query, use the parameter name prefixed with `$`, for example `$example_number_param` for the parameter with name "example_number_param".

.Using a parameter in a query
image::dashboards/parameter-in-query.png[]


=== Deleting a parameter

. From the **Parameters** drawer, hover over the parameter you wish to edit.
. Use the trash bin button that appears.


== Filters

Filters are special xref:dashboards/working-with-dashboards/managing-dashboards.adoc#_dashboard_cards[cards] and you can add them to your dashboards in a similar fashion.

You can use a filter to dynamically set parameter values inside queries.


== Adding a filter

. In the **Dashboards** page, use **Add filter** at the bottom right.
. In the **Add filter** dialog, select a filter type: a node or relationship type, and a property.
. Use either an existing parameter or create a new one, then **Save**.


== Editing a filter

. In the **Dashboards** page, use the three dots icon of the filter you wish to edit and select **Edit filter**.
. Edit your filter and **Save**.


== Deleting a filter

In the **Dashboards** page, use the three dots icon of the filter you wish to edit and select **Delete**, then confirm.


//== Highlight all cards using a filter
//
//In the **Dashboards** page, use the target icon of a filter to highlight all cards that make use of this particular filter.

// screenshot

////
== Use a filter in a card

Lorem ipsum.
////

4 changes: 2 additions & 2 deletions modules/ROOT/pages/dashboards/advanced-features/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Advanced features
:description: The advanced features of Neo4j dashboards.
:description: Advanced features of Neo4j dashboards.

Coming soon.
Explore the advanced features offered by Neo4j dashboards.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ In Neo4j Aura, click **Dashboards** under **Tools** in the left-side navigation

== Editing a dashboard

. Select a dashboard tile from the the **Dashboards** page.
. Select a dashboard tile from the **Dashboards** page.
. To change the title, select the title text and edit it, then confirm.


=== Dashboard pages

Select a dashboard tile from the the **Dashboards** page.
Select a dashboard tile from the **Dashboards** page.
Dashboard pages are organized as tabs.
A new dashboard contains a single page "Main page".
You can edit or duplicate the page via hovering the page name and using the three dots icon.
Expand All @@ -28,13 +28,28 @@ Additional pages can also be deleted from the three dots menu.

=== Dashboard cards

A dashboard page consists of cards.
A dashboard page can hold any number of cards.
Each card can hold a xref::/dashboards/visualizations/index.adoc[visualization], also referred to as the **Chart type**.
To add a card, use **Add card* at the bottom right.
To add a card, use **Add card** at the bottom right.
Use the three dots at the top right of a card to edit the card.
Click the six dots at the top left of a card to drag and drop it within the grid of the page.


=== Dashboard filters

A dashboard page can hold filters.
A filter is a special type of card reserved for parameters used to filter data retrieved from your database.
See xref:dashboards/advanced-features/filters-and-parameters.adoc#_filters[filters] for more information.
To add a filter, use **Add filter** at the bottom right.
Use the three dots at the top right of a filter to edit the filter.
Click the six dots at the top left of a filter to drag and drop it within the grid of the page.


=== Dashboard parameters

See xref:dashboards/advanced-features/filters-and-parameters.adoc#_parameters[parameters].


////
== Loading a dashboard

Expand Down
27 changes: 25 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.