Dashboard - Parameters and Filters #694
Conversation
| @@ -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. | |||
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. | |||
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
we descoped the highlighting feature due to lack of time, perhaps we can comment or remove it
modules/ROOT/pages/dashboards/advanced-features/filters-and-parameters.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
@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. |
There was a problem hiding this comment.
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**. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
This is not implemented yet, so we have to remove this highlighting part from the docs
There was a problem hiding this comment.
it's commented out and won't show :)
modules/ROOT/pages/dashboards/advanced-features/parameters-and-filters.adoc
Show resolved
Hide resolved
modules/ROOT/pages/dashboards/advanced-features/parameters-and-filters.adoc
Show resolved
Hide resolved
| //** 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] |
There was a problem hiding this comment.
@rsill-neo4j @henrik-gildeus-neo would it make sense to split this into two pages? since users can use parameters without filters?
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Should we remove this page?
There was a problem hiding this comment.
get rid of "advanced features" altogether?
| . Use the trash bin button that appears. | ||
|
|
||
|
|
||
| == Filters |
There was a problem hiding this comment.
we should have some screenshots here I think
| // screenshot | ||
|
|
||
|
|
||
| == Using a filter in a card |
There was a problem hiding this comment.
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 | |||
|
|
|||
There was a problem hiding this comment.
maybe for another PR, but we should mention the dashboard limits per instance type.
Free --> 3/user
Pro --> 10/user
BC/VDC --> Unlimited
There was a problem hiding this comment.
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]. |
There was a problem hiding this comment.
I think it would make sense to split these, yeah
No description provided.