VisualFrame.setLegendSpec(spec)

Specifies the formatting for the legend generated for the VisualFrame. The corresponding “getter” function is VisualFrame.getLegendSpec().

Parameter

spec: a LegendSpec object

Example

Chart Component Script

dataset = [["State", "Quantity"], ["NJ",200], ["NY",300]]; (1)
graph = new EGraph();
var elem = new PointElement("State", "Quantity");
var frame = new LinearSizeFrame();
var spec = new LegendSpec(); (2)
spec.setBorderColor(java.awt.Color(0xff0000));
frame.setField("Quantity");
frame.setLegendSpec(spec); (3)
elem.setSizeFrame(frame);
graph.addElement(elem);

1	See dataset to use a data block instead of an array literal.
2	Create the `LegendSpec` object.
3	Use `setLegendSpec` to add the `LegendSpec` to the LinearSizeFrame.

Script that modifies the graph or dataset properties should be placed on the Chart component itself. See Add Component Script for more information. This script has access to the Chart data and Chart API methods. Scripted Charts are not good candidates for user-modification, so you should deselect ‘Enable Ad Hoc Editing’ in the Chart Properties dialog box.

To change the property on a Chart that was previously created with the Chart Editor, use “getter” methods such as EGraph.getElement(index) ① and GraphElement.getColorFrame() ② to obtain a handle to the desired GraphElement and ColorFrame objects. For example:

var elem = graph.getElement(0); (1)
var frame = elem.getColorFrame(); (2)
var spec = new LegendSpec();
spec.setBorderColor(java.awt.Color(0xff0000));
frame.setLegendSpec(spec);