Detailed Description

Superclass of all GLG objects. Provides the GLG API functionality (Standard, Intermediate and Extended) for all GLG objects.

PROGRAMMING NOTES

Global methods of the GlgObject class are marked with the static prefix and must be invoked on the GLG Toolkit handle obtaned via a "new GlgToolkit()" call at the application start-up. For example:
var GLG = new GlgToolkit();
GLG.LoadWidgetFromURL( "drawing.g", null, LoadCB, null );
Methods not marked with the static prefix are instance methods invoked on a GlgObject instance. For example:
viewport.Update();
The GlgObject instances are wrappers around the internal representation of the GLG objects. Because of that, the equality operator (==) cannot be used to compare if two instances of the GlgObject refer to the same actual GLG object. The Equals instance method or the ObjectsEqual global (static) method must be used instead. For example:
var same_object = object1.Equals( object2 );
same_object = GLG.ObjectsEqual( object1, object2 );
The GlgObject instances received as parameters of a callback function, such as the Input or Trace callback, are valid only inside the callback and the assignment operator (=) cannot be used to store them in global variables to be used outside of the callback (the only exception are GlgObject instances received as parameters of the load callbacks). The global GetReference method must be used to store GlgObject in a global variable in a way that allows it to be used outside of the callback. For example:
GlobalRef = GLG.GetReference( viewport );
To minimize garbage collection, the ReleaseToCache method may be used to collect temporary objects, such as GlgPoint or GlgCube, after they have been used. ReleaseToCache may also be invoked on temporary GlgObject instances, in which case it will release to the cache the object's wrapper instance, without affecting the internal GLG object the wrapper refers to. For example:
    var point = object.GetGResource( "Point1" );
    MyFunction( point );
    GLG.ReleaseToCache( point );

Public Member Functions
void	AbortGISRequest (String res_name)

GlgObject	AddAnnotation (String res_name, GlgObject annotation, double position_x, double position_y, boolean add_box)

GlgObject	AddAttachmentPoint (double dx, double dy, double dz)

void	AddListener (GlgCallbackType type, function callback)

boolean	AddObjectAt (Object obj, int index)

boolean	AddObjectToBottom (Object obj)

boolean	AddObjectToTop (Object obj)

GlgObject	AddPlot (String res_name, GlgObject plot)

void	AddPlotDataSample (double value, double time_stamp, boolean valid, float marker_visibility, boolean quick_mode)

GlgObject	AddTimeLine (String res_name, GlgObject time_line, double time_stamp)

void	ChangeObject (String res_name)

boolean	ClearDataBuffer (String res_name)

GlgObject	CloneObject (GlgCloneType clone_type)

boolean	ConstrainObject (GlgObject to_attribute)

boolean	ContainsObject (Object obj)

GlgObject	CopyObject ()

GlgObject	CreateAlarmList ()

GlgObject	CreateChartSelection (GlgObject plot, double x, double y, double dx, double dy, boolean screen_coord, boolean include_invalid, boolean x_priority)

GlgObject	CreateInversedMatrix ()

GlgObject	CreatePointArray (GlgControlPointType type)

GlgObject	CreateResourceList (boolean list_named_res, boolean list_def_attr, boolean list_aliases)

GlgObject	CreateTagList (boolean unique_tag_sources)

String	CreateTooltipString (double x, double y, double dx, double dy, String format)

boolean	DeleteAnnotation (String res_name, GlgObject annotation, double position_x, double position_y)

boolean	DeleteBottomObject ()

boolean	DeleteObjectAt (int index)

boolean	DeletePlot (String res_name, GlgObject plot)

boolean	DeleteTags (GlgTagType tag_type_mask)

boolean	DeleteThisObject (Object obj)

boolean	DeleteTimeLine (String res_name, GlgObject time_line, double time_stamp)

boolean	DeleteTopObject ()

boolean	Equals (GlgObject object)

Object	ExportStrings (String separator1, String separator2)

Object	ExportTags (String separator1, String separator2)

boolean	FindMatchingObjects (GlgObjectMatchType match_type, boolean find_parents, boolean find_first_match, boolean search_inside, boolean search_drawable_only, GlgObjectType object_type, String object_name, String resource_name, GlgObject object_id, function custom_match)

boolean	FitObject (GlgCoordType coord_type, GlgCube box, boolean keep_ratio)

void	Flush (int size)

GlgObject	GetAction (GlgActionType action_type, GlgTriggerType trigger_type, int button, GlgArmedStateType armed_state, GlgDoubleClickStateType double_click_state, String action, String subaction, boolean enabled_only)

GlgObject	GetAlarmObject (String alarm_label, boolean single_alarm)

GlgCube	GetBox ()

GlgMinMax	GetChartDataExtent (String res_name, boolean time, boolean visible_only)

GlgMinMax	GetDataExtent (String res_name, boolean time)

GlgDataType	GetDataType ()

GlgObject	GetDrawingMatrix ()

double	GetDResource (String resource_name)

double	GetDTag (String tag_source)

Object	GetElement (int index)

GlgGISRequestObserver	GetGISRequestInfo (String res_name)

GlgPoint	GetGResource (String resource_name)

GlgPoint	GetGTag (String tag_source)

int	GetIndex (Object obj)

GlgObject	GetLegendSelection (double x, double y)

GlgMatrixData	GetMatrixData (GlgMatrixData matrix_data)

GlgObject	GetNamedObject (String name)

GlgObject	GetNamedPlot (String res_name, String plot_name)

Object	GetNativeComponent (String res_name, GlgComponentQueryType type)

int	GetNumParents ()

String	GetObjectName ()

GlgObjectType	GetObjectType ()

GlgObject	GetParent ()

GlgObject	GetParentViewport (boolean heavy_weight)

Object	GetResource (String resource_name)

GlgObject	GetResourceObject (String resource_name)

int	GetSize ()

String	GetSResource (String resource_name)

String	GetSTag (String tag_source)

int	GetStringIndex (String search_string)

GlgObject	GetTagObject (String search_string, boolean by_name, boolean unique_tags, boolean single_tag, GlgTagType tag_type_mask)

boolean	GISConvert (String res_name, GlgCoordType coord_type, boolean coord_to_lat_lon, GlgPoint in_point, GlgPoint out_point)

boolean	GISCreateSelection (String res_name, String layers, double x, double y, GlmLabelSelectionMode select_labels, function callback)

boolean	GISGetElevation (String res_name, String layer_name, double lon, double lat, function callback)

boolean	HasResourceObject (String resource_name)

boolean	HasTag (String tag_name, GlgTagType tag_type_mask)

boolean	HasTagName (String tag_name)

boolean	HasTagSource (String tag_source)

int	ImportStrings (String data, boolean verbose)

int	ImportTags (String data, boolean verbose)

void	InitialDraw ()

boolean	InstallGISRequest (String res_name)

void	Inverse ()

boolean	IsAt (GlgPositionType position)

boolean	IsDrawable ()

Object	Iterate ()

Object	IterateBack ()

boolean	LayoutObjects (GlgObject sel_elem, GlgLayoutType type, double distance, boolean use_box, boolean process_subobjects)

boolean	MoveObject (GlgCoordType coord_type, GlgPoint start_point, GlgPoint end_point)

boolean	MoveObjectBy (GlgCoordType coord_type, double x, double y, double z)

boolean	MoveObjectByPoint (GlgCoordType coord_type, GlgPoint point)

boolean	PositionObject (GlgCoordType coord_type, GlgAnchoringType anchoring, double x, double y, double z)

boolean	PositionObjectByPoint (GlgCoordType coord_type, GlgAnchoringType anchoring, GlgPoint position)

double	PositionToValue (String res_name, double x, double y, boolean outside_x, boolean outside_y)

GlgObject	QueryTags (GlgTagType tag_type_mask)

void	ReleaseObject (GlgObject suspend_info)

boolean	ReorderElement (int current_index, int new_index)

boolean	RequestGISMap (String res_name, double extent_x, double extent_y, double center_x, double center_y, double angle, GlgProjectionType projection, String layers, GlgGISRequestFlags flags, GlgGISRequestObserver request_observer)

boolean	RequestGISZoom (String res_name, char type, double value, GlgGISRequestObserver request_observer)

boolean	Reset ()

void	ResetHierarchy ()

boolean	RotateObject (GlgCoordType coord_type, GlgPoint center, double x, double y, double z)

Uint8List	SaveObject (String encoding)

boolean	ScaleObject (GlgCoordType coord_type, GlgPoint center, double x, double y, double z)

boolean	ScreenToWorld (boolean inside_vp, GlgPoint in_point, GlgPoint out_point)

Object	SendMessageToObject (String res_name, String message, Object param1, Object param2, Object param3, Object param4)

boolean	SetDResource (String resource_name, double value)

boolean	SetDResourceIf (String resource_name, double value, boolean if_changed)

boolean	SetDTag (String tag_source, double value, boolean if_changed)

boolean	SetElement (int index, Object new_object)

void	SetEnd ()

void	SetFocus (String res_name)

boolean	SetGResource (String resource_name, double g_value1, double g_value2, double g_value3)

boolean	SetGResourceFromPoint (String resource_name, GlgPoint g_value)

boolean	SetGResourceFromPointIf (String resource_name, GlgPoint g_value, boolean if_changed)

boolean	SetGResourceIf (String resource_name, double g_value1, double g_value2, double g_value3, boolean if_changed)

boolean	SetGTag (String tag_source, double g_value1, double g_value2, double g_value3, boolean if_changed)

boolean	SetGTagObj (String tag_source, GlgPoint g_value, boolean if_changed)

boolean	SetLabelFormatter (String res_name, GlgLabelFormatter formatter)

boolean	SetLinkedAxis (String res_name, GlgObject axis_object, String axis_res_name)

void	SetMatrixData (GlgMatrixData matrix_data)

void	SetParentElement (String element_id)

boolean	SetResource (String resource_name, Object value)

boolean	SetResourceFromObject (String resource_name, GlgObject o_value)

boolean	SetResourceFromObjectIf (String resource_name, GlgObject o_value, boolean if_changed)

boolean	SetResourceObject (String resource_name, GlgObject value)

GlgGISRequestObserver	SetScrollbarObserver (String res_name, GlgGISRequestObserver request_observer)

boolean	SetSResource (String resource_name, String s_value)

boolean	SetSResourceFromD (String resource_name, String format, double d_value)

boolean	SetSResourceFromDIf (String resource_name, String format, double d_value, boolean if_changed)

boolean	SetSResourceIf (String resource_name, String s_value, boolean if_changed)

boolean	SetSTag (String tag_source, String s_value, boolean if_changed)

boolean	SetSTagFromD (String tag_source, String format, double d_value, boolean if_changed)

void	SetStart ()

void	SetTemplate (GlgObject template)

void	SetupHierarchy ()

boolean	SetXform (GlgObject xform)

boolean	SetZoom (String res_name, char type, double value)

boolean	SetZoomMode (String res_name, GlgObject zoom_object, String zoom_object_name, GlgZoomMode zoom_mode)

GlgObject	SuspendObject ()

boolean	TransformObject (GlgObject xform, GlgCoordType coord_type, GlgObject parent)

void	TransformPoint (GlgPoint in_point, GlgPoint out_point)

void	TraverseObjects (function action)

boolean	UnconstrainObject ()

boolean	Update ()

boolean	UpdateImmediately ()

void	UpdateSize ()

boolean	WorldToScreen (boolean inside_vp, GlgPoint in_point, GlgPoint out_point)

Static Public Member Functions
static void	AddDataSample (GlgObject plot, GlgDataSample datasample)

static void	AddGlobalListener (GlgCallbackType type, function callback)

static void	Bell ()

static void	BellExt (double volume, double frequency, double duration)

static String	ConcatResNames (String resource_name1, String resource_name2)

static GlgObject	ConvertViewportType (GlgObject obj)

static String	CreateIndexedName (String template_name, int resource_index)

static GlgObject	CreateObject (GlgObjectType type, Object param1, Object param2, Object param3, Object param4)

static GlgObject	CreateSelection (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp)

static GlgObject	CreateSelectionFromEvent (int x, int y, int delta, GlgObject top_vp, GlgObject selected_vp)

static GlgObject	CreateSelectionMessage (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp, GlgSelectionEventType selection_type, int button)

static GlgObject	CreateSelectionNames (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp)

static GlgObject	CreateSelectionNamesFromEvent (int x, int y, int delta, GlgObject top_vp, GlgObject selected_vp)

static boolean	EnableAttachmentPoints (boolean state)

static boolean	EnableTimerXforms (boolean state)

static void	Error (GlgErrorType error_type, String message, Object exception)

static String	GetLibraryVersion ()

static boolean	GetModifierState (GlgModifierType modifier)

static int	GetPendingInstances ()

static int	GetPendingTemplates ()

static GlgObject	GetReference (GlgObject object)

static GlgObject	GetSelectedPlot ()

static String	GetStackTraceAsString ()

static boolean	GetTouchMode ()

static void	GlmConvert (GlgProjectionType projection, boolean stretch, GlgCoordType coord_type, boolean coord_to_lat_lon, GlgPoint center, GlgPoint extent, double angle, double min_x, double max_x, double min_y, double max_y, GlgPoint in_point, GlgPoint out_point)

static boolean	IHCallCurrIH (GlgCallEvent call_event)

static boolean	IHCallCurrIHWithModifToken (GlgCallEvent call_event, int token)

static boolean	IHCallCurrIHWithToken (int token)

static void	IHCallPrevIHWithModifToken (GlgCallEvent call_event, int token)

static void	IHCallPrevIHWithToken (int token)

static void	IHChangeBParameter (GlgObject ih, String name, boolean value)

static void	IHChangeDParameter (GlgObject ih, String name, double value)

static void	IHChangeIParameter (GlgObject ih, String name, int value)

static void	IHChangeNParameter (GlgObject ih, String name, Object value)

static void	IHChangeOParameter (GlgObject ih, String name, GlgObject value)

static void	IHChangeSParameter (GlgObject ih, String name, String value)

static boolean	IHGetBParameter (GlgObject ih, String name)

static GlgObject	IHGetCurrIH ()

static double	IHGetDParameter (GlgObject ih, String name)

static GlgIHHandlerInterface	IHGetHandlerInterface (GlgObject ih)

static int	IHGetIParameter (GlgObject ih, String name)

static Object	IHGetNParameter (GlgObject ih, String name)

static GlgObject	IHGetOParameter (GlgObject ih, String name)

static boolean	IHGetOptBParameter (GlgObject ih, String name, boolean default_value)

static double	IHGetOptDParameter (GlgObject ih, String name, double default_value)

static int	IHGetOptIParameter (GlgObject ih, String name, int default_value)

static Object	IHGetOptNParameter (GlgObject ih, String name, Object default_value)

static GlgObject	IHGetOptOParameter (GlgObject ih, String name, GlgObject default_value)

static String	IHGetOptSParameter (GlgObject ih, String name, String default_value)

static GlgIHHandlerInterface	IHGetPrevHandlerInterface ()

static GlgObject	IHGetPrevIH ()

static String	IHGetSParameter (GlgObject ih, String name)

static int	IHGetToken (GlgCallEvent call_event)

static GlgCallEventType	IHGetType (GlgCallEvent call_event)

static void	IHInit ()

static GlgObject	IHInstall (GlgIHHandlerInterface interface_handler)

static GlgObject	IHInstallAsInterface (function entry_point)

static void	IHPassToken (GlgIHHandlerInterface handler_interface, int token, boolean uninstall)

static void	IHResetup (GlgObject ih)

static void	IHSetBParameter (GlgObject ih, String name, boolean value)

static void	IHSetDParameter (GlgObject ih, String name, double value)

static void	IHSetIParameter (GlgObject ih, String name, int value)

static void	IHSetNParameter (GlgObject ih, String name, Object value)

static void	IHSetOParameter (GlgObject ih, String name, GlgObject value)

static void	IHSetOParameterFromD (GlgObject ih, String name, double value)

static void	IHSetOParameterFromG (GlgObject ih, String name, double value1, double value2, double value3)

static void	IHSetOParameterFromGPoint (GlgObject ih, String name, GlgPoint point)

static void	IHSetSParameter (GlgObject ih, String name, String value)

static void	IHStart ()

static void	IHTerminate ()

static void	IHUninstall ()

static void	IHUninstallWithEvent (GlgCallEvent call_event)

static void	IHUninstallWithToken (int token)

static void	Init ()

static boolean	IsDemo ()

static void	LoadAsset (String url, GlgHTTPRequestResponseType request_type, function callback, Object user_data)

static GlgObject	LoadObject (Object data, String encoding, String path, GlgObject rebind_ref)

static void	LoadObjectFromURL (String url, String encoding, function callback, Object user_data, function abort_func, GlgObject rebind_ref)

static GlgObject	LoadWidget (Object data, String encoding, String path)

static GlgObject	LoadWidgetFromObject (GlgObject glg_object)

static void	LoadWidgetFromURL (String url, String encoding, function callback, Object user_data, function abort_func)

static boolean	ObjectsEqual (GlgObject object1, GlgObject object2)

static String	PrintfD (String format, double value)

static String	PrintfI (String format, int value)

static String	PrintfS (String format, String value)

static double	Rand (double low, double high)

static	ReleaseToCache (Object object)

static boolean	RootToScreenCoord (GlgObject viewport, GlgPoint root_coord)

static GlgAlarmHandler	SetAlarmHandler (GlgAlarmHandler alarm_handler)

static boolean	SetAttachmentMoveMode (boolean state)

static void	SetCanvasScale (double scale, double text_scale, double native_text_scale)

static void	SetCustomLoadFunc (Function(String, String, int, Function(int, Object)) func)

static boolean	SetEditMode (GlgObject viewport, String res_name, boolean edit_mode)

static GlgErrorHandler	SetErrorHandler (GlgErrorHandler new_handler)

static void	SetLocale (String locale)

static GlgTooltipFormatter	SetTooltipFormatter (GlgTooltipFormatter formatter)

static void	SetTouchMode ()

static void	Terminate ()

static void	ThrowExceptionOnError (boolean user_error, boolean internal_error, boolean detect_null_strings)

static void	TranslatePointOrigin (GlgObject from_viewport, GlgObject to_viewport, GlgPoint point)

static boolean	TraverseObjects (GlgObject object, boolean state, boolean is_widget, GlgObject top_parent, function action)

Static Public Attributes
static GlgObject	IH_CURR = null

static GlgObject	IH_GLOBAL = null

static GlgObject	IH_NEW = null

Member Function Documentation

void AbortGISRequest ( String res_name )

Intermediate API: Aborts the GIS request in progress, if any.

Parameters

res_name If is not null, specifies the resource path of child GIS object, otherwise this GIS object will be used.

GlgObject AddAnnotation	(	String	res_name,
		GlgObject	annotation,
		double	position_x,
		double	position_y,
		boolean	add_box
	)

Adds an annotation to a chart.

Parameters

res_name	The resource path of a child chart to add the annotation to, or null to add to this chart object.
annotation	The annotation object to add, or null to create a new annotation.
position_x	The annotation's X position.
position_y	The annotation's Y position.
add_box	If set to true, a text box will be added to the annotation label if the new annnotation is created.

Returns: The added annotation object, or null on failure.

GlgObject AddAttachmentPoint	(	double	dx,
		double	dy,
		double	dz
	)

Extended API: Adds an attachment point to a reference object at the specified offset from its anchor point. The offset is in world coordinates for resizable reference objects and in screen corrdinates for fixed size references.

Parameters

dx	X offset
dy	Y offset
dz	Z offset

Returns: Created attachment point.

static void AddDataSample	(	GlgObject	plot,
		GlgDataSample	datasample
	)

static

Deprecated, use AddDataSampleNode.

static void AddGlobalListener	(	GlgCallbackType	type,
		function	callback
	)

static

Adds a global listener for TemplateLoad events.

Parameters

type	Callback type: TEMPLATE_LOAD_CB
callback	A callback function with the type signature matching the type signature of the GlgTemplateLoadListener::TemplateLoadCallback method. This function will be invoked to handle TemplateLoad events generated by subwindows and subdrawings when their templates are loaded.

void AddListener	(	GlgCallbackType	type,
		function	callback
	)

Adds a listener for GLG events to a viewport or light viewport.

Light viewports support only input listeners, while viewport objects support all listener types.

Parameters

type	Callback type: SELECT_CB, INPUT_CB, TRACE_CB or TRACE2_CB. (defined in the GlgCallbackType enum).
callback	A callback function with the type signature matching the type signature of the methods of the corresponding listener objects: GlgInputListener::InputCallback() for INPUT_CB GlgSelectListener::SelectCallback() for SELECT_CB GlgHierarchyListener::HierarchyCallback() for HIERARCHY_CB GlgTraceListener::TraceCallback() for TRACE_CB and TRACE2_CB.

This function will be invoked to handle events of the requested listener type.

boolean AddObjectAt	(	Object	obj,
		int	index
	)

Extended API: Adds object to the container at the specified position.

Parameters

obj	Object to add
index	Position index

boolean AddObjectToBottom ( Object obj )

Extended API: Adds object to the bottom of the container.

Parameters

obj	Object to add

boolean AddObjectToTop ( Object obj )

Extended API: Adds object to the top of the container.

Parameters

obj	Object to add

GlgObject AddPlot	(	String	res_name,
		GlgObject	plot
	)

Adds a plot line to a chart.

Parameters

res_name	The resource path of a child chart to add the plot to, or null to add to this chart object.
plot	The plot object. It null is specified, the method creates a plot with default parameters.

Returns: The added plot object.

void AddPlotDataSample	(	double	value,
		double	time_stamp,
		boolean	valid,
		float	marker_visibility,
		boolean	quick_mode
	)

Intermediate API, ADVANCED: Adds a new datasample with the supplied values to this plot's data buffer. If the plot uses a cache, and the cache is not empty, the new datasample will be taken from the plot's cache.

Parameters

value	The datasample value.
time_stamp	The time stamp.
valid	The valid flag.
marker_visibility	The marker visibility in the range [0;1].
quick_mode	Enables a quick mode that bypasses chart autoscroll and autoscale logic for faster chart prefilling, and also disables all validity checks for increased performance of charts with large number of data samples. To scroll the chart to the last added sample when done adding samples, set the chart XAxis' EndValue to the time stamp of the last sample. It is recommended that the initial development is done with quick_mode=false, switching to quick_mode=true when all potential errors have been dealt with.

GlgObject AddTimeLine	(	String	res_name,
		GlgObject	time_line,
		double	time_stamp
	)

Adds a time line to a chart.

Parameters

res_name	The resource path of a child chart to add the time line to, or null to add to this chart object.
time_line	The time line object to add, or null to create a new time line.
time_stamp	The time stamp to assign to the added time line.

Returns: The added time line object, or null on failure.

static void Bell ( )

static

Emits an audio beep. See BellExt for more control over the audio beep parameters.

static void BellExt	(	double	volume,
		double	frequency,
		double	duration
	)

static

Emits a beeping sound with the specified parameters.

The Bell method uses this method with the following parameters:

BellExt( 0.03, 520, 0.1 )

Parameters

volume	The sound volume
frequency	The sound frequency
duration	The sound duration

void ChangeObject ( String res_name )

Forces a change event for an object.

boolean ClearDataBuffer ( String res_name )

Clears data buffer of a chart or a plot object.

For a chart object, the method clears data buffers of all its plots. For a plot object, the method clears the buffer of the plot.

Parameters

res_name The resource path of a child chart or a child's plot to clear the buffer of, or null to clear this object.

Returns: false if the buffer did not contain any data samples, or true otherwise.

GlgObject CloneObject ( GlgCloneType clone_type )

Extended API: Creates and returns a copy of an object according to the clone_type.

The WEAK_CLONE, STRONG_CLONE, FULL_CLONE or CONSTRAINED_CLONE clone types differ in the way they handle objects' Global flag settings.

The SHALLOW_CLONE fills the returned group with the object IDs of the elements of the original group without copying the elements.

Returns: Object copy

static String ConcatResNames	(	String	resource_name1,
		String	resource_name2
	)

static

Concatenates two resource names, inserting the "/" separator if necessary.

Parameters

resource_name1	Resource path
resource_name2	Resource name

Returns: Created name

boolean ConstrainObject ( GlgObject to_attribute )

Intermediate API: Constrains the attribute object.

Parameters

to_attribute The object to constrain to

boolean ContainsObject ( Object obj )

Intermediate API: Checks if the object is contained in the container.

Parameters

obj	The object to search for.

Returns: true if the object is contained in the container.

static GlgObject ConvertViewportType ( GlgObject obj )

static

Extended API: Converts viewport to a light viewport, or a light viewport to a viewport.

Parameters

obj	Object to be converted: viewport or light viewport.

Returns: Converted object on success, or null on error.

GlgObject CopyObject ( )

Extended API: Creates a copy of an object using FULL_CLONE copy method.

Returns: Object copy

GlgObject CreateAlarmList ( )

Returns a list of all alarms defined in the object.

GlgObject CreateChartSelection	(	GlgObject	plot,
		double	x,
		double	y,
		double	dx,
		double	dy,
		boolean	screen_coord,
		boolean	include_invalid,
		boolean	x_priority
	)

Intermediate API, ADVANCED: Returns chart selection corresponding to the screen point.

Parameters

plot	The plot to create selection for, or null to query all plots of this chart.
x	The x/time coordinate.
y	The y coordinate.
dx	The x distance around the point. Datasamples with greater x distances from the point will not be considered.
dy	The y distance around the point. Datasamples with greater y distances from the point will not be considered. not be considered.
screen_coord	If set to true, the coordinates are supplied in screen pixels (with pixel0 center at 0.5). If set to false, x coordinates are suplied in the units of the chart's X axis (x or time value), and y coordinates are supplied in relative units with the [0,1] range corresponding to the min/max of each datagroup. Relative ranges are used to allow for uniform handling of multiple datagroups.
include_invalid	If set to true, invalid samples will be reported if their time stamp matches the x coordinate.
x_priority	If set to true, a point with the smallest x deviation will be selected, otherwise a point with the smallest xy distance will be selected.

Returns: Selection object (a group containing properties of the selected datasample). Refer to the Chart Selection Message Object section of the GLG Programming Reference Manual for detailed description of the chart selection object.

static String CreateIndexedName	(	String	template_name,
		int	resource_index
	)

static

Creates an indexed name by inserting a number into the first % character of the name template.

Returns: Created name

GlgObject CreateInversedMatrix ( )

Intermediate API, ADVANCED: Creates and returns a matrix that is an inverse of this matrix.

Returns: Inversed matrix

static GlgObject CreateObject	(	GlgObjectType	type,
		Object	param1,
		Object	param2,
		Object	param3,
		Object	param4
	)

static

Extended API: Creates a GlgObject of the requested type.

Parameters

type	GLG object type
param1	An optional object creation parameter that depends on the object type.
param2	An optional object creation parameter that depends on the object type.
param3	An optional object creation parameter that depends on the object type.
param4	An optional object creation parameter that depends on the object type.

Returns: The created GLG object.

Refer to the Using GlgCreateObject section of the C/C++ Extended API in the GLG Programming Reference Manual for description of parameter values.

GlgObject CreatePointArray ( GlgControlPointType type )

Intermediate API, ADVANCED: Creates an array containing all of an object's control points.

Parameters

type	Reserved for future use.

Returns: Array of the object's control points.

GlgObject CreateResourceList	(	boolean	list_named_res,
		boolean	list_def_attr,
		boolean	list_aliases
	)

Intermediate API, ADVANCED: Queries object's resources.

Creates an array of all resource names of this object on one level of hierarchy.

Parameters

list_named_res	Include named resources if true
list_def_attr	Include default attributes if true
list_aliases	Include aliases if true

Returns: An array of resources containing named resource objects, or dummy named objects for defauilt resources and aliases.

static GlgObject CreateSelection	(	GlgObject	top_vp,
		GlgCube	rectangle,
		GlgObject	selected_vp
	)

static

Intermediate API, ADVANCED: Creates an array of objects selected by a rectangle.

This is the same as CreateSelectionNames, but returns an array of selected objects on the bottom of the hierarchy instead of an array of object names.

Parameters

top_vp	The top viewport of the drawing
rectangle	Rectangle in screen coordinates of the selected_vp.
selected_vp	The selection viewport.

Returns: Array of objects selected by the rectangle.

static GlgObject CreateSelectionFromEvent	(	int	x,
		int	y,
		int	delta,
		GlgObject	top_vp,
		GlgObject	selected_vp
	)

static

Intermediate API, ADVANCED: Creates object selection from a mouse event.

Parameters

x	X coordinate of the event
y	Y coordinate of the event
delta	Mouse sensitivity in pixels
top_vp	The top viewport of the drawing
selected_vp	The viewport of the mouse event.

Returns: Array of objects selected by the mouse event.

static GlgObject CreateSelectionMessage	(	GlgObject	top_vp,
		GlgCube	rectangle,
		GlgObject	selected_vp,
		GlgSelectionEventType	selection_type,
		int	button
	)

static

ADVANCED: Alternative interface to custom events and commands. Finds the first object selected by the specified rectangle that contains a matching action attached and returns a custom event or command message for the found action. The message is the same as the one received in the Input callback on mouse click or mouse over event. The rectangle is used to select an object with an attached custom event or command action, instead of using the mouse event for selecting an object. The first selected custom event or command message is returned, or null if no objects with custom event or command actions were selected.

Parameters

top_vp	The top viewport of the drawing
rectangle	Rectangle in screen coordinates of the selected_vp.
selected_vp	The selection viewport in which rectangle coordinates are defined.
selection_type	CLICK_SELECTION, MOVE_SELECTION or TOOLTIP_SELECTION.
button	selection button for click selection or 0.0

Returns: Custom event or command message object containing information about the selected object.

static GlgObject CreateSelectionNames	(	GlgObject	top_vp,
		GlgCube	rectangle,
		GlgObject	selected_vp
	)

static

ADVANCED: Creates an array of objects selected by a rectangle.

Parameters

top_vp	The top viewport of the drawing
rectangle	Rectangle in screen coordinates of the selected_vp.
selected_vp	The selection viewport in which rectangle coordinates are defined.

Returns: Array of names of all objects selected by the rectangle.

static GlgObject CreateSelectionNamesFromEvent	(	int	x,
		int	y,
		int	delta,
		GlgObject	top_vp,
		GlgObject	selected_vp
	)

static

ADVANCED: Creates object selection from a mouse event.

This method is useful for use with the Trace callback to implement custom selection logic based on the mouse events.

Parameters

x	X coordinate relative to the selected_vp.
y	Y coordinate relative to the selected_vp.
delta	Mouse sensitivity in pixels
top_vp	The top viewport of the drawing
selected_vp	The viewport of the mouse event.

Returns: Array of names of all objects selected by the mouse event.

GlgObject CreateTagList ( boolean unique_tag_sources )

Returns a list of all tags of the DATA_TAG type defined in the object

Parameters

unique_tag_sources If set to true, only the first encountered tag will be reported for tags with the same tag sources.

String CreateTooltipString	(	double	x,
		double	y,
		double	dx,
		double	dy,
		String	format
	)

Intermediate API, ADVANCED: Returns tooltip string corresponding to the screen point.

Parameters

x	The x coordinate.
y	The y coordinate.
dx	The x distance around the point for chart tooltips. Datasamples with greater x distances from the point will not be considered.
dy	The y distance around the point for chart tooltips. Datasamples with greater y distances from the point will not be considered.
format	Tooltip format. Pass null to use default tooltip, pass "<single_line>" to use default tooltip without line breaks.

Returns: Tooltip string containing information about the chart point or an axis position selected by the passed coordinates.

boolean DeleteAnnotation	(	String	res_name,
		GlgObject	annotation,
		double	position_x,
		double	position_y
	)

Deletes an annotation from a chart.

Parameters

res_name	The resource path of a child chart to delete the annotation from, or null to delete from this chart object.
annotation	The annotation object to delete, or null to delete an annotation with the specified position_x and position_y parameters.
position_x	The x position of the annotation to delete when the annotation parameter is null.

Returns: true if a time line was deleted.

boolean DeleteBottomObject ( )

Extended API: Deletes last object from the container.

boolean DeleteObjectAt ( int index )

Extended API: Deletes the object of the container at the specified position.

Parameters

index Index of the object to delete.

boolean DeletePlot	(	String	res_name,
		GlgObject	plot
	)

Deletes a plot line from a chart.

Parameters

res_name	The resource path of a child chart to delete the plot from, or null to delete from this chart object.
plot	The plot object.

Returns: true on success.

boolean DeleteTags ( GlgTagType tag_type_mask )

Intermediate API: Delete all tags of a requested tag type.

Parameters

tag_type_mask Specifies the tag type(s) to search. Several tag types can be combined by ORing them together.

boolean DeleteThisObject ( Object obj )

Extended API: Deletes the object from the container.

Parameters

obj	Object to delete.

Returns: true if the object was successfully deleted.

boolean DeleteTimeLine	(	String	res_name,
		GlgObject	time_line,
		double	time_stamp
	)

Deletes a time line from a chart.

Parameters

res_name	The resource path of a child chart to delete the time line from, or null to delete from this chart object.
time_line	The time line object to delete, or null to delete a time line with the specified time stamp.
time_stamp	The time stamp of the time line to delete when the time_line parameter is null.

Returns: true if a time line was deleted.

boolean DeleteTopObject ( )

Extended API: Deletes first object from the container.

static boolean EnableAttachmentPoints ( boolean state )

static

Intermediate API: Enables use of attachment points for object layout.

If attachment points are disabled, layout methods do not consider attachment points in the control points layout mode. If attachment points are enabled, both control points and attachment points are used to determine an object's extent.

Parameters

state The new state of the attachment point use mode.

Returns: The previous state of the attachmenmt point use mode.

static boolean EnableTimerXforms ( boolean state )

static

Enables or disables timer transformations.

Parameters

state The new enabled state.

Returns: Previous value of the enabled state.

boolean Equals ( GlgObject object )

Performs equality comparison between the passed object and this object.

Parameters

object GlgObject to compare this object with.

Returns: true if the passed object represents the same internal GLG object as this object.

static void Error	(	GlgErrorType	error_type,
		String	message,
		Object	exception
	)

static

Invokes a currently installed error handler to generate an error message.

Parameters

error_type	Specifies an error type: INTERNAL_ERROR, USER_ERROR, WARNING, INFO or LOGGING.
message	An error message
exception	An optional exception that caused the error. If it is not null, it is used to print additional information by converting the exception to string.

Object ExportStrings	(	String	separator1,
		String	separator2
	)

Exports all strings defined in the (drawing) object.

Parameters

separator1	If not null, the first character of the string defines the first separator character, otherwise the quote character is used as the first separator.
separator2	If not null, the first character of the string defines the second separator character, otherwise the quote character is used as the second separator.

Returns: An object containing a count and data properties on success, or null on error. The count property (integer) contains the number of exported strings, and the data property (string) contains the list of exported strings.

Object ExportTags	(	String	separator1,
		String	separator2
	)

Exports all tags defined in the (drawing) object.

Parameters

separator1	If not null, the first character of the string defines the first separator character, otherwise the quote character is used as the first separator.
separator2	If not null, the first character of the string defines the second separator character, otherwise the quote character is used as the second separator.

Returns: An object containing a count and data properties on success, or null on error. The count property (integer) contains the number of exported tags, and the data property (string) contains the list of exported tags.

boolean FindMatchingObjects	(	GlgObjectMatchType	match_type,
		boolean	find_parents,
		boolean	find_first_match,
		boolean	search_inside,
		boolean	search_drawable_only,
		GlgObjectType	object_type,
		String	object_name,
		String	resource_name,
		GlgObject	object_id,
		function	custom_match
	)

Intermediate API: Finds object's parents or children that match the specified search criteria.

Parameters

match_type	A bitwise mask of constants in the GlgObjectMatchType enum to specify the object matching criteria: OBJECT_TYPE_MATCH, OBJECT_NAME_MATCH, RESOURCE_MATCH, OBJECT_ID_MATCH or CUSTOM_MATCH. All of the criteria in the mask must be true in order for an object to match.
find_parents	True to search parents, false to search children of the object.
find_first_match	If true, stop the search after the first match and return the matching object. If false, returns all matching objects.
search_inside	If false, don't search the object's children or parents if the object itself matches.
search_drawable_only	Search only drawable objects (searching children only). Refer to the description of the IsDrawable method for more information.
object_type	Object type for the object type search.
object_name	Object name for the object name search.
resource_name	Resource name for the resource search.
object_id	Object ID for the object id search.
custom_match	A function that will be invoked for each object to provide custom matching logic. The function should return true if the match was detected, and should have the following type signature: boolean custom_match( GlgObject object ); where: object is the object to act upon.

Returns: An object containing found_object and found_multiple properties if one or more matches were found, or null if there were no matches. For a single match, found_object will contain the matching object and the found_multiple property will be set false. If several matches were found, found_object will contain a group of matching objects, and found_multiple will be set to true.

boolean FitObject	(	GlgCoordType	coord_type,
		GlgCube	box,
		boolean	keep_ratio
	)

Intermediate API: Fits an object to the specified box.

Parameters

coord_type	The coordinate system in which the box is defined. May have the following values: SCREEN_COORD to fit in screen pixels PARENT_COORD to fit in the world coordinates of the object's parent OBJECT_COORD to fit in the world coordinates of the object.
box	New object bounding box.
keep_ratio	If set to true, the same scale factor is used for X, Y and Z scaling.

Returns: false if errors were encountered during the fitting process.

void Flush ( int size )

Extended API: Sets container size to the requested size. If the new size is less than the container size, extra elements are removed. If the new size is larger, it adds elements by making a copy of the last element.

The container may be a group, a viewport, a polygon (as a container of points), a spline or a connector. The function can only be invoked if the container is not set up. If the container is set up (drawn), the function must be surrounded by the SuspendObject and ReleaseObject calls.

Parameters

size New size.

GlgObject GetAction	(	GlgActionType	action_type,
		GlgTriggerType	trigger_type,
		int	button,
		GlgArmedStateType	armed_state,
		GlgDoubleClickStateType	double_click_state,
		String	action,
		String	subaction,
		boolean	enabled_only
	)

Intermediate API: Returns the first found action with the matching parameters attached to the object.

Parameters

action_type	Specifies an action type. If zero, actions of any type will be considered.
trigger_type	Specifies a trigger type. If zero, actions with any trigger type will be considered.
button	Specifies a mouse button. If zero, actions that are activated by any mouse button will be considered.
armed_state	Specifies settings of an action's ProcessArmed attribute, may be ANY_ARMED_STATE, ARMED_ONLY_STATE or UNARMED_ONLY_STATE.
double_click_state	Specifies settings of an action's DoubleClick attribute, may be DOUBLE_CLICK_NONE, DOUBLE_CLICK_ONLY, SINGLE_CLICK_ONLY or SINGLE_AND_DOUBLE_CLICK.
action	Specifies input action string for action objects with INPUT trigger. If null, action objects with any input action string will be considered.
subaction	Specifies input subaction string for action objects with INPUT trigger. If null, action objects with any input subaction string will be considered.
enabled_only	If set to true, only actions enabled by the settings of their Enabled attribute will be considered.

Returns: Matching action object.

GlgObject GetAlarmObject	(	String	alarm_label,
		boolean	single_alarm
	)

Intermediate API: Finds alarms based on their alarm label attribute.

Parameters

alarm_label	Alarm label, may contain '*' and '?' wildcards.
single_alarm	If set to true, the method returns the first found alarm object with the specified alarm label.

Returns: An alarm object if single_tag=true or an array of alarms otherwise.

GlgCube GetBox ( )

Intermediate API, ADVANCED: Returns object's 3D bounding box in screen coordinates.

The box can be used for collision detection. The coordinates of the box are valid only after the object has been drawn.

Returns: Bounding box

GlgMinMax GetChartDataExtent	(	String	res_name,
		boolean	time,
		boolean	visible_only
	)

Returns the extent of data accumulated in the chart in one direction.

Parameters

res_name	The resource path of a child chart or a child's plot to query, or null to query this object.
time	true to query the minimum and maximum timestamps (or X values the X/Y scatter plot), false to query the minimum and maximum Y values.
visible_only	Controls the extent of the query when querying minimum and maximum of Y values. If set to true, the minimum and maximum Y values of the visible data samples will be returned. If set to false, the minimum and maximum of all data samples will be returned.

Returns: GlgMinMax object or null if the chart plot's contain no data.

GlgMinMax GetDataExtent	(	String	res_name,
		boolean	time
	)

Deprecated, use GetChartDataExtent.

GlgDataType GetDataType ( )

Returns a data type of a data or attribute object.

GlgObject GetDrawingMatrix ( )

Intermediate API, ADVANCED: Returns the matrix object of the transformation used to draw the object on the screen.

Returns: Drawing matrix

double GetDResource ( String resource_name )

Returns value of a D (double) resource.

Parameters

resource_name Resource name

Returns: Resource value

double GetDTag ( String tag_source )

Returns value of a D (double) tag.

Parameters

tag_source Tag source

Returns: Tag value

Object GetElement ( int index )

Returns container's element at the specified position.

Parameters

index Position Index

Returns: Container's element or null on failure.

GlgGISRequestObserver GetGISRequestInfo ( String res_name )

Intermediate API: Obtains information about a GIS object's current GIS request being processed.

Parameters

res_name If is not null, specifies the resource path of child GIS object, otherwise this GIS object will be used.

Returns: The request observer of a GIS request in progress, or null if the GIS object has no pending GIS requests.

GlgPoint GetGResource ( String resource_name )

Returns value of a G (geometrical or color) resource.

Parameters

resource_name Resource name

Returns: Resource value

GlgPoint GetGTag ( String tag_source )

Returns value of a G (geometrical or color) tag.

Parameters

tag_source Tag source

Returns: Tag value

int GetIndex ( Object obj )

Intermediate API: Returns the index of the first occurrence of the object in the container.

Parameters

obj	The object to search for.

Returns: Object's index or -1 if the object wasn't found in the container.

GlgObject GetLegendSelection	(	double	x,
		double	y
	)

Intermediate API, ADVANCED: Returns a plot object corresponding to the legend item at the specified screen point.

Parameters

x	The x coordinate.
y	The y coordinate.

Returns: The plot corresponding to the selected legend item of this legend object.

static String GetLibraryVersion ( )

static

Queries GLG JavaScript library version.

Returns: The string in the N.N format that represents the major and minor version of the GLG JavaScript library.

GlgMatrixData GetMatrixData ( GlgMatrixData matrix_data )

Intermediate API, ADVANCED: Returns values of the matrix's coefficients

Parameters

matrix_data GlgMatrixData object to be filled with returned matrix data. If null is passed, a new GlgMatrixData object will be created.

Returns: GlgMatrixData object filled with the matrix data.

static boolean GetModifierState ( GlgModifierType modifier )

static

Returns the current state of a modifier.

Parameters

modifier Specifies the modifier to query.

Returns: The current modifier state.

GlgObject GetNamedObject ( String name )

Intermediate API: Returns container's element with the specified name

Parameters

name	The element's name

Returns: Container's element or null if named element wasn't found.

GlgObject GetNamedPlot	(	String	res_name,
		String	plot_name
	)

Finds a chart's plot by name.

Parameters

res_name	The resource path of a child chart to query, or null to query this chart object.
plot_name	The plot name.

Returns: The plot object.

Object GetNativeComponent	(	String	res_name,
		GlgComponentQueryType	type
	)

Returns the native component of the viewport.

Parameters

res_name	The resource name of the child object, or null to use this object.
type	Specifies the type of the component to return.

Returns: The native component object.

int GetNumParents ( )

Intermediate API, ADVANCED: Returns the number of object's parents.

Used to determine the type of the return value of the GetParent method.

Returns: number object's parents

String GetObjectName ( )

Returns an object's name.

GlgObjectType GetObjectType ( )

Returns an object's type.

GlgObject GetParent ( )

Intermediate API, ADVANCED: Returns object parent(s).

The type of the return value may be determined by using GetNumParents method.

Returns: objects' parent if the object has one parent. If object has more than one parent, returns an array of parents.

GlgObject GetParentViewport ( boolean heavy_weight )

Intermediate API: Returns object's parent viewport.

This method provides a convenient way to get the viewport or the light viewport the object is drawn in.

Parameters

heavy_weight The type of a viewport to return. If set to true, the closest heavy-weight parent viewport will be returned; otherwise the closest parent viewport will be returned, either heavy or light-weight.

Returns: The object's parent viewport of the specified type.

static int GetPendingInstances ( )

static

Returns a number of subdrawing and subwindow objects that are waiting for their templates being loaded.

static int GetPendingTemplates ( )

static

Returns a number of subdrawing and subwindow templates that are in the process of being loaded.

static GlgObject GetReference ( GlgObject object )

static

Creates a GlgObject that may be used outside of a callback method.

Parameters

object GlgObject to reference

Returns: GlgObject that equals to the object parameter and may be used outside of a callback method.

Any object obtained inside a callback without a call to a GLG method that returns an object is not valid outside of a callback. The GetReference method should be used to assign such an object to a variable used outside the callback, as shown in the below example:

var StoredGlgObject = null;

function TraceCallback( viewport, trace_info )
{
// Incorrect: can't assign object received in a callback to a global variable.
StoredGlgObject = viewport;

// Incorrect: can't assign object received in a callback to a global variable.
StoredGlgObject = trace_info.viewport;

// Correct: using GetReference to assign to a global variable.
StoredGlgObject = GLG.GetReference( trace_info.viewport );

// Correct: assigning an object obtained via a GLG call.
StoredGlgObject = trace_info.viewport.GetResourceObject( "FillColor" );
}

Object GetResource ( String resource_name )

Intermediate API: Finds and returns a resource of an arbitrary type.

Parameters

resource_name Resource name

Returns: Resource object.

GlgObject GetResourceObject ( String resource_name )

Intermediate API: Finds and returns a named resource or an attribute of the object.

Parameters

resource_name Resource name

Returns: Resource or attribute object.

static GlgObject GetSelectedPlot ( )

static

Returns a plot corresponding to the last selected legend item, or null if no item was selected.

When the legend is selected by the mouse move or mouse click event, it determines the legend item the mouse points at, and stores the item's plot object.

int GetSize ( )

Returns container's size.

String GetSResource ( String resource_name )

Returns value of an S (string) resource.

Parameters

resource_name Resource name

Returns: Resource value

static String GetStackTraceAsString ( )

static

Returns the current stack trace as a String.

String GetSTag ( String tag_source )

Returns value of an S (string) tag. All tags with the specified tag_source will be set to the supplied value.

Parameters

tag_source Tag source

Returns: Tag value

int GetStringIndex ( String search_string )

Intermediate API: Returns the index of the first occurrence of the string in a string container.

Parameters

search_string The string to search for.

Returns: Object's index or -1 if the object wasn't found in the container.

GlgObject GetTagObject	(	String	search_string,
		boolean	by_name,
		boolean	unique_tags,
		boolean	single_tag,
		GlgTagType	tag_type_mask
	)

Intermediate API: Finds tags based on their TagName or TagSource attributes.

Parameters

search_string	Tag name or source, may contain '*' and '?' wildcards.
by_name	Search type: search for tag name if true, tag source if false.
unique_tags	If set to true, only one tag instance will be returned for each tag name.
single_tag	If set to true, the method returns the first found tag object with the specified name.
tag_type_mask	Specifies the types of tags to return, is formed by ORing the tag type constants.

Returns: A tag object if single_tag=true or an array of tags otherwise.

static boolean GetTouchMode ( )

static

Queries the state of the touch mode.

Returns: true if the touch mode is currently enabled.

boolean GISConvert	(	String	res_name,
		GlgCoordType	coord_type,
		boolean	coord_to_lat_lon,
		GlgPoint	in_point,
		GlgPoint	out_point
	)

Performs coordinate conversion between the GIS to GLG coordinate systems using the current settings of the GIS object.

Parameters

res_name	The resource path of a child GIS object to query, or null to query this GIS object.
coord_type	Coordinate system to use, SCREEN_COORD or OBJECT_COORD. For OBJECT_COORD, the world coordinate system of the GIS object is used.
coord_to_lat_lon	Conversion type: x/y to lon/lat if true, lon/lat to x/y if false.
in_point	Input values (x/y in the selected coordinate system or lon/lat).
out_point	Converted output values (x/y in the selected coordinate system or lon/lat).

Returns: true if coordinate conversion succeeded with no errors.

boolean GISCreateSelection	(	String	res_name,
		String	layers,
		double	x,
		double	y,
		GlmLabelSelectionMode	select_labels,
		function	callback
	)

Queries information about GIS features located at the specified map position.

Parameters

res_name	The resource path of a child GIS object to query or null to query this GIS object.
layers	List of vector layers to query
x	The X coordinate (in screen pixels) in the GIS object's parent viewport
y	The Y coordinate (in screen pixels) in the GIS object's parent viewport
select_labels	Controls text label selection. May have the following values: GIS_LBL_SEL_NONE disables label selection GIS_LBL_SEL_IN_TILE enables selection GIS_LBL_SEL_MAX_PRECISION enables selection with maximum precision
callback	A function to be invoked with the received selection data, with the following type signature: void callback( GlgObject gis_object, double selection_message ) where: gis_object is the GIS object being queried selection_message is a message object containing returned selection data. It which could be null if there was no selection detected for the requested lat/lon. Refer to the GlmGetSelection section of the GLG Map Server Reference Manual for information on the structure of the returned message object.

Returns: true if selection request was successfully posted, in which case the callback function will be invoked when the data are received.

boolean GISGetElevation	(	String	res_name,
		String	layer_name,
		double	lon,
		double	lat,
		function	callback
	)

Queries map server elevation data.

Parameters

res_name	The resource path of a child GIS object to query or null to query this GIS object.
layer_name	Name of the elevation layer to query
lat	The Lat coordinate of the point
lon	The Lon coordinate of the point
callback	A function to be invoked with the received elevation data, with the following type signature: void callback( GlgObject gis_object, double elevation ) where: gis_object is the GIS object being queried elevation is the returned elevation value, which could be null if there is no elevation data for the requested lat/lon location.

Returns: true if elevation request was successfully posted, in which case the callback function will be invoked when the data are received.

static void GlmConvert	(	GlgProjectionType	projection,
		boolean	stretch,
		GlgCoordType	coord_type,
		boolean	coord_to_lat_lon,
		GlgPoint	center,
		GlgPoint	extent,
		double	angle,
		double	min_x,
		double	max_x,
		double	min_y,
		double	max_y,
		GlgPoint	in_point,
		GlgPoint	out_point
	)

static

Low-level interface to the map server; performs GIS coordinate conversion.

Parameters

projection	RECTANGULAR or ORTHOGRAPHIS
stretch	If false, the map extent is adjusted to preserve X/Y ratio (for SCREEN_COORD coordinate type only).
coord_type	Coordinate system to use.
coord_to_lat_lon	Conversion type: x/y to lon/lat if true, lon/lat to x/y if false.
center	Center of the map in lat/lon.
extent	Extent of the map in lat/lon (rectangular projection) or in meters for orthogonal progection.
angle	Angle of the map rotation.
min_x	The extent of the GIS object in the selected coordinate system.
min_y	The extent of the GIS object in the selected coordinate system.
max_x	The extent of the GIS object in the selected coordinate system.
max_y	The extent of the GIS object in the selected coordinate system.
in_point	Input values (x/y in the selected coordinate system or lon/lat).
out_point	Converted output values (x/y in the selected coordinate system or lon/lat).

boolean HasResourceObject ( String resource_name )

Checks for the existence of the resource object.

Parameters

resource_name Resource name

Returns: true on success

boolean HasTag	(	String	tag_name,
		GlgTagType	tag_type_mask
	)

Intermediate API: Checks for an existence of a tag object with the specified tag name and tag type.

Parameters

tag_name	Tag name
tag_type_mask	Specifies the types of tags to search, is formed by ORing the tag type constants.

Returns: true on success

boolean HasTagName ( String tag_name )

Checks for an existence of a data tag object with the given tag name.

Parameters

tag_name Tag name

Returns: true on success

boolean HasTagSource ( String tag_source )

Checks for an existence of a data tag object with the given tag source.

Parameters

tag_source Tag source

Returns: true on success

static boolean IHCallCurrIH ( GlgCallEvent call_event )

static

Intermediate API: Passes the event to the current handler.

Parameters

call_event The event to pass.

Returns: true if the handler was uninstalled as a result of processing the event, false otherwise.

static boolean IHCallCurrIHWithModifToken	(	GlgCallEvent	call_event,
		int	token
	)

static

Intermediate API: Same as IHCallCurrIHWithToken, but it reuses the existing event by setting its token instead of creating a new call event to pass the token to the handler.

Parameters

call_event	The event to use.
token	The token to pass.

Returns: true if the handler was uninstalled as a result of processing the token, false otherwise.

static boolean IHCallCurrIHWithToken ( int token )

static

Intermediate API: Passes the token to the current handler.

The method creates a call event object used to pass the token to the handler, and destroys the event object when done.

Parameters

token The token to pass.

Returns: true if the handler was uninstalled as a result of processing the token, false otherwise.

static void IHCallPrevIHWithModifToken	(	GlgCallEvent	call_event,
		int	token
	)

static

Intermediate API: Same as IHCallPrevIHWithToken, but reuses the event object for efficiency, the same way as IHCallCurrIHWithModifToken.

Parameters

call_event	The event to use.
token	The token to pass.

static void IHCallPrevIHWithToken ( int token )

static

Intermediate API: Passes the token to the parent handler of the currently active handler. The parent handler is the handler preceding the current handler on the stack.

Note: when the parent handler is invoked, the current handler is not the parent handler, but the handler that invoked it. Therefore, the parent handler cannot uninstall itself by simply calling IHUninstall.

Parameters

token The token to pass.

static void IHChangeBParameter	(	GlgObject	ih,
		String	name,
		boolean	value
	)

static

Intermediate API: Same as IHSetBParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static void IHChangeDParameter	(	GlgObject	ih,
		String	name,
		double	value
	)

static

Intermediate API: Same as IHSetDParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static void IHChangeIParameter	(	GlgObject	ih,
		String	name,
		int	value
	)

static

Intermediate API: Same as IHSetIParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static void IHChangeNParameter	(	GlgObject	ih,
		String	name,
		Object	value
	)

static

Intermediate API: Same as IHSetNParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static void IHChangeOParameter	(	GlgObject	ih,
		String	name,
		GlgObject	value
	)

static

Intermediate API: Same as IHSetOParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static void IHChangeSParameter	(	GlgObject	ih,
		String	name,
		String	value
	)

static

Intermediate API: Same as IHSetSParameter, except that the named parameter must exist. If the parameter does not exist, a GLG error is generated.

static boolean IHGetBParameter	(	GlgObject	ih,
		String	name
	)

static

Intermediate API: Returns a boolean value stored in a named parameter.

A GLG error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested type.

Parameters

ih	The handler to query the parameter of. IH_CURR can be used to specify the currently active handler, and IH_GLOBAL can be used to query global parameters.
name	Parameter name.

static GlgObject IHGetCurrIH ( )

static

Intermediate API: Returns the ID of the currently active interaction handler.

Returns: ID of the current interaction handler.

static double IHGetDParameter	(	GlgObject	ih,
		String	name
	)

static

Intermediate API: Returns a double value stored in a named parameter.

A GLG error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested type.

Parameters

ih	The handler to query the parameter of. IH_CURR can be used to specify the currently active handler, and IH_GLOBAL can be used to query global parameters.
name	Parameter name.

static GlgIHHandlerInterface IHGetHandlerInterface ( GlgObject ih )

static

Intermediate API: Returns the instance of the handler interface used to implement the handler.

Parameters

ih	The handler to query. IH_CURR can be used as the ih parameter to access the curent handler.

Returns: The handler's interface instance.

static int IHGetIParameter	(	GlgObject	ih,
		String	name
	)

static

Intermediate API: Returns an integer value stored in a named parameter.

A GLG error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested type.

Parameters

ih	The handler to query the parameter of. IH_CURR can be used to specify the currently active handler, and IH_GLOBAL can be used to query global parameters.
name	Parameter name.

static Object IHGetNParameter	(	GlgObject	ih,
		String	name
	)

static

Intermediate API: Returns a native object stored in a named parameter.

A GLG error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested type.

Parameters

ih	The handler to query the parameter of. IH_CURR can be used to specify the currently active handler, and IH_GLOBAL can be used to query global parameters.
name	Parameter name.

static GlgObject IHGetOParameter	(	GlgObject	ih,
		String	name
	)

static

Intermediate API: Returns a GLG object stored in a named parameter.

A GLG error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested type.

Parameters

ih	The handler to query the parameter of. IH_CURR can be used to specify the currently active handler, and IH_GLOBAL can be used to query global parameters.
name	Parameter name.

static boolean IHGetOptBParameter	(	GlgObject	ih,
		String	name,
		boolean	default_value
	)

static

Intermediate API: Same as IHGetBParameter, except that the parameter is optional.