finos / perspective

A data visualization and analytics component, especially well-suited for large and/or streaming datasets.
https://perspective.finos.org/
Apache License 2.0
8.3k stars 1.16k forks source link

Document Plugin Configuration Options #2253

Open MarcSkovMadsen opened 1 year ago

MarcSkovMadsen commented 1 year ago

I really like the Perspective viewer and I'm trying to contribute better documentation for the Panel Perspective pane in https://github.com/holoviz/panel/pull/5087.

I would like to show case how to configure for example the Datagrid plugin for datetimes, numbers and strings.

This is hard as I cannot find any reference documentation for the available options. And I cannot find any example that systematically goes through these options.

What I can do is look at the rust source files like datetime_column_style.rs and try things out. But this is cumbersome and error prone.

Request: Please document the plugin configuration options and provide systematic examples showcasing these options. Thanks

Alternative - Live Explorer

An alternative (and probably more powerful) would be a live explorer where you can interact with Perspective manually and see how to configuration options change. See below post.

Example Issues - Help needed 👍

Below I will provide some examples where I cannot figure things out. Feedback on how to do this would also be helpful as then I can add that to the Panel reference guide. Thanks

Version

Panel uses a fixed version of Perspective. Currently (2023-06-10) v1.9.3.

Additional Context

Spending some hours I'm able to provide examples like

image

and reference documentation like

image

MarcSkovMadsen commented 1 year ago

Datagrid datetime configuration not working

I cannot get the time_zone, date_style and time_style working. Maybe I just don't know how to use them correctly? Maybe they don't work. Help is very much appreciated. Thx.

image

MarcSkovMadsen commented 1 year ago

Alternative to docs - Live Explorer

In Panel we are able to create a live explorer like the below. It actually helped me figure out the time_zone and date_style, time_style was camel cased as timeZone, dateStyle and timeStyle.

Request: Add something similar to your examples gallery. Would help a lot of users.

image