Skip to content

Conversation

@fiquick
Copy link
Collaborator

@fiquick fiquick commented Nov 19, 2025

No description provided.

@fiquick fiquick requested a review from rsill-neo4j November 19, 2025 16:49
Removed note about auto-generated parameter name.
@neo4j-docops-agent
Copy link
Collaborator

neo4j-docops-agent commented Nov 20, 2025

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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.
Copy link
Contributor

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?

Comment on lines +10 to +14
.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.
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. 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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

. 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**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. Then **Save**.
. **Save** when you're happy with the filter.

Comment on lines +87 to +88
. Then the next step is to take that parameter use it in a Cypher query.
. Create a card.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. 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.

Comment on lines +90 to +91
.Example: Filter by customer city
image::dashboards/parameters-and-filters/filter-by-customer-city.png[]
Copy link
Contributor

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

Comment on lines +100 to +108
. 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**
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. 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**.

Comment on lines +122 to +125
Like this:

.Cypher query for a table which displays customers within a city
image::dashboards/parameters-and-filters/london-cypher-query-example.png[]
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

@fiquick
Copy link
Collaborator Author

fiquick commented Nov 21, 2025

Thank you for the feedback! I think I found a new way through in the newer PR :)

@fiquick fiquick closed this Nov 21, 2025
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.

4 participants