Skip to content

Commit d842efe

Browse files
authored
Added extensions for table report, optional markdown descriptions (pop-ups), deep-linking pages and line-chart customizations (#196)
* Added doubleclick = copy action to tables. Added description setting to all reports: * Added option to deep-link into a given pagenumber * Added rotation angles for line chart ticks * Updated docs for new extensions
1 parent 0a0af71 commit d842efe

26 files changed

+244
-33
lines changed

docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,14 @@ ____
5757
Alternatively, environment variables from docker compose or a kubernetes
5858
deployment can be used.
5959
____
60+
61+
== Deep Linking
62+
To dynamically view a deployed NeoDash dashboard, you can deep-link into a deployed dashboard.
63+
the following deeplinking options are available via URL parameters:
64+
- Appending `?page=1` to the URL will open up a dashboard at a given page. (Starting at zero).
65+
- Appending `?neodash_person_name=Tom` to the URL will set a dashboard parameter as a default for the entire dashboard.
66+
67+
Multiple parameters can be used in a deep-link by concatinating them:
68+
....
69+
https://myneodashdeployment.com/?page=1&neodash_person_name=Tom&neodash_movie_name=The%20Matrix
70+
....

docs/modules/ROOT/pages/user-guide/reports/bar-chart.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ label on top of the visualization (if enabled).
9191
|Auto-run query |on/off |on |when activated automatically runs the query
9292
when the report is displayed. When set to `off', the query is displayed
9393
and will need to be executed manually.
94+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
9495
|===
9596

9697
== Rule-Based Styling

docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ the visualization on the y axis
5757
|Auto-run query |on/off |on |When activated, automatically runs the
5858
query when the report is displayed. When set to `off', the query is
5959
displayed and will need to be executed manually.
60+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
6061
|===

docs/modules/ROOT/pages/user-guide/reports/circle-packing.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,5 @@ of the visualization.
5050
|Auto-run query |on/off |on |When activated, automatically runs the
5151
query when the report is displayed. When set to `off', the query is
5252
displayed and will need to be executed manually.
53+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
5354
|===

docs/modules/ROOT/pages/user-guide/reports/graph.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ that the graph can be explored further. Dynamic Dashboard Parameters
123123
|Auto-run query |on/off |on |when activated automatically runs the query
124124
when the report is displayed. When set to `off', the query is displayed
125125
and will need to be executed manually.
126+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
126127
|===
127128

128129
== Rule-Based Styling

docs/modules/ROOT/pages/user-guide/reports/iframe.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,5 @@ iFrame URL.
3535
|Append global parameters to iFrame URL |on/off |off |If enabled,
3636
appends the full list of global parameters as URL parameters to the
3737
specified URL.
38+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
3839
|===

docs/modules/ROOT/pages/user-guide/reports/line-chart.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ format should look like this:
8787
smoothened. One of linear (no smoothing), basis (interpolating),
8888
cardinal (through each point) and step (step-based interpolation).
8989

90+
|X-axis Tick Rotation (Degrees) |number |0 | The angle at which the tick labels on the x-axis are rotated.
91+
92+
|Y-axis Tick Rotation (Degrees) |number |0 | The angle at which the tick labels on the y-axis are rotated.
93+
9094
|Show Grid |on/off |on |If enabled, shows a grid in the line chart that
9195
intersects at the axis ticks.
9296

@@ -116,6 +120,7 @@ selector (footer of the visualization).
116120
|Auto-run query |on/off |on |when activated automatically runs the query
117121
when the report is displayed. When set to `off', the query is displayed
118122
and will need to be executed manually.
123+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
119124
|===
120125

121126
== Rule-Based Styling

docs/modules/ROOT/pages/user-guide/reports/map.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ selector (footer of the visualization).
117117
|Auto-run query |on/off |on |when activated automatically runs the query
118118
when the report is displayed. When set to `off', the query is displayed
119119
and will need to be executed manually.
120+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
120121
|===
121122

122123
== Rule-Based Styling

docs/modules/ROOT/pages/user-guide/reports/markdown.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ image::markdown.png[Basic Markdown]
2929
|Replace global parameters in Markdown |on/off |on |If enabled, replaces
3030
all instances of query parameters (e.g. $neodash_person_name) inside the
3131
markdown source.
32+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
3233
|===

docs/modules/ROOT/pages/user-guide/reports/parameter-select.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,5 @@ for large datasets where the autocomplete field is too slow to render.
5151
|Helper Text (Override) |Text |(none) |Text to show above the user input
5252
field. This will override the autogenerated text from the
5353
node/relationship property pair.
54+
|Report Description |markdown text | | When specified, adds another button the report header that opens a pop-up. This pop-up contains the rendered markdown from this setting.
5455
|===

0 commit comments

Comments
 (0)