draw-legend

Arguments: chart-or-plot

Returns the value of the draw-legend property of a chart-or-plot. The value may be set at creation time by passing the :draw-legend initarg, or any time later by calling (setf draw-legend).

draw-legend indicates whether a legend is drawn in a chart-or-plot. The legend is a table at the bottom of the chart with a descriptive string for each chart object and a visual indication of which graph line or set of bars represent it. The chart-or-plot will automatically make room for the legend whenever it is drawn.

The value may be t to draw the legend, nil to not draw it, or :when-multiple-objects to draw the legend if and only if there are multiple objects in the chart-objects property. The default value is :when-multiple-objects, since a legend is typically needed only to differentiate multiple chart objects.

The legend will be drawn according to properties of the chart-legend instance that is in the chart-legend property of the chart-or-plot.

See chart-widget, plot-widget, and also cg-chart-widget.htm.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.