Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of select for tabulator widget #2089

Closed
leoffj opened this issue Mar 15, 2021 · 0 comments · Fixed by #2230
Closed

Improve documentation of select for tabulator widget #2089

leoffj opened this issue Mar 15, 2021 · 0 comments · Fixed by #2230
Labels
type: enhancement Minor feature or improvement to an existing feature
Milestone

Comments

@leoffj
Copy link

leoffj commented Mar 15, 2021

In version 0.11 the selection options of the tabulator widget are described as follows:

selectable = param.ObjectSelector(default=True, objects=[True, False, ‘checkbox’])

Whether a table’s rows can be selected or not. Multiple selection is allowed and can be achieved by either clicking multiple checkboxes (if enabled) or using Shift + click on rows.

This does not cover all possibilities of the tabulator widget and the description text is a bit misleading.

Is your feature request related to a problem? Please describe.

I described my problem in https://discourse.holoviz.org/t/selecting-only-one-row-in-tabulator-widget/1953?u=jleoff. In short, I want only one row of the tabulator widget to be selectable at once (the table contains the input for a plot, you select what you want to see). The solution is actually very easy, just set selectable = 1. I did waste quite some time to find this solution though, as I was mislead by the documentation. The documentation of tabulator does show this possibility.

Describe the solution you'd like

Please update the documentation. It would probably be best to reference the original documentation? For reference, this is the current documentation at http://tabulator.info/docs/4.2/select

The selectable option can take one of a several values:

false - selectable rows are disabled
true - selectable rows are enabled, and you can select as many as you want
integer - any integer value, this sets the maximum number of rows that can be selected (when the maximum number of selected rows is exeded, the first selected row will be deselected to allow the next row to be selected).
"highlight" (default) - rows have the same hover stylings as selectable rows but do not change state when clicked. This is great for when you want to show that a row is clickable but don't want it to be selectable.
@philippjfr philippjfr added the type: enhancement Minor feature or improvement to an existing feature label Mar 16, 2021
@philippjfr philippjfr added this to the v0.12.0 milestone Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Minor feature or improvement to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants