GradientColorFrame

The GradientColorFrame object contains a continuous color frame that returns gradations between two colors. To create a GradientColorFrame object, call the GradientColorFrame constructor.

var frame = new GradientColorFrame();

You can pass the name of a field (e.g., ‘Quantity’) to the constructor, or specify this later using the inherited VisualFrame.setField(field) property. You can also assign a ColorFrame using the bindingInfo.colorFrame property in onRefresh script. See Example 2 below.

GradientColorFrame provides the special GradientColorFrame.setFromColor(value) and GradientColorFrame.setToColor(value) methods.

Example 1

Chart Component Script
dataset = [["State", "Quantity"],["NJ",200],["NY",300],["PA",50],["CT",100]]; (1)
graph = new EGraph();
var elem = new IntervalElement("State", "Quantity");
var frame = new GradientColorFrame(); (2)
frame.setField("Quantity"); (3)
elem.setColorFrame(frame); (4)
graph.addElement(elem);
1 See dataset to use a data block instead of an array literal.
2 Create the GradientColorFrame object.
3 Use setField to specify the field for the GradientColorFrame.
4 Use GraphElement.setColorFrame(frame) to add the ColorFrame to the Chart.

GradientColorFrame 1

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.

Example 2

This example illustrates how to use bindingInfo properties to control the ColorFrame.

  1. Bind a Bar Chart to the sample ‘All Sales’ Data Worksheet, with ‘Company’ (top 5) on the X-axis, and Sum(Total) on the Y-axis.

    The ‘All Sales’ Data Worksheet can be found in the Data Worksheet  Sample Queries folder. You may need to download the examples.zip file from GitHub into your environment. (This requires access to Enterprise Manager.) See Import and Export Assets for instructions on how to import.

  2. Add the following script in the onRefresh handler. (See Add Dashboard Script.)

    onRefresh Script
    Chart1.bindingInfo.setColorField("Total",Chart.NUMBER);
Chart1.bindingInfo.colorFrame = new GradientColorFrame;
Chart1.bindingInfo.colorFrame.fromColor = 0x0000FF;
Chart1.bindingInfo.colorFrame.toColor = 0xFF00FF;

    GradientColorFrame

    Dashboard script that modifies bindingInfo should generally be placed in the onRefresh handler. See Add Dashboard Script.