Legend: detach and toggle visibility of plottables (WinForms) by BambOoxX · Pull Request #1589 · ScottPlot/ScottPlot

BambOoxX · 2022-01-22T21:37:05Z

This PR is a WIP, it implements some ideas about interactive legends discussed in #1573 for WinForms :

Possibility to detach a legend and display it in another window
Possibility to hide/show plottables from a detached legend
Added a demo example to help illustrate the behavior

…s of labels with a scrollable panel

…ded `Legend` property - `Plot` alone does not have a `Refresh` method

…ed legend picture

- If a plottable is set to invisible using the detached legend, it remains plotted in the detached legend, but with a dimming overlay to reflect the sattus change - Requires access to visibility status of the plottables. Example of modification with `Scatter` by adding `plottableVisible` property to `LegendItem` - `UpdateLegendItems` can optionally show all plots whether they have a label or not (probably not very stable at the moment)

…tLegendViewer`

…ng labels

BambOoxX · 2022-01-23T21:38:52Z

@swharden Did you manage to get a quick look to the FormsPlotLegendViewer I think it is a pretty cool interactive feature. Also, it could be used to modify other properties of the plottables than the visibility alone.

swharden · 2022-01-23T22:11:22Z

@swharden Did you manage to get a quick look to the FormsPlotLegendViewer I think it is a pretty cool interactive feature. Also, it could be used to modify other properties of the plottables than the visibility alone.

Hi @BambOoxX! I hadn't looked at it until now - I've been totally lost in spline land this weekend #1577 #1593 🤪

I edited your original comment to include a demonstration of what this PR does. It's looking great! I'll do a line-by-line review now and offer suggestions if I see any.

~~One issue is that this PR is causing the Test_Legend_RendersWithoutRenderingPlotFirst() to fail... but hopefully that will be an easy fix!~~ EDIT: see code review comments

swharden

This is looking great @BambOoxX! I added more comments than some of your other PRs because there are so many changed files here (I don't want you to think I'm being overly critical)

Let me know if you have any questions about any of these! If you go through and resolve these points best you can I'd be happy to pick it up from there and we can merge it in soon 👍🚀

src/ScottPlot/Plottable/LegendItem.cs

src/ScottPlot/Plottable/ScatterPlot.cs

src/ScottPlot/Renderable/Legend.cs

src/controls/ScottPlot.WinForms/FormsPlot.cs

src/controls/ScottPlot.WinForms/FormsPlotLegendViewer.cs

- `includeall` replaced with `includeInvisibleOrEmptyLabels` - Added a help section to describe the optionalbehavior

BambOoxX · 2022-01-24T20:40:13Z

@swharden Could you tell me if you see something you don't want to be modified. I really don't want to ruin something here ^^

swharden · 2022-01-26T00:12:34Z

Hi @BambOoxX, thanks again for all this work! It took me a while to get back to you because my work on #1606 / #1593 took more time than I expected 😅

I'll start to review it now and make some commits to this PR branch then merge it in hopefully later tonight (I'm in EST time zone). I recommend that you not make changes or push commits to this PR branch while I'm actively working on it to avoid merge conflicts. Thanks for resolving so many of those issues! I'll do my best to resolve the remaining open issues myself and get this merged. After this gets merged we can still improve this system at any time with new PRs 👍

swharden · 2022-01-26T00:14:41Z

oh, and thanks again for your work on #1422 - it's what inspired me to go back and work on spline interpolation! Those draggable points are awesome

https://swharden.com/blog/2022-01-22-spline-interpolation

This prevents GetLegendBitmap() from crashing in cases where the legend was never explicitly enabled

previously only legends with white backgrounds were supported

true -> show legend false -> hide legend null -> do not change legend visibility in all cases return the Legend

fixes bug where number of plottables is different than number of items appearing in the legend (e.g., single pie plots with many labels in the legend)

swharden · 2022-01-26T04:35:26Z

Wow, that was complicated! Lots of sticky little edge cases with this one. I think I got all of them worked-out, but if you have ideas for improvements feel free to open a new PR. Thanks again for all your excellent work on this @BambOoxX! 🚀

BambOoxX · 2022-01-26T08:35:00Z

oh, and thanks again for your work on #1422 - it's what inspired me to go back and work on spline interpolation! Those draggable points are awesome

https://swharden.com/blog/2022-01-22-spline-interpolation

That looks reaaaaaaaally nice !

BambOoxX · 2022-01-26T08:49:20Z

@swharden You did an awesome job improving my proposal, I couldn't have brought it so far ! Well done !

BambOoxX and others added 8 commits January 21, 2022 18:17

First attempt to create detacheable Legend in WinForms

02e9488

Improved FormsPlotLegendViewer configuration to handle large number…

d5c9153

…s of labels with a scrollable panel

Demo : added example for FormsPlotLegendViewer

1dbe890

FormsPlotLegendViewer : changed argument type to FormsPlot and ad…

d70fa65

…ded `Legend` property - `Plot` alone does not have a `Refresh` method

FormsPlotLegendViewer : Use cursor Hand when hovering over detach…

8815fac

…ed legend picture

Demo : updated example for FormsPlotLegendViewer

4f19b20

Fix : Avoid attempt to render legend when not visible

9a3d4ec

swharden added the work in progress label Jan 23, 2022

BambOoxX added 5 commits January 23, 2022 14:48

FormsPlotLegendViewer : moved constant configuration to designer

a0c20c6

Fix : FormsPlotViewer shown before being fully configured

c7f2263

Fix : Incorrect detached legend content when initializing a `FormsPlo…

7159df3

…tLegendViewer`

FormsPlotLegendViewer : Simplified visibility toggling syntax

79c6c7f

Demo : Modified FormsPlotLegendViewer to show behavior with missi…

e9a3125

…ng labels

swharden requested changes Jan 23, 2022

View reviewed changes

swharden removed the work in progress label Jan 23, 2022

BambOoxX added 3 commits January 24, 2022 10:12

Merge branch 'master' into control-plotlegendviewer

61618ff

Improved UpdateLegendItems

e191fe0

- `includeall` replaced with `includeInvisibleOrEmptyLabels` - Added a help section to describe the optionalbehavior

Corrected type to avoid nullable warnings

180b58d

swharden added 6 commits January 25, 2022 19:20

WinForms demo: update from main branch

6a3bd21

Update changelog.md

e5118aa

Merge branch 'master' into pr/1589

ef330a1

Render: update legend even if it is invisible

26ec770

This prevents GetLegendBitmap() from crashing in cases where the legend was never explicitly enabled

autoformat

a05828c

LegendItem: constructor requires parent plottable

9bfc0a1

swharden added 11 commits January 25, 2022 21:23

Legend: use parent item visibility to control opacity

f57cfbd

Legend: hide using FillColor

b1bfcd9

previously only legends with white backgrounds were supported

WinForms Demo: fix Plot Viewer button

d9f9f2c

WinForms Demo: improve Mouse Tracker initialization

a168d03

WinForms Legend Viewer: toolbox window style

f946d4b

Plot: Legend() "enable" should be a nullable bool

20bb6b3

true -> show legend false -> hide legend null -> do not change legend visibility in all cases return the Legend

FormsPlot LegendViewer: refactor

d757509

FormsPlot: show detach legend only if legend is present

852d8e3

FormsPlot Legend Viewer: fix placement bug

f024099

fixes bug where number of plottables is different than number of items appearing in the legend (e.g., single pie plots with many labels in the legend)

Legend: refactor UpdateLegendItems()

1ada09a

Update changelog.md

4e10e40

swharden enabled auto-merge January 26, 2022 04:34

swharden mentioned this pull request Jan 26, 2022

Feature: click legend items to toggle visibility #1326

Closed

swharden merged commit af561e3 into ScottPlot:master Jan 26, 2022

swharden changed the title ~~New Legend rendering capabilities~~ Legend: detach and toggle visibility of plottables (WinForms) Jan 26, 2022

BambOoxX deleted the control-plotlegendviewer branch January 26, 2022 08:49

swharden linked an issue Feb 8, 2022 that may be closed by this pull request

Feature: click legend items to toggle visibility #1326

Closed

swharden mentioned this pull request Feb 8, 2022

Feature Request: show/hide line by clicking it in the legend #1648

Closed

chenlinhsfl mentioned this pull request May 26, 2022

WPF: pop-out legend editor #1862

Closed

nilsakesson mentioned this pull request May 17, 2024

Legend: demonstrate how to toggle visibility when items are clicked #3842

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Legend: detach and toggle visibility of plottables (WinForms)#1589

Legend: detach and toggle visibility of plottables (WinForms)#1589
swharden merged 33 commits intoScottPlot:masterfrom
BambOoxX:control-plotlegendviewer

BambOoxX commented Jan 22, 2022 •

edited by swharden

Loading

Uh oh!

BambOoxX commented Jan 23, 2022

Uh oh!

swharden commented Jan 23, 2022 •

edited

Loading

Uh oh!

swharden left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BambOoxX commented Jan 24, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

BambOoxX commented Jan 26, 2022

Uh oh!

BambOoxX commented Jan 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

BambOoxX commented Jan 22, 2022 • edited by swharden Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BambOoxX commented Jan 23, 2022

Uh oh!

swharden commented Jan 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

swharden left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BambOoxX commented Jan 24, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

swharden commented Jan 26, 2022

Uh oh!

BambOoxX commented Jan 26, 2022

Uh oh!

BambOoxX commented Jan 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BambOoxX commented Jan 22, 2022 •

edited by swharden

Loading

swharden commented Jan 23, 2022 •

edited

Loading