SaturationColorFrame.setColor(value)

VisualFrame

Specifies the color whose saturation is varied. The data values in the associated column (specified by the inherited VisualFrame.setField(field) property) are mapped to a spectrum of saturations of the specified color. You can also set this using the bindingInfo.colorFrame.color property syntax in onRefresh script. See Example 2 below. The corresponding “getter” function is getColor().

Paramater (Function Syntax)

value: a java.awt.Color object

Value (Property Syntax)

number (hex)          Example: 0xFF0000
string (color name)   Example: 'red'
array [r,g,b]         Example: [255,0,0]
JSON {r:_,g:_,b:_}    Example: {r:255,g:0,b:0}
java.awt.Color        Example: java.awt.Color.BLUE (BLACK, CYAN, DARK_GRAY,
                               GRAY, GREEN, LIGHT_GRAY, MAGENTA, ORANGE,
                               PINK, RED, WHITE, YELLOW)

Example 1

Chart Component Script

dataset = [["State", "Quantity"], ["NJ",200], ["NY",300]]; (1)
graph = new EGraph();
var elem = new IntervalElement("State", "Quantity");
var frame = new SaturationColorFrame(); (2)
frame.setField("Quantity"); (3)
frame.setColor(java.awt.Color(0xff0000)); (4)
elem.setColorFrame(frame); (5)
graph.addElement(elem);

1	See dataset to use a data block instead of an array literal.
2	Create the SaturationColorFrame object.
3	Use the inherited VisualFrame.setField(field) property to specify the field for the `SaturationColorFrame`.
4	Use `setColor` to specify the color for the `SaturationColorFrame`.
5	Use GraphElement.setColorFrame(frame) to add the `ColorFrame` to the IntervalElement.

SaturationColorFrame2

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.

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 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.

Add the following script in the onRefresh handler. (See Add Dashboard Script.)
onRefresh Script
```
Chart1.bindingInfo.setColorField("Total",Chart.NUMBER);
Chart1.bindingInfo.colorFrame = new SaturationColorFrame;
Chart1.bindingInfo.colorFrame.color = 0xFF0000;
```
Dashboard script that modifies bindingInfo should generally be placed in the onRefresh handler. See Add Dashboard Script.