Syntax 1 For the colors of a series

Description

Obtains the colors associated with a series in a graph.

Controls

Graph controls in windows and user objects, and graphs in
DataWindow controls

Syntax

<span>controlname</span>.<span>GetSeriesStyle</span> ( { <span>graphcontrol</span>, } <span>seriesname</span>, <span>colortype</span>, <span>colorvariable</span> )

1	<span>controlname</span>.<span>GetSeriesStyle</span> ( { <span>graphcontrol</span>, } <span>seriesname</span>, <span>colortype</span>, <span>colorvariable</span> )

Argument	Description
controlname	The name of the graph in which you want to obtain the color of a series, or the name of the DataWindow control containing the graph.
graphcontrol (DataWindow control only)	(Optional) A string whose value is the name of the graph in the DataWindow control for which you want the color of a series.
seriesname	A string whose value is the name of the series for which you want the color.
colortype	A value of the grColorType enumerated datatype specifying the aspect of the series for which you want the color: Foreground! – Text color Background! – Background color LineColor! – Line color Shade! – Shade (for graphs that are 3-dimensional or have solid data markers)
colorvariable	A long variable in which you want to store the color’s RGB value.

Return Values

Integer. Returns 1 if it succeeds and
-1 if an error occurs. Stores in colorvariable the
RGB value of the specified series and item. If any argument’s value
is null, GetSeriesStyle returns null.

Examples

These statements store in the variable color_nbr
the text (foreground) color used for a series in the graph gr_emp_data.
The series name is the text in the SingleLineEdit sle_series:

long color_nbr

1	long color_nbr

gr_emp_data.<span>GetSeriesStyle</span>(sle_series.Text, &amp;

1	gr_emp_data.<span>GetSeriesStyle</span>(sle_series.Text, &

&#160;&#160;&#160;Foreground!, color_nbr)

1	Foreground!, color_nbr)

These statements store in the variable color_nbr the
background color used for the series PCs in the graph gr_computers in
the DataWindow control dw_equipment:

long color_nbr

1	long color_nbr

// Get the color.

1	// Get the color.

dw_equipment.<span>GetSeriesStyle</span>("gr_computers", &amp;

1	dw_equipment.<span>GetSeriesStyle</span>("gr_computers", &

&#160;&#160;&#160;"PCs", Background!, color_nbr)

1	"PCs", Background!, color_nbr)

These statements store the color for the series under
the mouse pointer in the graph gr_product_data in line_color:

string SeriesName

1	string SeriesName

integer SeriesNbr, Data_Point

1	integer SeriesNbr, Data_Point

long line_color

1	long line_color

grObjectType MouseHit

1	grObjectType MouseHit

MouseHit = ObjectAtPointer(SeriesNbr, Data_Point)

1	MouseHit = ObjectAtPointer(SeriesNbr, Data_Point)

IF MouseHit = TypeSeries! THEN

1	IF MouseHit = TypeSeries! THEN

&#160;&#160;&#160;SeriesName = &amp;

1	SeriesName = &

&#160;&#160;&#160;&#160;&#160;&#160;gr_product_data.SeriesName(SeriesNbr)

1	gr_product_data.SeriesName(SeriesNbr)

&#160;&#160;&#160;gr_product_data.<span>GetSeriesStyle</span>(SeriesName, &amp;

1	gr_product_data.<span>GetSeriesStyle</span>(SeriesName, &

&#160;&#160;&#160;&#160;&#160;&#160;LineColor!, line_color)

1	LineColor!, line_color)

END IF

END IF

Connection Information

Syntax 1 For the colors of a series – PB Docs 125