File Exchange

image thumbnail

clickableLegend - Interactive highlighting of data in figures

version 1.4.0.1 (213 KB) by

A legend with clickable strings that let you hide and show objects in a plot.

4.89286
32 Ratings

26 Downloads

Updated

View License

Editor's Note: This file was selected as MATLAB Central Pick of the Week

**** UPDATE ****
ClickableLegend now also highlights entries when you click them in the figure/axes window. This function is also R2014b ready
clickableLegend is a wrapper around the LEGEND function that provides the added functionality to turn on and off (hide or show) a graphics object (line or patch) by clicking on its text label in the legend. Its usage is the same as the LEGEND function in MATLAB.
Notes:

1. You can group multiple lines into a single legend entry and toggle their visibility with a single click.

2. The DisplayedLines parameter lets you specify which lines should be displayed initially. This is useful if you have a large number of lines but want to start out with only a few shown.

3. If you save the figure and re-load it, the toggling functionality is not automatically re-enabled. To restore it, simply call clickableLegend with no arguments.

4. To prevent the axis from automatically scaling every time a line is turned on and off, issue the command: axis manual

Example 1:
z = peaks(100);
plot(z(:,26:5:50))
grid on;
axis manual;
clickableLegend({'Line1','Line2','Line3','Line4','Line5'}, 'Location', 'NorthWest');

Example 2:
f = plot([1:10;1:2:20]','x'); hold on;
g = plot(0:.1:10,sin([0:.1:10;0:.2:20]'),'r-');
h = plot(11:20,rand(5,10)*5,'b:');
clickableLegend([f;g;h], {'Line1','Line2','Line3'},...
'groups', [1 1 2 2 3 3 3 3 3], 'displayedLines', [2 3]);

Comments and Ratings (45)

Ren

Ren (view profile)

a really good nice work!!

Lenwo

Lenwo (view profile)

Friedrich

There is no need to use this in R2016a or newer anymore because this is easily doable with shipped features. There is even an example in the doc which does exactly what this submission does:

>>web(fullfile(docroot, 'matlab/creating_plots/create-callbacks-for-interacting-with-legend-items.html'))

https://www.mathworks.com/help/releases/R2017a/matlab/creating_plots/create-callbacks-for-interacting-with-legend-items.html

villaian

The option to highlight a line is not working on MATLAB R2016a. Is there a compatibility problem with the function highlightObject(lTextObj, lMarkerObj, plotObj, plotOptions)? Does anyone have a Solution for this?

I'm also getting the color outside range error when running on version 2016B. No problem when using version 2015B.
I determined that the problem is that the call to "set(obj,...)" causes the color values of hObject to reset to [0 0 0]. That should never happen.
The original code retrieves the current Color values of hObject and then assigns new Color values, based on the previous Color values.
Hard-coding the color values gets around the immediate issue, but if there is any other place in the program that uses the assigned Color values of hObject, it will have problems.

Erik Hedberg

Really handy submission, thanks! It seems however that setting the Interpreter property of the legend object no longer has any effect. Also, when I move the legend by click and drag it generates a lot of warnings "Error updating legend". I'm using 2016b.

ASML

ASML (view profile)

Sugar Rush

goc3

goc3 (view profile)

Alton Vaughan

I was having the same problem as Royi Avital with the color being outside the [0,1] range. To get it to work with 2016a I modified the togglevisibility function within clickableLegend to the following:

function togglevisibility(hObject, obj)
if get(hObject, 'UserData') % It is on, turn it off
set(obj,'HitTest','off','Visible','off','handlevisibility','off');
drawnow
set(hObject, 'Color', [0.5 0.5 0.5],'FontAngle','italic', 'UserData', false);
else
set(obj, 'HitTest','on','visible','on','handlevisibility','on');
drawnow
set(hObject, 'Color', [0 0 0],'FontAngle','normal', 'UserData', true);
end

I also have the problem Royi Avital has. Is there a solution yet?

Renwen Lin

Same Problem: I have some issues with MATLAB R2016a. The color is outside the [0, 1] range.

at clickableLegend>togglevisibility (line 139)
set(hObject, 'Color', get(hObject, 'Color')*1.5 - 1, 'UserData', true);

Royi Avital

I have some issues with MATLAB R2016a. The color is outside the [0, 1] range.

Josef Laumer

Great submission! Found the same issue like Alexander Stepanov, not every object has the MarkerSize poperty. Something like:
"if isprop(plotObj(i),'MarkerSize')
set(plotObj(i), 'LineWidth', lw+2, 'MarkerSize', get(plotObj(i),'MarkerSize')+2);
else
set(plotObj(i), 'LineWidth', lw+2, 'FontWeight', 'bold');
end"
is needed. Would be great if the script could be updated.

One small issue - selection does not work with scatter plots, as they do not have a MarkerSize property. The code should either check if the property exists before trying to get/set it, or use a pre-defined set of properties based on graphics object type. Some of the types have changed with HG2 - e.g. 'hggroup' seems to be replaced with 'scatter', so probably the former is easier).

And a small comment on setting data tip position in my code (lines 197-198). In 2015b the code works, but data tip for some reason is not shown where you expect it to be. The following code works, but it needs slight tweaks to be backwards compatible:

pt = get(axh, 'CurrentPoint'); % Get the location of the click
X = get(clickedPlotObj,'Xdata'); % Retrieve Xdata
Y = get(clickedPlotObj,'Ydata'); % Retrieve Ydata
axisUnits = get(axh, 'DataAspectRatio'); % Relative lenghts of data units along each axis
dist = ((X-pt(1,1))/axisUnits(1)).^2 + ((Y-pt(1,2))/axisUnits(2)).^2; % Distances to clicked point on (X,Y) plane
idx = find(dist == min(dist),1); % Index the click
cursor = get(hTag, 'Cursor'); % Specific to recent Matlab releases
cursor.DataIndex = idx;

One small issue I found with my code (link below) - apparently @ancestor doesn't return a cell even if you wrap the argument in a cell array, unlike @get function, so lines 115-116 need to be changed to:

parentAxes = ancestor(plothan, 'Axes');
if iscell(parentAxes)
parentAxes = [parentAxes{:}];
end

Thanks. Btw, I have modified the code to achieve everything I mentioned, specifically:
- Clicking on a plot shows a data tip. Clicking on it again simply moves the data tip, keeping line(s) selected.
- Clicking on empty space inside axes removes all selections.
- Moving selected items on top of UI stack (& reverting back once deselected)

If you have time, could you please take a look and consider updating your submission, so everyone could benefit from these features?
http://paste.ofcode.org/D5ic9xVhNDez9LjpqG6Qug

I tried to keep as much of the original code intact as possible, and I did not update any of the documentation. Tested in 2015b.

Adrian Cherry

Alexander - with respect to your "Finally" bit. You can use gridLegend and clickableLegend together and I do. The function gridLegend tests to see if you have clickableLegend installed, if you do then it will use it.

Very nice. Great that it is now possible to highlight a line by clicking on it.

Some ideas if you plan to improve it further. There are two features it still lacks to completely remove the need to use @interactivelegend (another FEX utility) alongside this one:
1. Deselecting all lines when clicking on an empty space inside axes (much more convenient than having to click again on each line).
2. Displaying a label (same as in the legend) next to the the point you clicked on. When there are too many lines, it doesn't make sense to display the legend at all, so simply highlighting a line doesn't tell you which one it is. Displaying a label when you select a line solves the problem. That's exactly what @interactivelegend does.

Finally, would be nice to have control over which legend function is used as a base - e.g. so we could use @gridLegend utility from FEX, together with clickableLegend.

Hoi Wong

Hoi Wong (view profile)

I just notice that if I disable a legend and the print (or do a print preview), the legend text will reset to black (instead of grey).

This will throw an error in this line "set(hObject, 'Color', get(hObject, 'Color')*1.5 - 1, 'UserData', true);" as the color is [0 0 0], [0 0 0]-1=[-1 -1 -1] (togglevisibility() lost track of the color state as it's externally modified by printing).

Any idea how to handle cases like this robustly? Right now I just put a floor function over it "max([0 0 0], get(hObject, 'Color')*1.5 - 1)" but it will take a few clicks to get it back to the right state.

Hoi Wong

Hoi Wong (view profile)

It seems like in R2014b, I cannot just override the already generated legend by just calling clickableLegend() or clickableLegend(gca). Anybody has the same issue?

In my case, the legends are generated by gscatter(), so I don't have control over it.

Amy

Amy (view profile)

Feature request: modify the code to work with any font color in the legend. When the legend font color is changed to a different color, for example blue ([0 0 1]), the function crashes when any legend entry is clicked. This is because the scaling of the font color results in a vector with values greater than 1.

Jim

Jim (view profile)

1. This is a very useful function when presenting a figure containing many data series to an audience.
2. Unfortunately there's an error in the 2nd example given in the preamble to the code. Instead of "'groups', [1 1 2 2 3 3 3 3 3]" in the clickableLegend call (which causes an error), I believe the intended usage was "'groups', [1 2 3 3 3 3 3]"
3. The behavior I wanted was to toggle data series visibility by clicking the associated legend text. The posted callback routine toggles the HitTest and HandleVisibility properties of the series, but to get the desired behavior, I replaced the two "set(obj, ...)" lines with

set(obj,'Visible','off');

and

set(obj,'Visible','on');

Amy

Amy (view profile)

Vanich

Vanich (view profile)

Super awesome

Ben

Ben (view profile)

Nice work!

Bernd Meister

Bernd

Bernd (view profile)

very nice and easy to handle tool...I tried it on a bunch of old plots and it works just fine...my pick of the month!

Evgeny Pr

Evgeny Pr (view profile)

Barry

Barry (view profile)

Excellent!

Lukas Lansky

Jeff Preston

Jveer

Jveer (view profile)

this is good stuff! how abt you get cracking on something similar for colorbar - i already have a name for it clickable colorbar ;)

Hoi Wong

Hoi Wong (view profile)

Great idea! You saved my butt for my project.

Richard

Funny when I first saw this I thought: "nice but I don't really need it". Then today I was plotting a bunch of data and was wishing I had someone to "turn off" some of the lines. Just what I needed! Thanks for the great post.

Martin Richard

Very good indeed. Congratulations!

Riccardo Meldolesi

Great functionality.

I learnt from the code too!

Well done

Thierry Dalon

Excellent. It does what it sells. Very well coded as well.
Maybe the name of the function is a bit long.... I've changed it to ilegend.
Thanks.

Thierry Dalon

This is a feature I've requested as enhancement to TheMathworks for the base legend function.
Thank you for implementing it. I will give it a try.

Updates

1.4.0.1

Updated license

1.4

ClickableLegend now also highlights entries when you click them in the figure/axes window. This function is also R2014b ready

1.2

Added ability to group lines into single legend entries and specify which lines are displayed initially.

MATLAB Release
MATLAB 7.6 (R2008a)

Download apps, toolboxes, and other File Exchange content using Add-On Explorer in MATLAB.

» Watch video