Graph node common properties

This section describes the properties available for graph nodes, including common properties and properties that are specific to each node type.

Table 1. Common graph node properties
Common graph node properties Data type Property description
title string Specifies the title. Example: "This is a title."
caption string Specifies the caption. Example: "This is a caption."
output_mode Screen File Specifies whether output from the graph node is displayed or written to a file.
output_format BMP JPEG PNG HTML output (.cou) Specifies the type of output. The exact type of output allowed for each node varies.
full_filename string Specifies the target path and filename for output generated from the graph node.
use_graph_size flag Controls whether the graph is sized explicitly, using the width and height properties below. Affects only graphs that are output to screen. Not available for the Distribution node.
graph_width number When use_graph_size is True, sets the graph width in pixels.
graph_height number When use_graph_size is True, sets the graph height in pixels.

Turning off optional fields

Optional fields, such as an overlay field for plots, can be turned off by setting the property value to " " (empty string), as shown in the following example:

plotnode.setPropertyValue("color_field", "")

Specifying colors

The colors for titles, captions, backgrounds, and labels can be specified by using the hexadecimal strings starting with the hash (#) symbol. For example, to set the graph background to sky blue, you would use the following statement:

mygraphnode.setPropertyValue("graph_background", "#87CEEB")

Here, the first two digits, 87, specify the red content; the middle two digits, CE, specify the green content; and the last two digits, EB, specify the blue content. Each digit can take a value in the range 0–9 or A–F. Together, these values can specify a red-green-blue, or RGB, color.

Note: When specifying colors in RGB, you can use the Field Chooser in the user interface to determine the correct color code. Simply hover over the color to activate a ToolTip with the desired information.