on-print-chart-object

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-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.