##// END OF EJS Templates
Merge pull request #5523 from jdfreder/i5521...
Min RK -
r16393:c54e9ee8 merge
parent child Browse files
Show More
@@ -1,908 +1,942 b''
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2008 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // OutputArea
10 10 //============================================================================
11 11
12 12 /**
13 13 * @module IPython
14 14 * @namespace IPython
15 15 * @submodule OutputArea
16 16 */
17 17 var IPython = (function (IPython) {
18 18 "use strict";
19 19
20 20 var utils = IPython.utils;
21 21
22 22 /**
23 23 * @class OutputArea
24 24 *
25 25 * @constructor
26 26 */
27 27
28 28 var OutputArea = function (selector, prompt_area) {
29 29 this.selector = selector;
30 30 this.wrapper = $(selector);
31 31 this.outputs = [];
32 32 this.collapsed = false;
33 33 this.scrolled = false;
34 34 this.trusted = true;
35 35 this.clear_queued = null;
36 36 if (prompt_area === undefined) {
37 37 this.prompt_area = true;
38 38 } else {
39 39 this.prompt_area = prompt_area;
40 40 }
41 41 this.create_elements();
42 42 this.style();
43 43 this.bind_events();
44 44 };
45 45
46 46
47 47 /**
48 48 * Class prototypes
49 49 **/
50 50
51 51 OutputArea.prototype.create_elements = function () {
52 52 this.element = $("<div/>");
53 53 this.collapse_button = $("<div/>");
54 54 this.prompt_overlay = $("<div/>");
55 55 this.wrapper.append(this.prompt_overlay);
56 56 this.wrapper.append(this.element);
57 57 this.wrapper.append(this.collapse_button);
58 58 };
59 59
60 60
61 61 OutputArea.prototype.style = function () {
62 62 this.collapse_button.hide();
63 63 this.prompt_overlay.hide();
64 64
65 65 this.wrapper.addClass('output_wrapper');
66 66 this.element.addClass('output');
67 67
68 68 this.collapse_button.addClass("btn output_collapsed");
69 69 this.collapse_button.attr('title', 'click to expand output');
70 70 this.collapse_button.text('. . .');
71 71
72 72 this.prompt_overlay.addClass('out_prompt_overlay prompt');
73 73 this.prompt_overlay.attr('title', 'click to expand output; double click to hide output');
74 74
75 75 this.collapse();
76 76 };
77 77
78 78 /**
79 79 * Should the OutputArea scroll?
80 80 * Returns whether the height (in lines) exceeds a threshold.
81 81 *
82 82 * @private
83 83 * @method _should_scroll
84 84 * @param [lines=100]{Integer}
85 85 * @return {Bool}
86 86 *
87 87 */
88 88 OutputArea.prototype._should_scroll = function (lines) {
89 89 if (lines <=0 ){ return }
90 90 if (!lines) {
91 91 lines = 100;
92 92 }
93 93 // line-height from http://stackoverflow.com/questions/1185151
94 94 var fontSize = this.element.css('font-size');
95 95 var lineHeight = Math.floor(parseInt(fontSize.replace('px','')) * 1.5);
96 96
97 97 return (this.element.height() > lines * lineHeight);
98 98 };
99 99
100 100
101 101 OutputArea.prototype.bind_events = function () {
102 102 var that = this;
103 103 this.prompt_overlay.dblclick(function () { that.toggle_output(); });
104 104 this.prompt_overlay.click(function () { that.toggle_scroll(); });
105 105
106 106 this.element.resize(function () {
107 107 // FIXME: Firefox on Linux misbehaves, so automatic scrolling is disabled
108 108 if ( IPython.utils.browser[0] === "Firefox" ) {
109 109 return;
110 110 }
111 111 // maybe scroll output,
112 112 // if it's grown large enough and hasn't already been scrolled.
113 113 if ( !that.scrolled && that._should_scroll(OutputArea.auto_scroll_threshold)) {
114 114 that.scroll_area();
115 115 }
116 116 });
117 117 this.collapse_button.click(function () {
118 118 that.expand();
119 119 });
120 120 };
121 121
122 122
123 123 OutputArea.prototype.collapse = function () {
124 124 if (!this.collapsed) {
125 125 this.element.hide();
126 126 this.prompt_overlay.hide();
127 127 if (this.element.html()){
128 128 this.collapse_button.show();
129 129 }
130 130 this.collapsed = true;
131 131 }
132 132 };
133 133
134 134
135 135 OutputArea.prototype.expand = function () {
136 136 if (this.collapsed) {
137 137 this.collapse_button.hide();
138 138 this.element.show();
139 139 this.prompt_overlay.show();
140 140 this.collapsed = false;
141 141 }
142 142 };
143 143
144 144
145 145 OutputArea.prototype.toggle_output = function () {
146 146 if (this.collapsed) {
147 147 this.expand();
148 148 } else {
149 149 this.collapse();
150 150 }
151 151 };
152 152
153 153
154 154 OutputArea.prototype.scroll_area = function () {
155 155 this.element.addClass('output_scroll');
156 156 this.prompt_overlay.attr('title', 'click to unscroll output; double click to hide');
157 157 this.scrolled = true;
158 158 };
159 159
160 160
161 161 OutputArea.prototype.unscroll_area = function () {
162 162 this.element.removeClass('output_scroll');
163 163 this.prompt_overlay.attr('title', 'click to scroll output; double click to hide');
164 164 this.scrolled = false;
165 165 };
166 166
167 167 /**
168 168 *
169 169 * Scroll OutputArea if height supperior than a threshold (in lines).
170 170 *
171 171 * Threshold is a maximum number of lines. If unspecified, defaults to
172 172 * OutputArea.minimum_scroll_threshold.
173 173 *
174 174 * Negative threshold will prevent the OutputArea from ever scrolling.
175 175 *
176 176 * @method scroll_if_long
177 177 *
178 178 * @param [lines=20]{Number} Default to 20 if not set,
179 179 * behavior undefined for value of `0`.
180 180 *
181 181 **/
182 182 OutputArea.prototype.scroll_if_long = function (lines) {
183 183 var n = lines | OutputArea.minimum_scroll_threshold;
184 184 if(n <= 0){
185 185 return
186 186 }
187 187
188 188 if (this._should_scroll(n)) {
189 189 // only allow scrolling long-enough output
190 190 this.scroll_area();
191 191 }
192 192 };
193 193
194 194
195 195 OutputArea.prototype.toggle_scroll = function () {
196 196 if (this.scrolled) {
197 197 this.unscroll_area();
198 198 } else {
199 199 // only allow scrolling long-enough output
200 200 this.scroll_if_long();
201 201 }
202 202 };
203 203
204 204
205 205 // typeset with MathJax if MathJax is available
206 206 OutputArea.prototype.typeset = function () {
207 207 if (window.MathJax){
208 208 MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
209 209 }
210 210 };
211 211
212 212
213 213 OutputArea.prototype.handle_output = function (msg) {
214 214 var json = {};
215 215 var msg_type = json.output_type = msg.header.msg_type;
216 216 var content = msg.content;
217 217 if (msg_type === "stream") {
218 218 json.text = content.data;
219 219 json.stream = content.name;
220 220 } else if (msg_type === "display_data") {
221 221 json = content.data;
222 222 json.output_type = msg_type;
223 223 json.metadata = content.metadata;
224 224 } else if (msg_type === "pyout") {
225 225 json = content.data;
226 226 json.output_type = msg_type;
227 227 json.metadata = content.metadata;
228 228 json.prompt_number = content.execution_count;
229 229 } else if (msg_type === "pyerr") {
230 230 json.ename = content.ename;
231 231 json.evalue = content.evalue;
232 232 json.traceback = content.traceback;
233 233 }
234 234 this.append_output(json);
235 235 };
236 236
237 237
238 238 OutputArea.prototype.rename_keys = function (data, key_map) {
239 239 var remapped = {};
240 240 for (var key in data) {
241 241 var new_key = key_map[key] || key;
242 242 remapped[new_key] = data[key];
243 243 }
244 244 return remapped;
245 245 };
246 246
247 247
248 248 OutputArea.output_types = [
249 249 'application/javascript',
250 250 'text/html',
251 251 'text/latex',
252 252 'image/svg+xml',
253 253 'image/png',
254 254 'image/jpeg',
255 255 'application/pdf',
256 256 'text/plain'
257 257 ];
258 258
259 259 OutputArea.prototype.validate_output = function (json) {
260 260 // scrub invalid outputs
261 261 // TODO: right now everything is a string, but JSON really shouldn't be.
262 262 // nbformat 4 will fix that.
263 263 $.map(OutputArea.output_types, function(key){
264 264 if (json[key] !== undefined && typeof json[key] !== 'string') {
265 265 console.log("Invalid type for " + key, json[key]);
266 266 delete json[key];
267 267 }
268 268 });
269 269 return json;
270 270 };
271 271
272 272 OutputArea.prototype.append_output = function (json) {
273 273 this.expand();
274 274
275 275 // validate output data types
276 276 json = this.validate_output(json);
277 277
278 278 // Clear the output if clear is queued.
279 279 var needs_height_reset = false;
280 280 if (this.clear_queued) {
281 281 this.clear_output(false);
282 282 needs_height_reset = true;
283 283 }
284 284
285 285 if (json.output_type === 'pyout') {
286 286 this.append_pyout(json);
287 287 } else if (json.output_type === 'pyerr') {
288 288 this.append_pyerr(json);
289 289 } else if (json.output_type === 'stream') {
290 290 this.append_stream(json);
291 291 }
292 292
293 293 // We must release the animation fixed height in a callback since Gecko
294 294 // (FireFox) doesn't render the image immediately as the data is
295 295 // available.
296 296 var that = this;
297 297 var handle_appended = function ($el) {
298 298 // Only reset the height to automatic if the height is currently
299 299 // fixed (done by wait=True flag on clear_output).
300 300 if (needs_height_reset) {
301 301 that.element.height('');
302 302 }
303 303 that.element.trigger('resize');
304 304 };
305 305 if (json.output_type === 'display_data') {
306 306 this.append_display_data(json, handle_appended);
307 307 } else {
308 308 handle_appended();
309 309 }
310 310
311 311 this.outputs.push(json);
312 312 };
313 313
314 314
315 315 OutputArea.prototype.create_output_area = function () {
316 316 var oa = $("<div/>").addClass("output_area");
317 317 if (this.prompt_area) {
318 318 oa.append($('<div/>').addClass('prompt'));
319 319 }
320 320 return oa;
321 321 };
322 322
323 323
324 324 function _get_metadata_key(metadata, key, mime) {
325 325 var mime_md = metadata[mime];
326 326 // mime-specific higher priority
327 327 if (mime_md && mime_md[key] !== undefined) {
328 328 return mime_md[key];
329 329 }
330 330 // fallback on global
331 331 return metadata[key];
332 332 }
333 333
334 334 OutputArea.prototype.create_output_subarea = function(md, classes, mime) {
335 335 var subarea = $('<div/>').addClass('output_subarea').addClass(classes);
336 336 if (_get_metadata_key(md, 'isolated', mime)) {
337 337 // Create an iframe to isolate the subarea from the rest of the
338 338 // document
339 339 var iframe = $('<iframe/>').addClass('box-flex1');
340 340 iframe.css({'height':1, 'width':'100%', 'display':'block'});
341 341 iframe.attr('frameborder', 0);
342 342 iframe.attr('scrolling', 'auto');
343 343
344 344 // Once the iframe is loaded, the subarea is dynamically inserted
345 345 iframe.on('load', function() {
346 346 // Workaround needed by Firefox, to properly render svg inside
347 347 // iframes, see http://stackoverflow.com/questions/10177190/
348 348 // svg-dynamically-added-to-iframe-does-not-render-correctly
349 349 this.contentDocument.open();
350 350
351 351 // Insert the subarea into the iframe
352 352 // We must directly write the html. When using Jquery's append
353 353 // method, javascript is evaluated in the parent document and
354 354 // not in the iframe document. At this point, subarea doesn't
355 355 // contain any user content.
356 356 this.contentDocument.write(subarea.html());
357 357
358 358 this.contentDocument.close();
359 359
360 360 var body = this.contentDocument.body;
361 361 // Adjust the iframe height automatically
362 362 iframe.height(body.scrollHeight + 'px');
363 363 });
364 364
365 365 // Elements should be appended to the inner subarea and not to the
366 366 // iframe
367 367 iframe.append = function(that) {
368 368 subarea.append(that);
369 369 };
370 370
371 371 return iframe;
372 372 } else {
373 373 return subarea;
374 374 }
375 375 }
376 376
377 377
378 378 OutputArea.prototype._append_javascript_error = function (err, element) {
379 379 // display a message when a javascript error occurs in display output
380 380 var msg = "Javascript error adding output!"
381 381 if ( element === undefined ) return;
382 382 element
383 383 .append($('<div/>').text(msg).addClass('js-error'))
384 384 .append($('<div/>').text(err.toString()).addClass('js-error'))
385 385 .append($('<div/>').text('See your browser Javascript console for more details.').addClass('js-error'));
386 386 };
387 387
388 388 OutputArea.prototype._safe_append = function (toinsert) {
389 389 // safely append an item to the document
390 390 // this is an object created by user code,
391 391 // and may have errors, which should not be raised
392 392 // under any circumstances.
393 393 try {
394 394 this.element.append(toinsert);
395 395 } catch(err) {
396 396 console.log(err);
397 397 // Create an actual output_area and output_subarea, which creates
398 398 // the prompt area and the proper indentation.
399 399 var toinsert = this.create_output_area();
400 400 var subarea = $('<div/>').addClass('output_subarea');
401 401 toinsert.append(subarea);
402 402 this._append_javascript_error(err, subarea);
403 403 this.element.append(toinsert);
404 404 }
405 405 };
406 406
407 407
408 408 OutputArea.prototype.append_pyout = function (json) {
409 409 var n = json.prompt_number || ' ';
410 410 var toinsert = this.create_output_area();
411 411 if (this.prompt_area) {
412 412 toinsert.find('div.prompt').addClass('output_prompt').text('Out[' + n + ']:');
413 413 }
414 414 var inserted = this.append_mime_type(json, toinsert);
415 415 if (inserted) {
416 416 inserted.addClass('output_pyout');
417 417 }
418 418 this._safe_append(toinsert);
419 419 // If we just output latex, typeset it.
420 420 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
421 421 this.typeset();
422 422 }
423 423 };
424 424
425 425
426 426 OutputArea.prototype.append_pyerr = function (json) {
427 427 var tb = json.traceback;
428 428 if (tb !== undefined && tb.length > 0) {
429 429 var s = '';
430 430 var len = tb.length;
431 431 for (var i=0; i<len; i++) {
432 432 s = s + tb[i] + '\n';
433 433 }
434 434 s = s + '\n';
435 435 var toinsert = this.create_output_area();
436 436 var append_text = OutputArea.append_map['text/plain'];
437 437 if (append_text) {
438 438 append_text.apply(this, [s, {}, toinsert]).addClass('output_pyerr');
439 439 }
440 440 this._safe_append(toinsert);
441 441 }
442 442 };
443 443
444 444
445 445 OutputArea.prototype.append_stream = function (json) {
446 446 // temporary fix: if stream undefined (json file written prior to this patch),
447 447 // default to most likely stdout:
448 448 if (json.stream === undefined){
449 449 json.stream = 'stdout';
450 450 }
451 451 var text = json.text;
452 452 var subclass = "output_"+json.stream;
453 453 if (this.outputs.length > 0){
454 454 // have at least one output to consider
455 455 var last = this.outputs[this.outputs.length-1];
456 456 if (last.output_type == 'stream' && json.stream == last.stream){
457 457 // latest output was in the same stream,
458 458 // so append directly into its pre tag
459 459 // escape ANSI & HTML specials:
460 460 var pre = this.element.find('div.'+subclass).last().find('pre');
461 461 var html = utils.fixCarriageReturn(
462 462 pre.html() + utils.fixConsole(text));
463 463 // The only user content injected with this HTML call is
464 464 // escaped by the fixConsole() method.
465 465 pre.html(html);
466 466 return;
467 467 }
468 468 }
469 469
470 470 if (!text.replace("\r", "")) {
471 471 // text is nothing (empty string, \r, etc.)
472 472 // so don't append any elements, which might add undesirable space
473 473 return;
474 474 }
475 475
476 476 // If we got here, attach a new div
477 477 var toinsert = this.create_output_area();
478 478 var append_text = OutputArea.append_map['text/plain'];
479 479 if (append_text) {
480 480 append_text.apply(this, [text, {}, toinsert]).addClass("output_stream " + subclass);
481 481 }
482 482 this._safe_append(toinsert);
483 483 };
484 484
485 485
486 486 OutputArea.prototype.append_display_data = function (json, handle_inserted) {
487 487 var toinsert = this.create_output_area();
488 488 if (this.append_mime_type(json, toinsert, handle_inserted)) {
489 489 this._safe_append(toinsert);
490 490 // If we just output latex, typeset it.
491 491 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
492 492 this.typeset();
493 493 }
494 494 }
495 495 };
496 496
497 497
498 498 OutputArea.safe_outputs = {
499 499 'text/plain' : true,
500 500 'text/latex' : true,
501 501 'image/png' : true,
502 502 'image/jpeg' : true
503 503 };
504 504
505 505 OutputArea.prototype.append_mime_type = function (json, element, handle_inserted) {
506 506 for (var i=0; i < OutputArea.display_order.length; i++) {
507 507 var type = OutputArea.display_order[i];
508 508 var append = OutputArea.append_map[type];
509 509 if ((json[type] !== undefined) && append) {
510 510 var value = json[type];
511 511 if (!this.trusted && !OutputArea.safe_outputs[type]) {
512 512 // not trusted, sanitize HTML
513 513 if (type==='text/html' || type==='text/svg') {
514 514 value = IPython.security.sanitize_html(value);
515 515 } else {
516 516 // don't display if we don't know how to sanitize it
517 517 console.log("Ignoring untrusted " + type + " output.");
518 518 continue;
519 519 }
520 520 }
521 521 var md = json.metadata || {};
522 522 var toinsert = append.apply(this, [value, md, element, handle_inserted]);
523 523 // Since only the png and jpeg mime types call the inserted
524 524 // callback, if the mime type is something other we must call the
525 525 // inserted callback only when the element is actually inserted
526 526 // into the DOM. Use a timeout of 0 to do this.
527 527 if (['image/png', 'image/jpeg'].indexOf(type) < 0 && handle_inserted !== undefined) {
528 528 setTimeout(handle_inserted, 0);
529 529 }
530 530 $([IPython.events]).trigger('output_appended.OutputArea', [type, value, md, toinsert]);
531 531 return toinsert;
532 532 }
533 533 }
534 534 return null;
535 535 };
536 536
537 537
538 538 var append_html = function (html, md, element) {
539 539 var type = 'text/html';
540 540 var toinsert = this.create_output_subarea(md, "output_html rendered_html", type);
541 541 IPython.keyboard_manager.register_events(toinsert);
542 542 toinsert.append(html);
543 543 element.append(toinsert);
544 544 return toinsert;
545 545 };
546 546
547 547
548 548 var append_javascript = function (js, md, element) {
549 549 // We just eval the JS code, element appears in the local scope.
550 550 var type = 'application/javascript';
551 551 var toinsert = this.create_output_subarea(md, "output_javascript", type);
552 552 IPython.keyboard_manager.register_events(toinsert);
553 553 element.append(toinsert);
554 554 // FIXME TODO : remove `container element for 3.0`
555 555 //backward compat, js should be eval'ed in a context where `container` is defined.
556 556 var container = element;
557 557 container.show = function(){console.log('Warning "container.show()" is deprecated.')};
558 558 // end backward compat
559 559
560 560 // Fix for ipython/issues/5293, make sure `element` is the area which
561 561 // output can be inserted into at the time of JS execution.
562 562 element = toinsert;
563 563 try {
564 564 eval(js);
565 565 } catch(err) {
566 566 console.log(err);
567 567 this._append_javascript_error(err, toinsert);
568 568 }
569 569 return toinsert;
570 570 };
571 571
572 572
573 573 var append_text = function (data, md, element) {
574 574 var type = 'text/plain';
575 575 var toinsert = this.create_output_subarea(md, "output_text", type);
576 576 // escape ANSI & HTML specials in plaintext:
577 577 data = utils.fixConsole(data);
578 578 data = utils.fixCarriageReturn(data);
579 579 data = utils.autoLinkUrls(data);
580 580 // The only user content injected with this HTML call is
581 581 // escaped by the fixConsole() method.
582 582 toinsert.append($("<pre/>").html(data));
583 583 element.append(toinsert);
584 584 return toinsert;
585 585 };
586 586
587 587
588 var append_svg = function (svg, md, element) {
588 var append_svg = function (svg_html, md, element) {
589 589 var type = 'image/svg+xml';
590 590 var toinsert = this.create_output_subarea(md, "output_svg", type);
591 toinsert.append(svg);
591
592 // Get the svg element from within the HTML.
593 var svg = $('<div />').html(svg_html).find('svg');
594 var svg_area = $('<div />');
595 var width = svg.attr('width');
596 var height = svg.attr('height');
597 svg
598 .width('100%')
599 .height('100%');
600 svg_area
601 .width(width)
602 .height(height);
603
604 // The jQuery resize handlers don't seem to work on the svg element.
605 // When the svg renders completely, measure it's size and set the parent
606 // div to that size. Then set the svg to 100% the size of the parent
607 // div and make the parent div resizable.
608 this._dblclick_to_reset_size(svg_area, true, false);
609
610 svg_area.append(svg);
611 toinsert.append(svg_area);
592 612 element.append(toinsert);
613
593 614 return toinsert;
594 615 };
595 616
596
597 OutputArea.prototype._dblclick_to_reset_size = function (img) {
598 // wrap image after it's loaded on the page,
599 // otherwise the measured initial size will be incorrect
600 img.on("load", function (){
617 OutputArea.prototype._dblclick_to_reset_size = function (img, immediately, resize_parent) {
618 // Add a resize handler to an element
619 //
620 // img: jQuery element
621 // immediately: bool=False
622 // Wait for the element to load before creating the handle.
623 // resize_parent: bool=True
624 // Should the parent of the element be resized when the element is
625 // reset (by double click).
626 var callback = function (){
601 627 var h0 = img.height();
602 628 var w0 = img.width();
603 629 if (!(h0 && w0)) {
604 630 // zero size, don't make it resizable
605 631 return;
606 632 }
607 633 img.resizable({
608 634 aspectRatio: true,
609 635 autoHide: true
610 636 });
611 637 img.dblclick(function () {
612 638 // resize wrapper & image together for some reason:
613 img.parent().height(h0);
614 639 img.height(h0);
615 img.parent().width(w0);
616 640 img.width(w0);
641 if (resize_parent === undefined || resize_parent) {
642 img.parent().height(h0);
643 img.parent().width(w0);
644 }
617 645 });
618 });
646 };
647
648 if (immediately) {
649 callback();
650 } else {
651 img.on("load", callback);
652 }
619 653 };
620 654
621 655 var set_width_height = function (img, md, mime) {
622 656 // set width and height of an img element from metadata
623 657 var height = _get_metadata_key(md, 'height', mime);
624 658 if (height !== undefined) img.attr('height', height);
625 659 var width = _get_metadata_key(md, 'width', mime);
626 660 if (width !== undefined) img.attr('width', width);
627 661 };
628 662
629 663 var append_png = function (png, md, element, handle_inserted) {
630 664 var type = 'image/png';
631 665 var toinsert = this.create_output_subarea(md, "output_png", type);
632 666 var img = $("<img/>");
633 667 if (handle_inserted !== undefined) {
634 668 img.on('load', function(){
635 669 handle_inserted(img);
636 670 });
637 671 }
638 672 img[0].src = 'data:image/png;base64,'+ png;
639 673 set_width_height(img, md, 'image/png');
640 674 this._dblclick_to_reset_size(img);
641 675 toinsert.append(img);
642 676 element.append(toinsert);
643 677 return toinsert;
644 678 };
645 679
646 680
647 681 var append_jpeg = function (jpeg, md, element, handle_inserted) {
648 682 var type = 'image/jpeg';
649 683 var toinsert = this.create_output_subarea(md, "output_jpeg", type);
650 684 var img = $("<img/>");
651 685 if (handle_inserted !== undefined) {
652 686 img.on('load', function(){
653 687 handle_inserted(img);
654 688 });
655 689 }
656 690 img[0].src = 'data:image/jpeg;base64,'+ jpeg;
657 691 set_width_height(img, md, 'image/jpeg');
658 692 this._dblclick_to_reset_size(img);
659 693 toinsert.append(img);
660 694 element.append(toinsert);
661 695 return toinsert;
662 696 };
663 697
664 698
665 699 var append_pdf = function (pdf, md, element) {
666 700 var type = 'application/pdf';
667 701 var toinsert = this.create_output_subarea(md, "output_pdf", type);
668 702 var a = $('<a/>').attr('href', 'data:application/pdf;base64,'+pdf);
669 703 a.attr('target', '_blank');
670 704 a.text('View PDF')
671 705 toinsert.append(a);
672 706 element.append(toinsert);
673 707 return toinsert;
674 708 }
675 709
676 710 var append_latex = function (latex, md, element) {
677 711 // This method cannot do the typesetting because the latex first has to
678 712 // be on the page.
679 713 var type = 'text/latex';
680 714 var toinsert = this.create_output_subarea(md, "output_latex", type);
681 715 toinsert.append(latex);
682 716 element.append(toinsert);
683 717 return toinsert;
684 718 };
685 719
686 720
687 721 OutputArea.prototype.append_raw_input = function (msg) {
688 722 var that = this;
689 723 this.expand();
690 724 var content = msg.content;
691 725 var area = this.create_output_area();
692 726
693 727 // disable any other raw_inputs, if they are left around
694 728 $("div.output_subarea.raw_input_container").remove();
695 729
696 730 area.append(
697 731 $("<div/>")
698 732 .addClass("box-flex1 output_subarea raw_input_container")
699 733 .append(
700 734 $("<span/>")
701 735 .addClass("raw_input_prompt")
702 736 .text(content.prompt)
703 737 )
704 738 .append(
705 739 $("<input/>")
706 740 .addClass("raw_input")
707 741 .attr('type', 'text')
708 742 .attr("size", 47)
709 743 .keydown(function (event, ui) {
710 744 // make sure we submit on enter,
711 745 // and don't re-execute the *cell* on shift-enter
712 746 if (event.which === IPython.keyboard.keycodes.enter) {
713 747 that._submit_raw_input();
714 748 return false;
715 749 }
716 750 })
717 751 )
718 752 );
719 753
720 754 this.element.append(area);
721 755 var raw_input = area.find('input.raw_input');
722 756 // Register events that enable/disable the keyboard manager while raw
723 757 // input is focused.
724 758 IPython.keyboard_manager.register_events(raw_input);
725 759 // Note, the following line used to read raw_input.focus().focus().
726 760 // This seemed to be needed otherwise only the cell would be focused.
727 761 // But with the modal UI, this seems to work fine with one call to focus().
728 762 raw_input.focus();
729 763 }
730 764
731 765 OutputArea.prototype._submit_raw_input = function (evt) {
732 766 var container = this.element.find("div.raw_input_container");
733 767 var theprompt = container.find("span.raw_input_prompt");
734 768 var theinput = container.find("input.raw_input");
735 769 var value = theinput.val();
736 770 var content = {
737 771 output_type : 'stream',
738 772 name : 'stdout',
739 773 text : theprompt.text() + value + '\n'
740 774 }
741 775 // remove form container
742 776 container.parent().remove();
743 777 // replace with plaintext version in stdout
744 778 this.append_output(content, false);
745 779 $([IPython.events]).trigger('send_input_reply.Kernel', value);
746 780 }
747 781
748 782
749 783 OutputArea.prototype.handle_clear_output = function (msg) {
750 784 // msg spec v4 had stdout, stderr, display keys
751 785 // v4.1 replaced these with just wait
752 786 // The default behavior is the same (stdout=stderr=display=True, wait=False),
753 787 // so v4 messages will still be properly handled,
754 788 // except for the rarely used clearing less than all output.
755 789 this.clear_output(msg.content.wait || false);
756 790 };
757 791
758 792
759 793 OutputArea.prototype.clear_output = function(wait) {
760 794 if (wait) {
761 795
762 796 // If a clear is queued, clear before adding another to the queue.
763 797 if (this.clear_queued) {
764 798 this.clear_output(false);
765 799 };
766 800
767 801 this.clear_queued = true;
768 802 } else {
769 803
770 804 // Fix the output div's height if the clear_output is waiting for
771 805 // new output (it is being used in an animation).
772 806 if (this.clear_queued) {
773 807 var height = this.element.height();
774 808 this.element.height(height);
775 809 this.clear_queued = false;
776 810 }
777 811
778 812 // Clear all
779 813 // Remove load event handlers from img tags because we don't want
780 814 // them to fire if the image is never added to the page.
781 815 this.element.find('img').off('load');
782 816 this.element.html("");
783 817 this.outputs = [];
784 818 this.trusted = true;
785 819 this.unscroll_area();
786 820 return;
787 821 };
788 822 };
789 823
790 824
791 825 // JSON serialization
792 826
793 827 OutputArea.prototype.fromJSON = function (outputs) {
794 828 var len = outputs.length;
795 829 var data;
796 830
797 831 for (var i=0; i<len; i++) {
798 832 data = outputs[i];
799 833 var msg_type = data.output_type;
800 834 if (msg_type === "display_data" || msg_type === "pyout") {
801 835 // convert short keys to mime keys
802 836 // TODO: remove mapping of short keys when we update to nbformat 4
803 837 data = this.rename_keys(data, OutputArea.mime_map_r);
804 838 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map_r);
805 839 }
806 840
807 841 this.append_output(data);
808 842 }
809 843 };
810 844
811 845
812 846 OutputArea.prototype.toJSON = function () {
813 847 var outputs = [];
814 848 var len = this.outputs.length;
815 849 var data;
816 850 for (var i=0; i<len; i++) {
817 851 data = this.outputs[i];
818 852 var msg_type = data.output_type;
819 853 if (msg_type === "display_data" || msg_type === "pyout") {
820 854 // convert mime keys to short keys
821 855 data = this.rename_keys(data, OutputArea.mime_map);
822 856 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map);
823 857 }
824 858 outputs[i] = data;
825 859 }
826 860 return outputs;
827 861 };
828 862
829 863 /**
830 864 * Class properties
831 865 **/
832 866
833 867 /**
834 868 * Threshold to trigger autoscroll when the OutputArea is resized,
835 869 * typically when new outputs are added.
836 870 *
837 871 * Behavior is undefined if autoscroll is lower than minimum_scroll_threshold,
838 872 * unless it is < 0, in which case autoscroll will never be triggered
839 873 *
840 874 * @property auto_scroll_threshold
841 875 * @type Number
842 876 * @default 100
843 877 *
844 878 **/
845 879 OutputArea.auto_scroll_threshold = 100;
846 880
847 881 /**
848 882 * Lower limit (in lines) for OutputArea to be made scrollable. OutputAreas
849 883 * shorter than this are never scrolled.
850 884 *
851 885 * @property minimum_scroll_threshold
852 886 * @type Number
853 887 * @default 20
854 888 *
855 889 **/
856 890 OutputArea.minimum_scroll_threshold = 20;
857 891
858 892
859 893
860 894 OutputArea.mime_map = {
861 895 "text/plain" : "text",
862 896 "text/html" : "html",
863 897 "image/svg+xml" : "svg",
864 898 "image/png" : "png",
865 899 "image/jpeg" : "jpeg",
866 900 "text/latex" : "latex",
867 901 "application/json" : "json",
868 902 "application/javascript" : "javascript",
869 903 };
870 904
871 905 OutputArea.mime_map_r = {
872 906 "text" : "text/plain",
873 907 "html" : "text/html",
874 908 "svg" : "image/svg+xml",
875 909 "png" : "image/png",
876 910 "jpeg" : "image/jpeg",
877 911 "latex" : "text/latex",
878 912 "json" : "application/json",
879 913 "javascript" : "application/javascript",
880 914 };
881 915
882 916 OutputArea.display_order = [
883 917 'application/javascript',
884 918 'text/html',
885 919 'text/latex',
886 920 'image/svg+xml',
887 921 'image/png',
888 922 'image/jpeg',
889 923 'application/pdf',
890 924 'text/plain'
891 925 ];
892 926
893 927 OutputArea.append_map = {
894 928 "text/plain" : append_text,
895 929 "text/html" : append_html,
896 930 "image/svg+xml" : append_svg,
897 931 "image/png" : append_png,
898 932 "image/jpeg" : append_jpeg,
899 933 "text/latex" : append_latex,
900 934 "application/javascript" : append_javascript,
901 935 "application/pdf" : append_pdf
902 936 };
903 937
904 938 IPython.OutputArea = OutputArea;
905 939
906 940 return IPython;
907 941
908 942 }(IPython));
General Comments 0
You need to be logged in to leave comments. Login now