LegendSpec.setTextFrame(frame)

Specifies the TextFrame containing a mapping between legend values and replacement text. The corresponding “getter” function is getTextFrame().

Parameter

frame: A TextFrame object

Example

Chart Component Script

dataset = [["State", "Quantity"], ["NJ",200], ["NY",300]]; (1)
graph = new EGraph();
var elem = new IntervalElement("State", "Quantity");
var frame = new CategoricalColorFrame();
var tf = new DefaultTextFrame(); (2)
frame.setField("State");
tf.setText('NJ','New Jersey');
tf.setText('NY','New York');
var spec = new LegendSpec(); (3)
spec.setTextFrame(tf); (4)
frame.setLegendSpec(spec);
elem.colorFrame = frame;
graph.addElement(elem);

1	See dataset to use a data block instead of an array literal.
2	Create the TextFrame object.
3	Create the LegendSpec object.
4	Use `setTextFrame` to assign the `TextFrame` to the legend.

LegendSpecsetTextFrame

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. For example:

var elem = graph.getElement(0); (1)
var frame = elem.getColorFrame(); (2)
// Compact syntax: var frame = graph.getElement(0).getColorFrame();

var spec = new LegendSpec();
var tf = new DefaultTextFrame();
tf.setText('NJ','New Jersey');
tf.setText('NY','New York');
spec.setTextFrame(tf);
frame.setLegendSpec(spec);