d263192711ad64014af7aa61abe9938aa3f1ebbe
5 Provides HTML Canvas Renderer. This is supported under:
10 - IE 6 (via VML Emulation)
12 It uses DIVs for labels.
16 Copyright 2005,2006 (c) Alastair Tse <alastair^liquidx.net>
17 For use under the BSD license. <http://www.liquidx.net/plotkit>
20 // --------------------------------------------------------------------
21 // Check required components
22 // --------------------------------------------------------------------
25 if ((typeof(PlotKit
.Base
) == 'undefined') ||
26 (typeof(PlotKit
.Layout
) == 'undefined'))
32 throw "PlotKit.Layout depends on MochiKit.{Base,Color,DOM,Format} and PlotKit.{Base,Layout}"
36 // ------------------------------------------------------------------------
37 // Defines the renderer class
38 // ------------------------------------------------------------------------
40 if (typeof(PlotKit
.CanvasRenderer
) == 'undefined') {
41 PlotKit
.CanvasRenderer
= {};
44 PlotKit
.CanvasRenderer
.NAME
= "PlotKit.CanvasRenderer";
45 PlotKit
.CanvasRenderer
.VERSION
= PlotKit
.VERSION
;
47 PlotKit
.CanvasRenderer
.__repr__
= function() {
48 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
51 PlotKit
.CanvasRenderer
.toString
= function() {
52 return this.__repr__();
55 PlotKit
.CanvasRenderer
= function(element
, layout
, options
) {
56 if (arguments
.length
> 0)
57 this.__init__(element
, layout
, options
);
60 PlotKit
.CanvasRenderer
.prototype.__init__
= function(element
, layout
, options
) {
61 var isNil
= MochiKit
.Base
.isUndefinedOrNull
;
62 var Color
= MochiKit
.Color
.Color
;
66 "drawBackground": true,
67 "backgroundColor": Color
.whiteColor(),
68 "padding": {left
: 30, right
: 30, top
: 5, bottom
: 10},
69 "colorScheme": PlotKit
.Base
.palette(PlotKit
.Base
.baseColors()[0]),
70 "strokeColor": Color
.whiteColor(),
71 "strokeColorTransform": "asStrokeColor",
77 "axisLineColor": Color
.blackColor(),
80 "axisLabelColor": Color
.blackColor(),
81 "axisLabelFont": "Arial",
82 "axisLabelFontSize": 9,
87 MochiKit
.Base
.update(this.options
, options
? options
: {});
90 this.element
= MochiKit
.DOM
.getElement(element
);
91 this.container
= this.element
.parentNode
;
93 // Stuff relating to Canvas on IE support
94 this.isIE
= PlotKit
.Base
.excanvasSupported();
96 if (this.isIE
&& !isNil(G_vmlCanvasManager
)) {
99 this.renderDelay
= null;
100 this.clearDelay
= null;
101 this.element
= G_vmlCanvasManager
.initElement(this.element
);
104 this.height
= this.element
.height
;
105 this.width
= this.element
.width
;
107 // --- check whether everything is ok before we return
109 if (isNil(this.element
))
110 throw "CanvasRenderer() - passed canvas is not found";
112 if (!this.isIE
&& !(PlotKit
.CanvasRenderer
.isSupported(this.element
)))
113 throw "CanvasRenderer() - Canvas is not supported.";
115 if (isNil(this.container
) || (this.container
.nodeName
.toLowerCase() != "div"))
116 throw "CanvasRenderer() - <canvas> needs to be enclosed in <div>";
119 this.xlabels
= new Array();
120 this.ylabels
= new Array();
121 this.isFirstRender
= true;
124 x
: this.options
.padding
.left
,
125 y
: this.options
.padding
.top
,
126 w
: this.width
- this.options
.padding
.left
- this.options
.padding
.right
,
127 h
: this.height
- this.options
.padding
.top
- this.options
.padding
.bottom
130 MochiKit
.DOM
.updateNodeAttributes(this.container
,
131 {"style":{ "position": "relative", "width": this.width
+ "px"}});
133 // load event system if we have Signals
134 /* Disabled until we have a proper implementation
136 this.event_isinside = null;
137 if (MochiKit.Signal && this.options.enableEvents) {
138 this._initialiseEvents();
142 // still experimental
147 PlotKit
.CanvasRenderer
.prototype.render
= function() {
149 // VML takes a while to start up, so we just poll every this.IEDelay
151 if (this.renderDelay
) {
152 this.renderDelay
.cancel();
153 this.renderDelay
= null;
155 var context
= this.element
.getContext("2d");
158 this.isFirstRender
= false;
159 if (this.maxTries
-- > 0) {
160 this.renderDelay
= MochiKit
.Async
.wait(this.IEDelay
);
161 this.renderDelay
.addCallback(bind(this.render
, this));
167 if (this.options
.drawBackground
)
168 this._renderBackground();
170 if (this.layout
.style
== "line") {
171 this._renderLineChart();
172 this._renderLineAxis();
176 PlotKit
.CanvasRenderer
.prototype._renderLineChart
= function() {
177 var context
= this.element
.getContext("2d");
178 var colorCount
= this.options
.colorScheme
.length
;
179 var colorScheme
= this.options
.colorScheme
;
180 var setNames
= MochiKit
.Base
.keys(this.layout
.datasets
);
181 var setCount
= setNames
.length
;
182 var bind
= MochiKit
.Base
.bind
;
183 var partial
= MochiKit
.Base
.partial
;
185 for (var i
= 0; i
< setCount
; i
++) {
186 var setName
= setNames
[i
];
187 var color
= colorScheme
[i
%colorCount
];
188 var strokeX
= this.options
.strokeColorTransform
;
190 // setup graphics context
192 context
.fillStyle
= color
.toRGBString();
193 if (this.options
.strokeColor
)
194 context
.strokeStyle
= this.options
.strokeColor
.toRGBString();
195 else if (this.options
.strokeColorTransform
)
196 context
.strokeStyle
= color
[strokeX
]().toRGBString();
198 context
.lineWidth
= this.options
.strokeWidth
;
201 var makePath
= function(ctx
) {
203 ctx
.moveTo(this.area
.x
, this.area
.y
+ this.area
.h
);
204 var addPoint
= function(ctx_
, point
) {
205 if (point
.name
== setName
)
206 ctx_
.lineTo(this.area
.w
* point
.x
+ this.area
.x
,
207 this.area
.h
* point
.y
+ this.area
.y
);
209 MochiKit
.Iter
.forEach(this.layout
.points
, partial(addPoint
, ctx
), this);
210 ctx
.lineTo(this.area
.w
+ this.area
.x
,
211 this.area
.h
+ this.area
.y
);
212 ctx
.lineTo(this.area
.x
, this.area
.y
+ this.area
.h
);
216 if (this.options
.shouldFill
) {
217 bind(makePath
, this)(context
);
220 if (this.options
.shouldStroke
) {
221 bind(makePath
, this)(context
);
230 PlotKit
.CanvasRenderer
.prototype._renderLineAxis
= function() {
235 PlotKit
.CanvasRenderer
.prototype._renderAxis
= function() {
236 if (!this.options
.drawXAxis
&& !this.options
.drawYAxis
)
239 var context
= this.element
.getContext("2d");
241 var labelStyle
= {"style":
242 {"position": "absolute",
243 "fontSize": this.options
.axisLabelFontSize
+ "px",
245 "color": this.options
.axisLabelColor
.toRGBString(),
246 "width": this.options
.axisLabelWidth
+ "px",
253 context
.strokeStyle
= this.options
.axisLineColor
.toRGBString();
254 context
.lineWidth
= this.options
.axisLineWidth
;
257 if (this.options
.drawYAxis
) {
258 if (this.layout
.yticks
) {
259 var drawTick
= function(tick
) {
260 if (typeof(tick
) == "function") return;
262 var y
= this.area
.y
+ tick
[0] * this.area
.h
;
264 context
.moveTo(x
, y
);
265 context
.lineTo(x
- this.options
.axisTickSize
, y
);
269 var label
= DIV(labelStyle
, tick
[1]);
270 label
.style
.top
= (y
- this.options
.axisLabelFontSize
) + "px";
271 label
.style
.left
= (x
- this.options
.padding
.left
- this.options
.axisTickSize
) + "px";
272 label
.style
.textAlign
= "right";
273 label
.style
.width
= (this.options
.padding
.left
- this.options
.axisTickSize
* 2) + "px";
274 MochiKit
.DOM
.appendChildNodes(this.container
, label
);
275 this.ylabels
.push(label
);
278 MochiKit
.Iter
.forEach(this.layout
.yticks
, bind(drawTick
, this));
282 context
.moveTo(this.area
.x
, this.area
.y
);
283 context
.lineTo(this.area
.x
, this.area
.y
+ this.area
.h
);
288 if (this.options
.drawXAxis
) {
289 if (this.layout
.xticks
) {
290 var drawTick
= function(tick
) {
291 if (typeof(dataset
) == "function") return;
293 var x
= this.area
.x
+ tick
[0] * this.area
.w
;
294 var y
= this.area
.y
+ this.area
.h
;
296 context
.moveTo(x
, y
);
297 context
.lineTo(x
, y
+ this.options
.axisTickSize
);
301 var label
= DIV(labelStyle
, tick
[1]);
302 label
.style
.top
= (y
+ this.options
.axisTickSize
) + "px";
303 label
.style
.left
= (x
- this.options
.axisLabelWidth
/2) + "px";
304 label
.style
.textAlign
= "center";
305 label
.style
.width
= this.options
.axisLabelWidth
+ "px";
306 MochiKit
.DOM
.appendChildNodes(this.container
, label
);
307 this.xlabels
.push(label
);
310 MochiKit
.Iter
.forEach(this.layout
.xticks
, bind(drawTick
, this));
314 context
.moveTo(this.area
.x
, this.area
.y
+ this.area
.h
);
315 context
.lineTo(this.area
.x
+ this.area
.w
, this.area
.y
+ this.area
.h
);
324 PlotKit
.CanvasRenderer
.prototype._renderBackground
= function() {
325 var context
= this.element
.getContext("2d");
327 context
.fillStyle
= this.options
.backgroundColor
.toRGBString();
328 context
.fillRect(0, 0, this.width
, this.height
);
332 PlotKit
.CanvasRenderer
.prototype.clear
= function() {
334 // VML takes a while to start up, so we just poll every this.IEDelay
336 if (this.clearDelay
) {
337 this.clearDelay
.cancel();
338 this.clearDelay
= null;
340 var context
= this.element
.getContext("2d");
343 this.isFirstRender
= false;
344 this.clearDelay
= MochiKit
.Async
.wait(this.IEDelay
);
345 this.clearDelay
.addCallback(bind(this.clear
, this));
350 var context
= this.element
.getContext("2d");
351 context
.clearRect(0, 0, this.width
, this.height
);
353 MochiKit
.Iter
.forEach(this.xlabels
, MochiKit
.DOM
.removeElement
);
354 MochiKit
.Iter
.forEach(this.ylabels
, MochiKit
.DOM
.removeElement
);
355 this.xlabels
= new Array();
356 this.ylabels
= new Array();
359 // ----------------------------------------------------------------
360 // Everything below here is experimental and undocumented.
361 // ----------------------------------------------------------------
363 PlotKit
.CanvasRenderer
.prototype._initialiseEvents
= function() {
364 var connect
= MochiKit
.Signal
.connect
;
365 var bind
= MochiKit
.Base
.bind
;
366 //MochiKit.Signal.registerSignals(this, ['onmouseover', 'onclick', 'onmouseout', 'onmousemove']);
367 //connect(this.element, 'onmouseover', bind(this.onmouseover, this));
368 //connect(this.element, 'onmouseout', bind(this.onmouseout, this));
369 //connect(this.element, 'onmousemove', bind(this.onmousemove, this));
370 connect(this.element
, 'onclick', bind(this.onclick
, this));
373 PlotKit
.CanvasRenderer
.prototype._resolveObject
= function(e
) {
374 // does not work in firefox
375 //var x = (e.event().offsetX - this.area.x) / this.area
.w
;
376 //var y = (e.event().offsetY - this.area.y) / this.area
.h
;
378 var x
= (e
.mouse().page
.x
- PlotKit
.Base
.findPosX(this.element
) - this.area
.x
) / this.area
.w
;
379 var y
= (e
.mouse().page
.y
- PlotKit
.Base
.findPosY(this.element
) - this.area
.y
) / this.area
.h
;
383 var isHit
= this.layout
.hitTest(x
, y
);
389 PlotKit
.CanvasRenderer
.prototype._createEventObject
= function(layoutObj
, e
) {
390 if (layoutObj
== null) {
399 PlotKit
.CanvasRenderer
.prototype.onclick
= function(e
) {
400 var layoutObject
= this._resolveObject(e
);
401 var eventObject
= this._createEventObject(layoutObject
, e
);
402 if (eventObject
!= null)
403 MochiKit
.Signal
.signal(this, "onclick", eventObject
);
406 PlotKit
.CanvasRenderer
.prototype.onmouseover
= function(e
) {
407 var layoutObject
= this._resolveObject(e
);
408 var eventObject
= this._createEventObject(layoutObject
, e
);
409 if (eventObject
!= null)
410 signal(this, "onmouseover", eventObject
);
413 PlotKit
.CanvasRenderer
.prototype.onmouseout
= function(e
) {
414 var layoutObject
= this._resolveObject(e
);
415 var eventObject
= this._createEventObject(layoutObject
, e
);
416 if (eventObject
== null)
417 signal(this, "onmouseout", e
);
419 signal(this, "onmouseout", eventObject
);
423 PlotKit
.CanvasRenderer
.prototype.onmousemove
= function(e
) {
424 var layoutObject
= this._resolveObject(e
);
425 var eventObject
= this._createEventObject(layoutObject
, e
);
427 if ((layoutObject
== null) && (this.event_isinside
== null)) {
428 // TODO: should we emit an event anyway?
432 if ((layoutObject
!= null) && (this.event_isinside
== null))
433 signal(this, "onmouseover", eventObject
);
435 if ((layoutObject
== null) && (this.event_isinside
!= null))
436 signal(this, "onmouseout", eventObject
);
438 if ((layoutObject
!= null) && (this.event_isinside
!= null))
439 signal(this, "onmousemove", eventObject
);
441 this.event_isinside
= layoutObject
;
445 PlotKit
.CanvasRenderer
.isSupported
= function(canvasName
) {
448 if (MochiKit
.Base
.isUndefinedOrNull(canvasName
))
449 canvas
= MochiKit
.DOM
.CANVAS({});
451 canvas
= MochiKit
.DOM
.getElement(canvasName
);
452 var context
= canvas
.getContext("2d");
455 var ie
= navigator
.appVersion
.match(/MSIE (\d\.\d)/);
456 var opera
= (navigator
.userAgent
.toLowerCase().indexOf("opera") != -1);
457 if ((!ie
) || (ie
[1] < 6) || (opera
))
464 // Namespace Iniitialisation
467 PlotKit
.Canvas
.CanvasRenderer
= PlotKit
.CanvasRenderer
;
469 PlotKit
.Canvas
.EXPORT
= [
473 PlotKit
.Canvas
.EXPORT_OK
= [
477 PlotKit
.Canvas
.__new__
= function() {
478 var m
= MochiKit
.Base
;
480 m
.nameFunctions(this);
483 ":common": this.EXPORT
,
484 ":all": m
.concat(this.EXPORT
, this.EXPORT_OK
)
488 PlotKit
.Canvas
.__new__();
489 MochiKit
.Base
._exportSymbols(this, PlotKit
.Canvas
);