chart-legend

Arguments: chart-or-plot

The functionality of this operator was changed when the plot-widget functionality was released in an update in Fall, 2008. The current description reflects those changes. You must have the update for this operator to work as described. See sys:update-allegro for information on getting updates.

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

A chart-legend is the table at the bottom of a chart-or-plot that shows a label for each chart object and indicates which line or set of bars in the chart display that object's values. The value is an instance of the chart-legend class.

The value of this property is always a chart-legend. If you do not pass a chart-legend instance as the value of the :chart-legend initarg when creating a chart-or-plot, then a default instance is created automatically.

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

Copyright (c) 1998-2009, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.1. This page is new in the 8.1 release.
Created 2007.4.30.