ShapeFrame

A ShapeFrame object contains the shape style for visual chart objects. You can use a ShapeFrame object to represent data dimensions with shape (shape coding), or to apply a fixed (static) shape style. To create a ShapeFrame, use a constructor such as PolygonShapeFrame or StaticShapeFrame.

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

Example 1

  1. Bind a Point 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 to the Chart component. (See Add Component Script.)

    Chart Component Script
    var elem = graph.getElement(0); (1)
var frame = new StaticShapeFrame(); (2)
frame.setShape(GShape.ARROWBAR);
elem.setShapeFrame(frame);  (3)
    1 Use EGraph.getElement(index) to get a handle to the PointElement.
    2 Create the StaticShapeFrame object.
    3 Use GraphElement.setShapeFrame(frame) to add the StaticShapeFrame to the PointElement.

    point chart with StaticShapeFrame applying arrowbar shape to all elements

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

  1. Bind a Point 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.setShapeField("Total",Chart.NUMBER);
Chart1.bindingInfo.shapeFrame = new FillShapeFrame;

    point chart with FillShapeFrame applied via bindingInfo shapeFrame property

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