GlgLabelFormatter Interface Reference

Label formatter interface. More...

Detailed Description

Label formatter interface.

A label formatter is used to supply custom labels for chart axes and is installed via SetLabelFormatter.

Public Member Functions
String	GetString (GlgObject axis, GlgLabelType label_type, GlgValueType value_type, double value, long sec, double fractional_sec, Object reserved)
	Label formatting method. More...

Member Function Documentation

GetString()

String GetString	(	GlgObject	axis,
		GlgLabelType	label_type,
		GlgValueType	value_type,
		double	value,
		long	sec,
		double	fractional_sec,
		Object	reserved
	)

Label formatting method.

This method is invoked every time a new label string needs to be generated. It can create and return a label string, or return null to use a default label string.

Parameters

axis	The label's axis object.
label_type	The type of the label: TICK_LABEL_TYPE or SELECTION_LABEL_TYPE.
value_type	The type of the axis' value: NUMERICAL_VALUE or TIME_VALUE.
value	The value corresponding to the label position.
sec	An integer number of seconds since the Epoch corresponding to the label position for TIME_VALUE axes.
fractional_sec	The fractional number of seconds for TIME_VALUE axes.
reserved	Reserved parameter

Returns

A custom label string, or null to use the default label format.