-
Notifications
You must be signed in to change notification settings - Fork 23
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
rsill-neo4j
wants to merge
6
commits into
neo4j-dashboards-in-aura
Choose a base branch
from
dashboard-parameters-and-filters
base: neo4j-dashboards-in-aura
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
df60105
draft for parameters and filters
rsill-neo4j 2bf7054
restructured pages a bit
rsill-neo4j 71d01ee
added docs for filters, rearranged content again
rsill-neo4j ce7c70e
removed a file change that does not belong in this branch
rsill-neo4j 70fa697
review suggestions
rsill-neo4j 0c3e747
Update modules/ROOT/pages/dashboards/advanced-features/filters-and-pa…
rsill-neo4j File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
87 changes: 87 additions & 0 deletions
87
modules/ROOT/pages/dashboards/advanced-features/filters-and-parameters.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
== 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. | ||
//// | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
4 changes: 0 additions & 4 deletions
4
modules/ROOT/pages/dashboards/advanced-features/parameters.adoc
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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'?