Graph object

A graph is a representation of a series of data points (values). The graph can have a single series of values or multiple series.

Properties

Graph property	Datatype	Description
AccessibleDescription	String	A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.
AccessibleName	String	A label that briefly describes the control, such as the text in a button or the name of a menu item.
AccessibleRole	AccessibleRole (enumerated)	Describes what kind of user interface element the control is.
BackColor	Long	Specifies the numeric value of the background color: -2 to 16,777,215. For more information about color, see the RGB function in the PowerScript Reference.
Border	Boolean	Specifies whether the control has a border.
BorderStyle	BorderStyle (enumerated)	Specifies the style of the border of the control. Values are: StyleBox! StyleLowered! StyleRaised! StyleShadowBox!
BringToTop	Boolean	Specifies whether PowerBuilder moves the control to the top of the front-to-back order of the window or DataWindow control.
Category	grAxis	Specifies the properties of the category axis of the graph.
CategorySort	grSortType	Specifies how the categories are sorted.
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.
Depth	Integer	Specifies the percent the depth is of the width of the graph.
DragAuto	Boolean	Specifies whether PowerBuilder will put the graph automatically into Drag mode. Values are: TRUE – When the control is clicked, the control is automatically in Drag mode. FALSE – When the control is clicked, the control is not automatically in Drag mode. You have to manually put the control into Drag mode by using the Drag function.
DragIcon	String	Specifies the name of the stock icon or the file containing the icon you want to display when the user drags a control (the ICO file). The default icon is a box the size of the control. When the user drags a control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.
Elevation	Integer	Specifies the angle of front-to-back elevation.
Enabled	Boolean	Specifies whether the control is enabled (can be selected). Values are: TRUE – Control can be selected. FALSE – Control cannot be selected.
FocusRectangle	Boolean	Specifies whether a dotted rectangle (the focus rectangle) will frame the control when it has focus. Values are: TRUE – Control will be framed when it has focus. FALSE – Control will not be framed when it has focus.
GraphType	grGraphType (enumerated)	Specifies the type of the graph. Values are: Area3D! AreaGraph! Bar3DGraph! Bar3DObjGraph! BarGraph! BarStack3DObjGraph! BarStackGraph! Col3DGraph! Col3DObjGraph! ColGraph! ColStack3DObjGraph! ColStackGraph! Line3D! LineGraph! Pie3D! PieGraph! ScatterGraph!
Height	Integer	Specifies the height of the control, in PowerBuilder units.
Legend	grLegendType (enumerated)	Specifies the alignment of the text in the graph legend. Values are: AtBottom! AtLeft! AtRight! AtTop! NoLegend!
LegendDispAttr	grDispAttr	Specifies the type style for the text in the graph legend, including the text style, size, color, and rotation.
OverlapPercent	Integer	Specifies the percent of the width of the data markers that different series in a graph overlap.
Perspective	Integer	Specifies the distance the graph is from the front of the window.
PieDispAttr	grDispAttr	Specifies properties of the text in pie graph labels, including the text style, size, color, and rotation.
Pointer	String	Contains the name of the stock pointer or the file containing the pointer used for the graph.
Rotation	Integer	Specifies how much to rotate the graph from left to right.
Series	grAxis	Specifies the series in the graph.
SeriesSort	grSortType	Specifies how the series are sorted.
ShadeColor	Long	Specifies the color used for the shading in the graph.
Spacing	Integer	Specifies the space between data markers in the graph as a percent.
TabOrder	Integer	Specifies the tab value of the control in the tabbing sequence (0 means the user cannot tab to the control).
Tag	String	Specifies the tag value of the control.
TextColor	Long	Specifies the color to be used for the text in the control.
Title	String	Specifies the text of the title for the graph.
TitleDispAttr	grDispAttr	Specifies the type style for the text in the graph title, including the text style, size, color, and rotation.
Values	grAxis	Specifies the values of the value axis of the graph.
Visible	Boolean	Specifies whether the control is visible. Values are: TRUE – Control is visible. FALSE – Control is not visible.
Width	Integer	Specifies the stroke weight of text in the control; for example, 400 for normal or 700 for bold.
X	Integer	Specifies the X position (the distance from the left edge of the parent window), in PowerBuilder units.
Y	Integer	Specifies the Y position (the distance from the top of the parent window), in PowerBuilder units.

Events

Graph event	Occurs
Clicked	When the control is clicked (selected or unselected).
Constructor	Immediately before the Open event occurs in the window.
Destructor	Immediately after the Close event occurs in the window.
DoubleClicked	When the control is double-clicked (selected or unselected).
DragDrop	When a dragged control is dropped on the control.
DragEnter	When a dragged control enters the control.
DragLeave	When dragged control leaves the control.
DragWithin	When a dragged control is within the control.
GetFocus	Just before the control receives focus (before it is selected and becomes active).
Help	When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control.
LoseFocus	When the control loses focus (becomes inactive).
Other	When a Windows message occurs that is not a PowerBuilder event.
RButtonDown	When the right mouse button is pressed on the control.

Functions

Graph function	Datatype returned	Description
AddCategory	Integer	Adds a category to the graph.
AddData	Long	Adds a value to the end of the specified series for the graph.
AddSeries	Integer	Adds a series to the graph and assigns the series a number.
CategoryCount	Integer	Counts the categories in the graph.
CategoryName	String	Obtains the name of the specified category in the graph.
ClassName	String	Returns the name assigned to the control.
Clipboard	Integer	Copies the graph in bitmap (BMP) format to the clipboard.
DataCount	Long	Returns the number of data points in a specified series in the graph.
DeleteCategory	Integer	Deletes the specified category and the data values in the series from the graph.
DeleteData	Integer	Deletes the data value in the specified data point in the specified series in the graph.
DeleteSeries	Integer	Deletes the specified series and the data values in the series from the graph.
Drag	Integer	Starts or ends dragging of the control.
FindCategory	Integer	Obtains the number of the specified category in the graph.
FindSeries	Integer	Obtains the number PowerBuilder assigned to the specified series when it was added to the graph.
GetContextService	Integer	Creates a reference to a context-specific instance of the specified service.
GetData	Double	Obtains the value of the specified data point in the specified series in the graph See also the GetDataValue function.
GetDataPieExplode	Integer	Reports the percentage that a pie slice is exploded in a pie graph.
GetDataStyle	Integer	Finds out the appearance of a data point in a series. Each data point in a series can have individual appearance settings. There are different syntaxes, depending on what settings you want to check: colors, line style, fill pattern, or symbol.
GetDataValue	Integer	Returns the value of the specified data in the specified series in the specified graph.
GetParent	PowerObject	Returns a reference to the name of the parent object.
GetSeriesStyle	Integer	Finds out the appearance of a series in a graph. The appearance settings for individual data points can override the series setting, so the values obtained from this function may not reflect the current state of the graph. There are several syntaxes, depending on what you want to get: colors; line style, fill pattern, or symbol; or whether the series is an overlay.
Hide	Integer	Makes the control invisible.
ImportClipboard	Long	Copies the contents of the clipboard to the graph starting in the specified column.
ImportFile	Long	Copies the contents of the specified file to the graph starting in the specified column.
ImportString	Long	Imports the contents from the specified string to the graph starting in the specified column.
InsertCategory	Integer	Inserts a new category before an existing category in the graph.
InsertData	Long	Inserts a new data point into the graph before a specified data point and moves existing data points to the right.
InsertSeries	Integer	Inserts a new series before an existing series in the graph.
ModifyData	Integer	Changes the value of the specified data point in the specified series in the graph to the specified value, and optionally modifies the data for the specified tick mark.
Move	Integer	Moves the control to a specified location.
ObjectAtPointer	GrObject Type	Stores the number of the series the pointer is over in the graph and the number of the specified data point in reference values, and identifies the object type.
PointerX	Integer	Returns the distance the pointer is from the left edge of the control.
PointerY	Integer	Returns the distance the pointer is from the top of the control.
PostEvent	Boolean	Adds an event to the end of the message queue for the control.
Print	Integer	Prints the control.
Reset	Integer	Deletes data in the graph as specified.
ResetDataColors	Integer	Resets the color of a data point to the series color.
Resize	Integer	Changes the size of the control.
SaveAs	Integer	Saves the contents of the graph to a file in the specified format.
SeriesCount	Integer	Determines how many series there are in the graph.
SeriesName	String	Obtains the name of the specified series in the graph.
SetDataPieExplode	Integer	Explodes a pie slice in a pie graph.
SetDataStyle	Integer	Specifies the appearance of a data point in a graph. There are several syntaxes, depending on what you want to set: colors, line style and width, or fill pattern or symbol.
SetFocus	Integer	Sets focus to the control.
SetPosition	Integer	Specifies the position of the control in the front-to-back order of the window.
SetRedraw	Integer	Controls automatic redrawing of the control after a change in its properties.
SetSeriesStyle	Integer	Specifies the appearance of a series in a graph. There are several syntaxes, depending on what you want to change: colors, line style and width, fill pattern or symbol, or whether the series is an overlay.
Show	Integer	Makes the control visible.
TriggerEvent	Integer	Triggers a specified event in the control and executes the script for the event.
TypeOf	Object	Returns the type of the control.