PCScript

PopChart Server Reference 4.0.5

SetSeries

Syntax graph.SetSeries(SeriesName [;DataItem]*)

Description Sends a data series to the graph.

Important: PopChart Server 3.x users are probably accustomed to the Graph.Series method, which is now deprecated. The Graph.SetSeries method behaves somewhat differently than did Graph.Series. Graph.Series will still work in version 4.0.5, but support cannot be guaranteed for the 5.0 release.

The first argument to this method should be the name of the series. Following this, you should have a semi-colon (or the item delimiter, which is specified in the Main. ItemDelimiter method). You should then list all data items in this series.

Data items can consist of anywhere from one to four values, depending on the graph type (refer to Chapter 12, "Data Organization," for details). If there is more than one value in the data item (e.g. an X-Y Plot point), the values should be separated by a comma (or the parameter delimiter, which is specified in the Main. ParamDelimiter method).

A data series can have as many data items as you want it to have. Each data item should be separated by an item delimiter.

The data values in a data item will be interpreted differently depending on what class of data the graph accepts. For details, refer to Chapter 12, "Data Organization."

The Graph.SetSeries method is unique in that it also accepts special color and symbol override commands. These commands dynamically change color or symbol properties for data items and/or series of data items. They are placed in parenthesis in front of the data items (for individual data items) or series names (for an entire series) that they are to effect, as demonstrated in Example 5.30.

The override commands are listed in Table 5.8 below.

Table 5.8 Color & Style Override Commands

Command	Description
CLR_	Overrides the color of a data item or series. The command should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color.
FCLR_	Overrides the fill color of a data item or series. This command affects only Radar, Area, X-Y, and Time Plot graphs. It should be followed by the six digit hexadecimal code of the overriding color.
LCLR_	Overrides the color of a series line. This command can only precede a series name, and must be used on a series that is being displayed as a line (e.g. Line graph, Radar, X-Y Line). It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
OCLR_	Overrides the outline color of a data item or series. This command affects only Bubble graphs. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
SCLR_	Overrides the symbol color of a data item or series. This command affects only Radar, X-Y, and Time Plot graphs. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
STYP_	Overrides the symbol type of a data item or series. This command affects only Radar, X-Y and Time Plot graphs. It should be followed by the symbol type. Table 5.9 on page 5-35 shows the symbol type enumeration.
DFCLR_	Overrides the fill color of Candlestick data items that closed down on the day. This command should be used only in front of a series name. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
DOCLR_	Overrides the outline color of Candlestick data items that closed down on the day. This command should be used only in front of a series name. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
UFCLR_	Overrides the fill color of Candlestick data items that closed up on the day. This command should be used only in front of a series name. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color
UOCLR_	Overrides the outline color of Candlestick data items that closed up on the day. This command should be used only in front of a series name. It should be followed by the six or eight digit (RGB plus Alpha) hexadecimal code of the overriding color

Parameters Graph.SetSeries accepts the following parameters.

SeriesName

String

The name of the series. This name will be shown in the legend.

DataItem

int [,int]*

A data item. Technically, a data item consists of any number of comma (or parameter delimiter) separated values, but the number of values that are actually used for the data item is between one and four, depending on the class of data that the graph accepts. For details, refer to Chapter 12, "Data Organization."

Each series can have an infinite number of data items. Each data item should be separated by a semi-colon (or the item delimiter, which is specified in the Main. ItemDelimiter method).