CL_g_legend

Description

• Defines a legend for the specified axes or graphic handles.

  A title may be optionally defined.

  The legend is optionally created in a new axes entity in order to avoid having the title move when zooming in/out.

• Note:

  The behaviour should be OK for all scilab versions, despite the bug in "legend" for scilab versions prior to 5.4.0, for which the legends were written in the wrong order.

Parameters

h:

Graphic handle of an Axes entity or (not empty) vector of handles of polyline entities (same as legend).

str:

(string) Legend labels (1xN or Nx1: as many as there are 'Polyline' entities in 'a').

pos:

(optional) Position (normalized coordinates) of the legend: [x,y] where x: distance from the left, y: distance from the top. Default is [0.75, 0.2].

header:

(optional) Title of the legend.

new_axes:

(boolean, optional) %t if the legend must be created in a new axes entity. Default is %t if 'header' is defined, else it is %f.

hl:

Handle of the legend entity created.

Authors

• CNES - DCT/SB (AL)

Examples

// Example 1 f = scf(); plot([1,2], [1,2], "r"); plot([1,2], [1,3], "b"); CL_g_legend(gca(), ["red", "blue"]); // Example 2 f = scf(); plot([1,2], [1,2], "r"); h1 = gce(); plot([1,2], [1,3], "b"); h2 = gce(); CL_g_legend([h1, h2], ["red", "blue"]);