addTargetLine(measure, colors, values, options)

Draws a set of horizontal or vertical target lines in the plot area using the specified colors and options. See Add a Target Line/Curve Fit for more information about target lines.

Individual target lines are accessed in script as GraphForm objects. To remove a specific target line, use graph.removeForm(index). Indexing for all GraphForm objects begins at 0 and proceeds in the order that objects were added to the chart. To remove all target lines, use clearTargets().

Parameter

measure: Name of measure on which to draw target line
colors: Color (see valueColor) or array of colors to fill area between target lines
values: Array of values and/or valid aggregation methods ('max','min','avg','med') at which to draw the lines
options: Name-value pairs of options (see Options below, e.g., {fillAbove:0xff0000, fillBelow:0x00ff00})

Options

fillAbove

Color (see valueColor) to fill the region above the target line

fillBelow

Color (see valueColor) to fill the region below the target line

label

String to label the target line(s). The following codes can be inserted:

{0}: Target value
{1}: Target formula
{2}: Field name

The code can be followed by a format type and format string, for example, {0,number,$#,##0}. See Add Data Format for more information about formatting.

lineColor

Color (see valueColor) to apply to all target lines

lineStyle

The line style (a Line Style constant) to apply to all target lines

labelFont

The font description (e.g., 'Lucida Sans Unicode-BOLD-14') to apply to all target labels

labelColor

The color (see valueColor) to apply to all target labels

Examples

Single Target Line

// The 'options' object is broken into several lines for clarity:
var options = {fillAbove:[200,200,255],fillBelow:[225,225,225],label:'Value: {0}',lineColor:'blue'};
Chart1.addTargetLine('Sum(Product:Total)',null,2500000,options);

PlotAddTarget

Multiple Target Lines

// The 'options' object is broken into several lines for clarity:
var options = {fillAbove:[200,200,200],fillBelow:[200,200,200],label:['{1}: {0,number,$#,##0}','{1}: {0,number,$#,##0}'], \
lineColor:'blue',lineStyle:Chart.DASH_LINE,labelFont:'Lucida Sans Unicode-BOLD-11',labelColor:'black'};
Chart1.addTargetLine('Sum(Product:Total)',0xDD99DD,['avg','max'],options);

PlotAddTarget2

Either syntax below can be used in component script:

addTargetLine         // unqualified
Chart1.addTargetLine  // qualified

For onInit/onRefresh scripts, and for component and property scripts on other components, the second (qualified) form is required.