plotSetLegend

Purpose

Adds a legend to a graph.

Format

plotSetLegend(&myPlot, label[, location[, orientation]])
plotSetLegend(&myPlot, turn_off)
Parameters:
  • &myPlot (struct pointer) – A plotControl structure pointer.
  • label (string array) – names of the line labels.
  • location (string or 2x1 vector) –

    Optional argument, the location to place the legend.

    If a string, the location string may contain up to three tokens, or words.

    1.  Vertical location: "top" (default), "vcenter" or "bottom". (Note: for backwards compatibilty "middle" may still be used for "vcenter". However, new programs should use "vcenter").
    2.  Horizontal location: "left", "hcenter" or "right" (default). (Note: for backwards compatibility "center" may still be used for "hcenter". However, new programs should use "hcenter").
    3.  Inside/Outside location: "inside" (default), "below" or "outside".

    If a vector, location represents the coordinates on the graph where the top, left corner of the legend will be placed.

  • orientation (scalar) – Optional argument, 0 for a horizontal legend or 1 for a vertical legend.
  • turn_off (string) – "off" will disable the legend.

Technical Notes

  • The location parameter is a string with up to three tokens or words that are separated by a space. For example,

    location = "top right";
    location = "right top";
    location = "inside top right";
    
  • Use plotSetLegendFont() to control the legend font family, size and color.

  • See plotSetTextInterpreter(), for instructions on using LaTeX, or HTML in the legend labels.

Examples

// Declare plotControl structure
struct plotControl myPlot;

// Initialize plotControl structure
myPlot = plotGetDefaults("scatter");

// Set labels, location, and orientation of legend
label = "sample A"$|"sample B";
location = "top right";
orientation = 0;
plotSetLegend(&myPlot, label, location, orientation);

// Create data
x = rndn(30, 2);
y = rndn(30, 2);

// Plot the data with the legend settings
plotScatter(myplot, x, y);