Persist & restore widgets / reports settings, number of items to display, selected columns...

[anonymous-matomo-user]

We should record some settings and preferences in all reports.

List of settings to remember & restore:

• of Rows to display (already saved for dashboard but not for other reports)

• view type: table, goals table, pie chart, etc.
• Selected metrics in graphs
• "Cog" icon

Not MVP

• In Goals report: remember which subreport was clicked in the bottom left selector (eg. websites VS custom var VS etc.)

[mattab]

Currently, the dashboard remembers which "view types" you look at, and then restore it the next time you visit.

It would be interesting indeed to generalize the Dashboard setting save to all Piwik reports, ie. all Piwik reports would remember the last state they were in

• view type: table, goals table, pie chart, etc.
• exclude low population enabled/disabled

Maybe worth a different ticket, but exclude low filter should be based on the total of the datatable column itself, rather than visits, in case report is a subset (of page category, visitor plugins, etc.).

[mattab]

• Could also record the plotted columns last selected and restore them next time
  • Maybe for this we could add a "reset" button so that its easy to come back to "default" state in case they misclicked?
• Also would be nice to record the selected report on the bottom left in Ecommerce, see original ticket at Ecommerce report should load Product Name instead of SKU by default, if defined #2756

[sgiehl]

(In [5891]) refs #1915, fixes #2461 added new limitation select to all datatables. users can now select how many rows to display. limit changes to widgets on dashboard will automaticly be stored within layout and restored on reload. changed default limits to referer datatables to 25

[mattab]

updated ticket description to include all settings to restore as per comments

[sgiehl]

(In [6027]) fixes #2979, refs #1915, refs #3011 completely refactored dashboard and widget javascripts (now using jquery plugins).
selected metrics in dashboard widgets are now stored in layout, too. also implemented some parts simplifying implementation of #3011 and #1915 and a small suggestion of #2461

[gka]

How can I use the persistent widget settings for my own widgets? Is there a generic JavaScript-API to store and recall widget-specific key-value pairs?

[mattab]

Benaka what do you think is left on this ticket?

it would also be nice to have an JS api or function for core&plugins to use to record settings.

[mattab]

It was also reported in: #3369 and request in the forums few times.

[anonymous-matomo-user]

Remembering these settings would make using Piwik a lot slicker and more user friendly. Please include it in a future edition!

[mattab]

This was also reported in #3469 Visits Overview (with graph) does not remember its status

[mattab]

It was reported in: #3807 Save and retrieve last zoom settings for maps

That we could also save & restore the map zoom. Is this a good idea (not sure)?

[tsteur]

In 97f500f: refs #1915 a first version of persist & restore report settings. not everything is saved yet (such as metricsToPlot) but most things are

[tsteur]

In ee2ec2b: refs #1915 reset viewDataTable parameters before each test run to remove previously persisted viewdatatable params from other test runs

[tsteur]

In d509153: refs #1915 added missing method to delete all viewdatatableparams, metricsToPlot should be saved now as well

[tsteur]

Regarding "In Goals report: remember which subreport was clicked in the bottom left selector (eg. websites VS custom var VS etc.)"

As this is not a viewDataTable / Visualization I won't implement this (for now)

[tsteur]

In ce33725: refs #1915 trying to fix the installation tests

[tsteur]

In 80d8d01: refs #1915 persist selected metrics and rows in referrers evolution

[tsteur]

In d9512c6: refs #1915 clear a users saved parameters on delete, added some tests

[tsteur]

In 2035f17: refs #1915 ignore filter_sort_order in change check after data requested

[tsteur]

In ce76153: refs #1915 make sure the flat param is set in the url even if the value is 0. Otherwise there a persisted preference saying flat=1 might be preferred. By making sure the flat param is present in the url the persisted value will be overwritten

[tsteur]

Closing this for now. We can create new tickets in case we want to persist more parameters/settings/...

[mattab]

Nice work Thomas, this will be a super useful feature to most piwik users.

If you're using Piwik and have any feedback about this feature, please comment here

[ksubileau]

And finally what about #3807 ? :D

[mattab]

@ksubileau good point, I've re-opened that ticket!

[mattab]

See follow up: #5143 Store and restore report settings for the anonymous user
refs #3110

[mattab]

See also: #5162: Remember detailed visitor log 'Rows to display'
(Visitor Log footer does not store settings)

[tsteur]

In 1de1cdb: refs #1915 "columns" is added as a special query parameter in ViewDataTable class which results in having to do this. Problem: Switching to treemap visualization in eg PageUrls will save a columns "nb_hits" param, loading the normal view and sorting by column will result in only displaying nb_hits column instead of all columns. This seems to be the only case. If there are more we need to let the visualization decide which parameters to reset in case of a visualization change