Skip to content
This repository was archived by the owner on Apr 5, 2019. It is now read-only.

StackOverflowMATLABchat/legtools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Minimum Version

LEGTOOLS

legtools is a MATLAB class definition providing the user with a set of methods to modify existing Legend objects.

This is an HG2 specific implementation and requires MATLAB R2014b or newer.

Methods

  • append - Add one or more entries to the end of the legend
  • permute - Rearrange the legend entries
  • remove - Remove one or more legend entries

legtools.append(legendhandle, newStrings)

Description

Append string(s), newStrings, to the specified Legend object, legendhandle. newStrings can be a 1D character array or a 1D cell array of strings. Character arrays are treated as a single string. If multiple Legend objects are specified, only the first will be modified.

The legend will only be updated with the new strings if the number of strings in the existing legend plus the number of strings in newStrings is the same as the number of plots on the associated Axes object (e.g. if you have 2 lineseries and 2 legend entries already no changes will be made).

Examples

Adding one legend entry
% Sample data x = 1:10; y1 = x; y2 = x + 1; % Plot a thing! figure plot(x, y1, 'ro'); lh = legend('Circle', 'Location', 'NorthWest'); % Add a thing! hold on plot(x, y2, 'bs'); legtools.append(lh, 'Square') 

Adding two legend entries

% Sample data x = 1:10; y1 = x; y2 = x + 1; y3 = x + 2; % Plot a thing! figure plot(x, y1, 'ro'); lh = legend('Circle', 'Location', 'NorthWest'); % Add two things! hold on plot(x, y2, 'bs', x, y3, 'g+'); legtools.append(lh, {'Square', 'Plus'}) 

legtools.permute(legendhandle, newOrder)

Description

Rearrange the entries of the specified Legend object, legendhandle, so they are in the order specified by the vector newOrder. newOrder must be the same length as the number of legend entries in legendhandle. All elements of order must be unique, real, positive, integer values.

Example

% Sample data x = 1:10; y1 = x; y2 = x + 1; y3 = x + 2; % Plot a thing! figure plot(x, y1, 'ro', x, y2, 'bs', x, y3, 'g+'); lh = legend({'One', 'Two', 'Three'}, 'Location', 'NorthWest'); legtools.permute(lh, [3, 1, 2]); 

legtools.remove(legendhandle, removeidx)

Description

Remove the legend entries of the Legend object, legendhandle, at the locations specified by removeidx. All elements of removeidx must be real, positive, integer values.

If removeidx specifies all the legend entries the Legend object, legendhandle is deleted.

Example

% Sample data x = 1:10; y1 = x; y2 = x + 1; y3 = x + 2; % Plot a thing! figure plot(x, y1, 'ro', x, y2, 'bs', x, y3, 'g+'); lh = legend({'One', 'Two', 'Three'}, 'Location', 'NorthWest'); legtools.remove(lh, [3, 1]); 

About

Provides a set of methods to modify existing HG2 Legend objects

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages