Generic FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version


Arguments: chart-legend

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

A function that returns a label for a chart object in the chart-legend of a chart-or-plot.

The value of this property should be a function or a function name, or else nil to default to princ-to-string. The function should take a chart object ID as a single argument and return a string to display for that object. The default value is princ-to-string.

A chart object ID will be the :id value for the object in the chart-objects property of the chart-or-plot, if such a value has been supplied, and otherwise will default to the zero-based integer index of the object.

This property is used only when the draw-legend property of the chart-or-plot is true.

See also legend-font, layout-orientation and on-print-major-label.

An alternative to writing an on-print-chart-object function is to supply an explicit :label value for each object in the chart-objects property of the chart-or-plot.

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

Copyright (c) 1998-2012, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 9.0. This page was not revised from the 8.2 page.
Created 2012.5.30.

Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version