Chart Methods

This group lists Chart methods of the Standard API. More...

Detailed Description

This group lists Chart methods of the Standard API.

The Chart methods of the Intermediate API and the Chart methods of the C API contain additional methods that can be used to manipulate a Chart object.

Functions
GlgObject	AddPlot (char *resource_name, GlgObjectC &plot)
	Adds a plot to this chart. More...
GlgBoolean	DeletePlot (char *resource_name, GlgObjectC &plot)
	Deletes a plot from this chart. More...
GlgBoolean	GetChartDataExtent (char *resource_name, GlgMinMax *min_max, GlgBoolean x_extent, GlgBoolean visible_only)
	Queries the minimum and maximum extent of the data accumulated in thischart or in one of its plots. More...
GlgObject	GetNamedPlot (char *resource_name, char *plot_name)
	Given a name of this chart's plot, returns the plot's object ID. More...

Function Documentation

AddPlot()

GlgObject AddPlot	(	char *	resource_name,
		GlgObjectC &	plot
	)

Adds a plot to this chart.

This is a wrapper for GlgAddPlot.

Parameters

resource_name	A resource path for accessing the chart inside this object. Use NULL when this object is the chart.
plot	An object ID of a plot object. NULL may be used to create a new plot.

Returns

An object ID of the added plot on success, or NULL if it fails.

If the plot parameter is NULL, the returned plot is referenced only by the chart's plot array it has been added to and may be destroyed when the number of plots changes. The program can store the plot in a GlgObjectC instance to keep a persistent reference to the plot.

DeletePlot()

GlgBoolean DeletePlot	(	char *	resource_name,
		GlgObjectC &	plot
	)

Deletes a plot from this chart.

This is a wrapper for GlgDeletePlot.

Parameters

resource_name	A resource path for accessing the chart inside this object. Use NULL when this object is the chart.
plot	The plot to delete.

Returns

True if the plot was successfully deleted.

GetChartDataExtent()

GlgBoolean GetChartDataExtent	(	char *	resource_name,
		GlgMinMax *	min_max,
		GlgBoolean	x_extent,
		GlgBoolean	visible_only
	)

Queries the minimum and maximum extent of the data accumulated in thischart or in one of its plots.

This is a wrapper for GlgGetChartDataExtent.

Parameters

resource_name	Specifies a resource path for accessing a child chart, plot or axis object inside this object. NULL may be used if this object is a Chart, Plot or Axis object.
min_max	Returned data extent.
x_extent	If True, the method returns the X extent, otherwise it returns the Y extent.
visible_only	If True, the method considers only visible data samples when calculating data extent, otherwise all samples are considered.

Returns

Success or failure status.

For a Chart object, the data extent of all plots in the chart is returned. For a Plot object, the data extent of that plot is returned.

The object hierarchy must be set up for this method to succeed.

GetNamedPlot()

GlgObject GetNamedPlot	(	char *	resource_name,
		char *	plot_name
	)

Given a name of this chart's plot, returns the plot's object ID.

This is a wrapper for GlgGetNamedPlot.

Parameters

resource_name	A resource path for accessing the chart inside this object. Use NULL when this object is the chart.
plot_name	The plot name.

Returns

The found plot, or NULL if a plot with the specified name was not found.