YUI Library Examples: Charts Control: Apply scope to label functions

Create Custom Graph Class

We will start by creating a custom class to contain all the necessary elements required to render a chart.


1	var CustomGraph = function()
2	{
3	this.text = "*************************************";
4	this.chart;
5	this.dataTipFunction = CustomGraph.prototype.dataTipFunction;
6	this.monthlyExpenses =
7	[
8	{ month: "January", car: 265.35, power:60.00, cable:101.45, entertainment:304.33},
9	{ month: "February", car: 265.35, power:65.00, cable:123.87, entertainment:255.65},
10	{ month: "March", car: 265.35, power:75.34, cable:101.45, entertainment:284.85},
11	{ month: "April", car: 265.35, power:88.45, cable:115.64, entertainment:245.90},
12	{ month: "May", car: 265.35, power:98.47, cable:101.45, entertainment:265.34},
13	{ month: "June", car: 265.35, power:101.35, cable:108.64, entertainment:301.23}
14	];
15	this.styleDefinition =
16	{
17	font:{color:0x663333},
18	background:{color:0xDCAD70},
19	border:{color:0x663333, size:2},
20	xAxis:{color:0x663333},
21	yAxis:{color:0x663333, minorTicks:{display:"none"}, majorTicks:{display:"none"}, majorGridLines:{color:0x663333}}
22
23	}
24	}
25
26	CustomGraph.prototype.getDataSource = function()
27	{
28	var myDataSource = new YAHOO.util.DataSource( this.monthlyExpenses );
29	myDataSource.responseType = YAHOO.util.DataSource.TYPE_JSARRAY;
30	myDataSource.responseSchema =
31	{
32	fields: [ "month", "car", "power", "entertainment", "cable" ]
33	};
34	return myDataSource;
35	}
	view plain \| print \| ?

Our class contains a reference to a dataTip function, data, chart, styles and some custom text to be used in our data tips.

Add Tips Formatting Methods

We will now add all the methods necessary for formatting axis labels and data tips. It is important to note that the dataTip and axis label methods make use of other class level methods, so the ability to add socpe to these methods will prove useful.


1	CustomGraph.prototype.formatCurrencyAxisLabel = function( value )
2	{
3	return this.numberToCurrency(value);
4	}
5
6	CustomGraph.prototype.numberToCurrency = function(value)
7	{
8	return YAHOO.util.Number.format( value,
9	{
10	prefix: "$",
11	thousandsSeparator: ",",
12	decimalPlaces: 2
13	});
14	}
15
16	CustomGraph.prototype.fixedExpensesDataTipFunction = function(item, index, series)
17	{
18	var toolTipText = this.text;
19	toolTipText += "\n" + series.displayName + " payment for " + item.month;
20	toolTipText += "\n" + this.formatCurrencyAxisLabel( item[series.yField] );
21	toolTipText += "\n" + this.text;
22	return toolTipText;
23	}
24
25	CustomGraph.prototype.dataTipFunction = function( item, index, series )
26	{
27	var expense = series.yField;
28	var num = item[expense];
29	return this.getDataTipText(expense, item.month, num);
30	}
31
32	CustomGraph.prototype.getDataTipText = function(expense, month, amount)
33	{
34	var toolTipText = this.text;
35	toolTipText += "\nYour " + month + " " + expense;
36	var limit;
37	switch(expense)
38	{
39	case "entertainment" :
40	toolTipText += " expenses are";
41	toolTipText += amount <= 300 ? "\n in an acceptable range: \n" : "\n too high. \nGo out less:\n";
42	break;
43	case "cable" :
44	toolTipText += " bill is";
45	toolTipText += amount <= 110 ? "\n in an acceptable range: \n" : "\n too high. \nOrder less movies:\n";
46	break;
47	case "power" :
48	toolTipText += " bill is";
49	toolTipText += amount <= 80 ? "\n in an acceptable range: \n" : "\n too high. \nTurn down your AC:\n";
50	break;
51
52	}
53	toolTipText += this.formatCurrencyAxisLabel(amount);
54	toolTipText += "\n" + this.text;
55
56	return toolTipText;
57	}
	view plain \| print \| ?

CustomGraph.prototype.formatCurrencyAxisLabel = function( value )
	{
		return this.numberToCurrency(value);
	}

CustomGraph.prototype.numberToCurrency = function(value)
	{
		return YAHOO.util.Number.format( value,
		{
			prefix: "$",
			thousandsSeparator: ",",
			decimalPlaces: 2
		});	
	}

CustomGraph.prototype.fixedExpensesDataTipFunction = function(item, index, series)
	{
		var toolTipText = this.text;
		toolTipText += "\n" + series.displayName + " payment for " + item.month;
		toolTipText += "\n" + this.formatCurrencyAxisLabel( item[series.yField] );
		toolTipText += "\n" + this.text;
		return toolTipText;	
	}

CustomGraph.prototype.dataTipFunction = function( item, index, series )
	{
		var expense = series.yField;
		var num = item[expense];
		return this.getDataTipText(expense, item.month, num);
	}
	
	CustomGraph.prototype.getDataTipText = function(expense, month, amount)
	{
		var toolTipText = this.text;
		toolTipText += "\nYour " + month + " " + expense;
		var limit;
		switch(expense)
		{
			case "entertainment" :
				toolTipText += " expenses are";
				toolTipText += amount <= 300 ? "\n in an acceptable range: \n" : "\n  too high. \nGo out less:\n";
			break;
			case "cable" :
				toolTipText += " bill is";
				toolTipText += amount <= 110 ? "\n in an acceptable range: \n" : "\n  too high. \nOrder less movies:\n";
			break;
			case "power" :
				toolTipText += " bill is";
				toolTipText += amount <= 80 ? "\n in an acceptable range: \n" : "\n too high. \nTurn down your AC:\n";
			break;
			
		}
		toolTipText += this.formatCurrencyAxisLabel(amount);
		toolTipText += "\n" + this.text;
		
		return toolTipText;
	}

Set Axis and DataTip Functions

Next, we will add methods that return an axis and a series definition. We will also add a method that draws our chart. Each of these methods will create references to text formatting functions to pass to our YUI Chart instance. Our vertical axis method sets the axis label function, our series definition sets a data tip function for our car payment series and our chart method sets the data tip function for all other series.


1	CustomGraph.prototype.getVerticalAxis = function()
2	{
3	var currencyAxis = new YAHOO.widget.NumericAxis();
4	currencyAxis.alwaysShowZero = false;
5	currencyAxis.labelFunction = {func:this.formatCurrencyAxisLabel, scope:this};
6
7	return currencyAxis;
8	}
9
10	CustomGraph.prototype.getSeriesDefs = function()
11	{
12	var seriesDef =
13	[
14	{
15	displayName: "Car",
16	yField: "car",
17	style:{skin:"DiamondSkin", color:0x006600},
18	dataTipFunction:{func:this.fixedExpensesDataTipFunction, scope:this}
19	},
20	{
21	displayName: "power",
22	yField: "power",
23	style:{color:0x8899dd}
24	},
25	{
26	displayName: "Cable",
27	yField: "cable",
28	style:{color:0xee6600}
29	},
30	{
31	displayName: "Entertainment",
32	yField: "entertainment",
33	style:{color:0x6e5000}
34	}
35	];
36
37	return seriesDef;
38	}
39
40	CustomGraph.prototype.drawChart = function(myDiv)
41	{
42	var myAtts = {xField:"month", version:9.28, expressInstall: "assets/expressinstall.swf"};
43	myAtts.dataTipFunction = {func:this.dataTipFunction, scope:this};
44	myAtts.series = this.getSeriesDefs();
45	myAtts.yAxis = this.getVerticalAxis();
46	myAtts.style = this.styleDefinition;
47	this.chart = new YAHOO.widget.LineChart(myDiv, this.getDataSource(), myAtts);
48	}
	view plain \| print \| ?

CustomGraph.prototype.getVerticalAxis = function()
	{
		var currencyAxis = new YAHOO.widget.NumericAxis();
		currencyAxis.alwaysShowZero = false;
		currencyAxis.labelFunction = {func:this.formatCurrencyAxisLabel, scope:this};

return currencyAxis;
	}	
	
	CustomGraph.prototype.getSeriesDefs = function()
	{
		var seriesDef =
		[
			{ 
				displayName: "Car", 
				yField: "car", 
				style:{skin:"DiamondSkin", color:0x006600},
				dataTipFunction:{func:this.fixedExpensesDataTipFunction, scope:this}
			 },
			{ 	
				displayName: "power", 
				yField: "power", 
				style:{color:0x8899dd}
			},
			{
				displayName: "Cable",
				yField: "cable",
				style:{color:0xee6600}
			},
			{
				displayName: "Entertainment",
				yField: "entertainment",
				style:{color:0x6e5000}
			}
		];

return seriesDef;
	}
	
	CustomGraph.prototype.drawChart = function(myDiv)
	{
		var myAtts = {xField:"month", version:9.28, expressInstall: "assets/expressinstall.swf"};
		myAtts.dataTipFunction = {func:this.dataTipFunction, scope:this};
		myAtts.series = this.getSeriesDefs();
		myAtts.yAxis = this.getVerticalAxis();
		myAtts.style = this.styleDefinition;
		this.chart = new YAHOO.widget.LineChart(myDiv, this.getDataSource(), myAtts);
	}

Normally, when setting a formatting function for the chart, a function is passed either directly or as a string reference. When you want to include scope, however, you instead pass an object with two properties, func, a reference to the function, and scope, a reference to the scope. dataTipFunction:{func:myDataTipFunction, scope:this}

Create the Chart

Finally, we'll instantiate our class and draw the chart.


1	var myGraph = new CustomGraph();
2	myGraph.drawChart("chart");
	view plain \| print \| ?

Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

YUI Logger Output:

Note: You are viewing this example in debug mode with logging enabled. This can significantly slow performance.

Reload with logging
and debugging disabled.