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

Merged
merged 11 commits into from
Jun 11, 2025

Conversation

rsill-neo4j
Copy link
Contributor

No description provided.

Copy link
Collaborator

@nielsdejong nielsdejong left a comment

Choose a reason for hiding this comment

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

Added some suggestions

@@ -0,0 +1,87 @@
= Filters and parameters
:description: Use parameters in your Aura 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.

We should change 'Aura dashboards' --> 'Dashboards', so that the docs can be reused for Desktop later.


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 compare a node or relationship property to a parameter value.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggest to change to "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 label and a node or relationship property.
Copy link
Collaborator

Choose a reason for hiding this comment

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

should be changed to refer to node labels and relationship types:
"select a filter type: a node label or relationship type, and a property."

@@ -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'?


== 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

we descoped the highlighting feature due to lack of time, perhaps we can comment or remove it

@rsill-neo4j rsill-neo4j marked this pull request as ready for review June 10, 2025 13:06
Copy link

@henrik-gildeus-neo henrik-gildeus-neo left a comment

Choose a reason for hiding this comment

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

@rsill-neo4j I added a few comments. Otherwise it looks good 👍

== Parameters

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

Choose a reason for hiding this comment

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

Well, parameters can have no value also. But if you want to set an initial value for a parameter you have to select type first. After you select type, you will get a date picker to select a date or a text field to enter text for instance

=== 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**.

Choose a reason for hiding this comment

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

select a data type is also optional now


//== 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.

Choose a reason for hiding this comment

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

This is not implemented yet, so we have to remove this highlighting part from the docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's commented out and won't show :)

Choose a reason for hiding this comment

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

Oh, I see, sorry :P

Copy link
Collaborator

@nielsdejong nielsdejong left a comment

Choose a reason for hiding this comment

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

Added comments

//** 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/parameters-and-filters.adoc[Parameters and filters]
Copy link
Collaborator

Choose a reason for hiding this comment

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

@rsill-neo4j @henrik-gildeus-neo would it make sense to split this into two pages? since users can use parameters without filters?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hm... filters however are dependent on a parameter, right?
i'd rather keep the two on the same page

Explore the advanced features offered by Neo4j dashboards.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we remove this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

get rid of "advanced features" altogether?

. Use the trash bin button that appears.


== Filters
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should have some screenshots here I think

// screenshot


== Using a filter in a card
Copy link
Collaborator

Choose a reason for hiding this comment

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

also needs a screenshot on how a parameter is used in a query

@@ -25,13 +25,13 @@ See xref::/dashboards/working-with-dashboards/ai-dashboards.adoc[] for advice ho

Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe for another PR, but we should mention the dashboard limits per instance type.
Free --> 3/user
Pro --> 10/user
BC/VDC --> Unlimited

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i added a note to the main PR for the 3/free limit, will add the 2nd limit there 👍


=== Dashboard parameters

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

Choose a reason for hiding this comment

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

I think it would make sense to split these, yeah

@rsill-neo4j rsill-neo4j merged commit f070bb9 into neo4j-dashboards-in-aura Jun 11, 2025
@rsill-neo4j rsill-neo4j deleted the dashboard-parameters-and-filters branch June 11, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants