-
Notifications
You must be signed in to change notification settings - Fork 28
new filters #860
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
new filters #860
Conversation
Removed note about auto-generated parameter name.
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
rsill-neo4j
left a comment
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.
are all new screenshots being used in the PR? it's 6 new ones, but if i was counting right, there are 5 new "image:" statements
| = Parameters and filters | ||
| :description: Use parameters in your dashboards to further customize queries or use them in filters for node and relationship properties. | ||
|
|
||
| The main way to make dashboard charts interactive is to add a filter and link it to a card using a parameter. |
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.
a main way implies there are more - are there? which ones?
| .How to access the parameters drawer | ||
| [.shadow] | ||
| image::dashboards/parameters-and-filters/access-parameters-drawer.png[] | ||
|
|
||
| Display the parameters of a dashboard by using the parentheses button `{}` to show the **Parameters** drawer. |
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.
this is, arguably, an avoidable screenshot. the description should be hint enough :)
| . In the **Add filter** dialog, select a filter type: a node or relationship property, date or datetime. | ||
| . Link to an existing parameter or create a new one. | ||
|
|
||
| . On the right side of the dialog, there's a preview of the filter card that will be added to the dashboard - it's dynamic so you can use the dropdown too. |
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.
| . On the right side of the dialog, there's a preview of the filter card that will be added to the dashboard - it's dynamic so you can use the dropdown too. | |
| On the right side of the dialog, thereis an interactive preview of the filter card that is added to the dashboard. |
| . Use either an existing parameter or create a new one, then **Save**. | ||
| . In the **Add filter** dialog, select a filter type: a node or relationship property, date or datetime. | ||
| . Link to an existing parameter or create a new one. | ||
|
|
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.
| . Link to an existing parameter or create a new one. | ||
|
|
||
| . On the right side of the dialog, there's a preview of the filter card that will be added to the dashboard - it's dynamic so you can use the dropdown too. | ||
| . Then **Save**. |
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.
| . Then **Save**. | |
| . **Save** when you're happy with the filter. |
| . Then the next step is to take that parameter use it in a Cypher query. | ||
| . Create a card. |
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.
| . Then the next step is to take that parameter use it in a Cypher query. | |
| . Create a card. | |
| You can now use the parameter in a Cypher query. |
| .Example: Filter by customer city | ||
| image::dashboards/parameters-and-filters/filter-by-customer-city.png[] |
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.
i think this should be moved to the example section
| . Select the filter type `Node property` | ||
| . Select the label `Customer` | ||
| . Select the propery `City` | ||
|
|
||
| ==== Link the parameter: | ||
|
|
||
| . A parameter called `$customer_city` will be created automatically | ||
| . Set the default value to `London` | ||
| . **Save** |
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.
| . Select the filter type `Node property` | |
| . Select the label `Customer` | |
| . Select the propery `City` | |
| ==== Link the parameter: | |
| . A parameter called `$customer_city` will be created automatically | |
| . Set the default value to `London` | |
| . **Save** | |
| . Select the filter type `Node property`. | |
| . Select the label `Customer`. | |
| . Select the property `City`. | |
| ==== Link the parameter: | |
| . A parameter called `$customer_city` is created automatically. | |
| . Set the default value to `London`. | |
| . **Save**. |
| Like this: | ||
|
|
||
| .Cypher query for a table which displays customers within a city | ||
| image::dashboards/parameters-and-filters/london-cypher-query-example.png[] |
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.
this screenshot could be omitted too
| .Cypher query for a table which displays customers within a city | ||
| image::dashboards/parameters-and-filters/london-cypher-query-example.png[] | ||
|
|
||
| Then, in your dashboard, you'll have cards with the filter and the table - use the filter to change cities, and you'll see the info in the customer name table change too. |
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.
| Then, in your dashboard, you'll have cards with the filter and the table - use the filter to change cities, and you'll see the info in the customer name table change too. | |
| Then, in your dashboard, you have cards with the filter and the table. | |
| When you use the filter to change cities, the information in the customer name table changes too. |
|
Thank you for the feedback! I think I found a new way through in the newer PR :) |
No description provided.