##// END OF EJS Templates
Make SVGs resizable in the NB
Jonathan Frederic -
Show More
@@ -1,878 +1,912
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 // Clear the output if clear is queued.
275 275 var needs_height_reset = false;
276 276 if (this.clear_queued) {
277 277 this.clear_output(false);
278 278 needs_height_reset = true;
279 279 }
280 280
281 281 // validate output data types
282 282 json = this.validate_output(json);
283 283
284 284 if (json.output_type === 'pyout') {
285 285 this.append_pyout(json);
286 286 } else if (json.output_type === 'pyerr') {
287 287 this.append_pyerr(json);
288 288 } else if (json.output_type === 'display_data') {
289 289 this.append_display_data(json);
290 290 } else if (json.output_type === 'stream') {
291 291 this.append_stream(json);
292 292 }
293 293
294 294 this.outputs.push(json);
295 295
296 296 // Only reset the height to automatic if the height is currently
297 297 // fixed (done by wait=True flag on clear_output).
298 298 if (needs_height_reset) {
299 299 this.element.height('');
300 300 }
301 301
302 302 var that = this;
303 303 setTimeout(function(){that.element.trigger('resize');}, 100);
304 304 };
305 305
306 306
307 307 OutputArea.prototype.create_output_area = function () {
308 308 var oa = $("<div/>").addClass("output_area");
309 309 if (this.prompt_area) {
310 310 oa.append($('<div/>').addClass('prompt'));
311 311 }
312 312 return oa;
313 313 };
314 314
315 315
316 316 function _get_metadata_key(metadata, key, mime) {
317 317 var mime_md = metadata[mime];
318 318 // mime-specific higher priority
319 319 if (mime_md && mime_md[key] !== undefined) {
320 320 return mime_md[key];
321 321 }
322 322 // fallback on global
323 323 return metadata[key];
324 324 }
325 325
326 326 OutputArea.prototype.create_output_subarea = function(md, classes, mime) {
327 327 var subarea = $('<div/>').addClass('output_subarea').addClass(classes);
328 328 if (_get_metadata_key(md, 'isolated', mime)) {
329 329 // Create an iframe to isolate the subarea from the rest of the
330 330 // document
331 331 var iframe = $('<iframe/>').addClass('box-flex1');
332 332 iframe.css({'height':1, 'width':'100%', 'display':'block'});
333 333 iframe.attr('frameborder', 0);
334 334 iframe.attr('scrolling', 'auto');
335 335
336 336 // Once the iframe is loaded, the subarea is dynamically inserted
337 337 iframe.on('load', function() {
338 338 // Workaround needed by Firefox, to properly render svg inside
339 339 // iframes, see http://stackoverflow.com/questions/10177190/
340 340 // svg-dynamically-added-to-iframe-does-not-render-correctly
341 341 this.contentDocument.open();
342 342
343 343 // Insert the subarea into the iframe
344 344 // We must directly write the html. When using Jquery's append
345 345 // method, javascript is evaluated in the parent document and
346 346 // not in the iframe document. At this point, subarea doesn't
347 347 // contain any user content.
348 348 this.contentDocument.write(subarea.html());
349 349
350 350 this.contentDocument.close();
351 351
352 352 var body = this.contentDocument.body;
353 353 // Adjust the iframe height automatically
354 354 iframe.height(body.scrollHeight + 'px');
355 355 });
356 356
357 357 // Elements should be appended to the inner subarea and not to the
358 358 // iframe
359 359 iframe.append = function(that) {
360 360 subarea.append(that);
361 361 };
362 362
363 363 return iframe;
364 364 } else {
365 365 return subarea;
366 366 }
367 367 }
368 368
369 369
370 370 OutputArea.prototype._append_javascript_error = function (err, element) {
371 371 // display a message when a javascript error occurs in display output
372 372 var msg = "Javascript error adding output!"
373 373 if ( element === undefined ) return;
374 374 element
375 375 .append($('<div/>').text(msg).addClass('js-error'))
376 376 .append($('<div/>').text(err.toString()).addClass('js-error'))
377 377 .append($('<div/>').text('See your browser Javascript console for more details.').addClass('js-error'));
378 378 };
379 379
380 380 OutputArea.prototype._safe_append = function (toinsert) {
381 381 // safely append an item to the document
382 382 // this is an object created by user code,
383 383 // and may have errors, which should not be raised
384 384 // under any circumstances.
385 385 try {
386 386 this.element.append(toinsert);
387 387 } catch(err) {
388 388 console.log(err);
389 389 // Create an actual output_area and output_subarea, which creates
390 390 // the prompt area and the proper indentation.
391 391 var toinsert = this.create_output_area();
392 392 var subarea = $('<div/>').addClass('output_subarea');
393 393 toinsert.append(subarea);
394 394 this._append_javascript_error(err, subarea);
395 395 this.element.append(toinsert);
396 396 }
397 397 };
398 398
399 399
400 400 OutputArea.prototype.append_pyout = function (json) {
401 401 var n = json.prompt_number || ' ';
402 402 var toinsert = this.create_output_area();
403 403 if (this.prompt_area) {
404 404 toinsert.find('div.prompt').addClass('output_prompt').text('Out[' + n + ']:');
405 405 }
406 406 var inserted = this.append_mime_type(json, toinsert);
407 407 if (inserted) {
408 408 inserted.addClass('output_pyout');
409 409 }
410 410 this._safe_append(toinsert);
411 411 // If we just output latex, typeset it.
412 412 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
413 413 this.typeset();
414 414 }
415 415 };
416 416
417 417
418 418 OutputArea.prototype.append_pyerr = function (json) {
419 419 var tb = json.traceback;
420 420 if (tb !== undefined && tb.length > 0) {
421 421 var s = '';
422 422 var len = tb.length;
423 423 for (var i=0; i<len; i++) {
424 424 s = s + tb[i] + '\n';
425 425 }
426 426 s = s + '\n';
427 427 var toinsert = this.create_output_area();
428 428 var append_text = OutputArea.append_map['text/plain'];
429 429 if (append_text) {
430 430 append_text.apply(this, [s, {}, toinsert]).addClass('output_pyerr');
431 431 }
432 432 this._safe_append(toinsert);
433 433 }
434 434 };
435 435
436 436
437 437 OutputArea.prototype.append_stream = function (json) {
438 438 // temporary fix: if stream undefined (json file written prior to this patch),
439 439 // default to most likely stdout:
440 440 if (json.stream === undefined){
441 441 json.stream = 'stdout';
442 442 }
443 443 var text = json.text;
444 444 var subclass = "output_"+json.stream;
445 445 if (this.outputs.length > 0){
446 446 // have at least one output to consider
447 447 var last = this.outputs[this.outputs.length-1];
448 448 if (last.output_type == 'stream' && json.stream == last.stream){
449 449 // latest output was in the same stream,
450 450 // so append directly into its pre tag
451 451 // escape ANSI & HTML specials:
452 452 var pre = this.element.find('div.'+subclass).last().find('pre');
453 453 var html = utils.fixCarriageReturn(
454 454 pre.html() + utils.fixConsole(text));
455 455 // The only user content injected with this HTML call is
456 456 // escaped by the fixConsole() method.
457 457 pre.html(html);
458 458 return;
459 459 }
460 460 }
461 461
462 462 if (!text.replace("\r", "")) {
463 463 // text is nothing (empty string, \r, etc.)
464 464 // so don't append any elements, which might add undesirable space
465 465 return;
466 466 }
467 467
468 468 // If we got here, attach a new div
469 469 var toinsert = this.create_output_area();
470 470 var append_text = OutputArea.append_map['text/plain'];
471 471 if (append_text) {
472 472 append_text.apply(this, [text, {}, toinsert]).addClass("output_stream " + subclass);
473 473 }
474 474 this._safe_append(toinsert);
475 475 };
476 476
477 477
478 478 OutputArea.prototype.append_display_data = function (json) {
479 479 var toinsert = this.create_output_area();
480 480 if (this.append_mime_type(json, toinsert)) {
481 481 this._safe_append(toinsert);
482 482 // If we just output latex, typeset it.
483 483 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
484 484 this.typeset();
485 485 }
486 486 }
487 487 };
488 488
489 489
490 490 OutputArea.safe_outputs = {
491 491 'text/plain' : true,
492 492 'text/latex' : true,
493 493 'image/png' : true,
494 494 'image/jpeg' : true
495 495 };
496 496
497 497 OutputArea.prototype.append_mime_type = function (json, element) {
498 498 for (var type_i in OutputArea.display_order) {
499 499 var type = OutputArea.display_order[type_i];
500 500 var append = OutputArea.append_map[type];
501 501 if ((json[type] !== undefined) && append) {
502 502 var value = json[type];
503 503 if (!this.trusted && !OutputArea.safe_outputs[type]) {
504 504 // not trusted, sanitize HTML
505 505 if (type==='text/html' || type==='text/svg') {
506 506 value = IPython.security.sanitize_html(value);
507 507 } else {
508 508 // don't display if we don't know how to sanitize it
509 509 console.log("Ignoring untrusted " + type + " output.");
510 510 continue;
511 511 }
512 512 }
513 513 var md = json.metadata || {};
514 514 var toinsert = append.apply(this, [value, md, element]);
515 515 $([IPython.events]).trigger('output_appended.OutputArea', [type, value, md, toinsert]);
516 516 return toinsert;
517 517 }
518 518 }
519 519 return null;
520 520 };
521 521
522 522
523 523 var append_html = function (html, md, element) {
524 524 var type = 'text/html';
525 525 var toinsert = this.create_output_subarea(md, "output_html rendered_html", type);
526 526 IPython.keyboard_manager.register_events(toinsert);
527 527 toinsert.append(html);
528 528 element.append(toinsert);
529 529 return toinsert;
530 530 };
531 531
532 532
533 533 var append_javascript = function (js, md, element) {
534 534 // We just eval the JS code, element appears in the local scope.
535 535 var type = 'application/javascript';
536 536 var toinsert = this.create_output_subarea(md, "output_javascript", type);
537 537 IPython.keyboard_manager.register_events(toinsert);
538 538 element.append(toinsert);
539 539 // FIXME TODO : remove `container element for 3.0`
540 540 //backward compat, js should be eval'ed in a context where `container` is defined.
541 541 var container = element;
542 542 container.show = function(){console.log('Warning "container.show()" is deprecated.')};
543 543 // end backward compat
544 544
545 545 // Fix for ipython/issues/5293, make sure `element` is the area which
546 546 // output can be inserted into at the time of JS execution.
547 547 element = toinsert;
548 548 try {
549 549 eval(js);
550 550 } catch(err) {
551 551 console.log(err);
552 552 this._append_javascript_error(err, toinsert);
553 553 }
554 554 return toinsert;
555 555 };
556 556
557 557
558 558 var append_text = function (data, md, element) {
559 559 var type = 'text/plain';
560 560 var toinsert = this.create_output_subarea(md, "output_text", type);
561 561 // escape ANSI & HTML specials in plaintext:
562 562 data = utils.fixConsole(data);
563 563 data = utils.fixCarriageReturn(data);
564 564 data = utils.autoLinkUrls(data);
565 565 // The only user content injected with this HTML call is
566 566 // escaped by the fixConsole() method.
567 567 toinsert.append($("<pre/>").html(data));
568 568 element.append(toinsert);
569 569 return toinsert;
570 570 };
571 571
572 572
573 var append_svg = function (svg, md, element) {
573 var append_svg = function (svg_html, md, element) {
574 574 var type = 'image/svg+xml';
575 575 var toinsert = this.create_output_subarea(md, "output_svg", type);
576 toinsert.append(svg);
576
577 // Get the svg element from within the HTML.
578 var svg = $('<div />').html(svg_html).find('svg');
579 var svg_area = $('<div />');
580 var width = svg.attr('width');
581 var height = svg.attr('height');
582 svg
583 .width('100%')
584 .height('100%');
585 svg_area
586 .width(width)
587 .height(height);
588
589 // The jQuery resize handlers don't seem to work on the svg element.
590 // When the svg renders completely, measure it's size and set the parent
591 // div to that size. Then set the svg to 100% the size of the parent
592 // div and make the parent div resizable.
593 this._dblclick_to_reset_size(svg_area, true, false);
594
595 svg_area.append(svg);
596 toinsert.append(svg_area);
577 597 element.append(toinsert);
598
578 599 return toinsert;
579 600 };
580 601
581
582 OutputArea.prototype._dblclick_to_reset_size = function (img) {
583 // wrap image after it's loaded on the page,
584 // otherwise the measured initial size will be incorrect
585 img.on("load", function (){
602 OutputArea.prototype._dblclick_to_reset_size = function (img, immediately, resize_parent) {
603 // Add a resize handler to an element
604 //
605 // img: jQuery element
606 // immediately: bool=False
607 // Wait for the element to load before creating the handle.
608 // resize_parent: bool=True
609 // Should the parent of the element be resized when the element is
610 // reset (by double click).
611 var callback = function (){
586 612 var h0 = img.height();
587 613 var w0 = img.width();
588 614 if (!(h0 && w0)) {
589 615 // zero size, don't make it resizable
590 616 return;
591 617 }
592 618 img.resizable({
593 619 aspectRatio: true,
594 620 autoHide: true
595 621 });
596 622 img.dblclick(function () {
597 623 // resize wrapper & image together for some reason:
598 img.parent().height(h0);
599 624 img.height(h0);
600 img.parent().width(w0);
601 625 img.width(w0);
626 if (resize_parent === undefined || resize_parent) {
627 img.parent().height(h0);
628 img.parent().width(w0);
629 }
602 630 });
603 });
631 };
632
633 if (immediately) {
634 callback();
635 } else {
636 img.on("load", callback);
637 }
604 638 };
605 639
606 640 var set_width_height = function (img, md, mime) {
607 641 // set width and height of an img element from metadata
608 642 var height = _get_metadata_key(md, 'height', mime);
609 643 if (height !== undefined) img.attr('height', height);
610 644 var width = _get_metadata_key(md, 'width', mime);
611 645 if (width !== undefined) img.attr('width', width);
612 646 };
613 647
614 648 var append_png = function (png, md, element) {
615 649 var type = 'image/png';
616 650 var toinsert = this.create_output_subarea(md, "output_png", type);
617 651 var img = $("<img/>").attr('src','data:image/png;base64,'+png);
618 652 set_width_height(img, md, 'image/png');
619 653 this._dblclick_to_reset_size(img);
620 654 toinsert.append(img);
621 655 element.append(toinsert);
622 656 return toinsert;
623 657 };
624 658
625 659
626 660 var append_jpeg = function (jpeg, md, element) {
627 661 var type = 'image/jpeg';
628 662 var toinsert = this.create_output_subarea(md, "output_jpeg", type);
629 663 var img = $("<img/>").attr('src','data:image/jpeg;base64,'+jpeg);
630 664 set_width_height(img, md, 'image/jpeg');
631 665 this._dblclick_to_reset_size(img);
632 666 toinsert.append(img);
633 667 element.append(toinsert);
634 668 return toinsert;
635 669 };
636 670
637 671
638 672 var append_pdf = function (pdf, md, element) {
639 673 var type = 'application/pdf';
640 674 var toinsert = this.create_output_subarea(md, "output_pdf", type);
641 675 var a = $('<a/>').attr('href', 'data:application/pdf;base64,'+pdf);
642 676 a.attr('target', '_blank');
643 677 a.text('View PDF')
644 678 toinsert.append(a);
645 679 element.append(toinsert);
646 680 return toinsert;
647 681 }
648 682
649 683 var append_latex = function (latex, md, element) {
650 684 // This method cannot do the typesetting because the latex first has to
651 685 // be on the page.
652 686 var type = 'text/latex';
653 687 var toinsert = this.create_output_subarea(md, "output_latex", type);
654 688 toinsert.append(latex);
655 689 element.append(toinsert);
656 690 return toinsert;
657 691 };
658 692
659 693
660 694 OutputArea.prototype.append_raw_input = function (msg) {
661 695 var that = this;
662 696 this.expand();
663 697 var content = msg.content;
664 698 var area = this.create_output_area();
665 699
666 700 // disable any other raw_inputs, if they are left around
667 701 $("div.output_subarea.raw_input_container").remove();
668 702
669 703 area.append(
670 704 $("<div/>")
671 705 .addClass("box-flex1 output_subarea raw_input_container")
672 706 .append(
673 707 $("<span/>")
674 708 .addClass("raw_input_prompt")
675 709 .text(content.prompt)
676 710 )
677 711 .append(
678 712 $("<input/>")
679 713 .addClass("raw_input")
680 714 .attr('type', 'text')
681 715 .attr("size", 47)
682 716 .keydown(function (event, ui) {
683 717 // make sure we submit on enter,
684 718 // and don't re-execute the *cell* on shift-enter
685 719 if (event.which === IPython.keyboard.keycodes.enter) {
686 720 that._submit_raw_input();
687 721 return false;
688 722 }
689 723 })
690 724 )
691 725 );
692 726
693 727 this.element.append(area);
694 728 var raw_input = area.find('input.raw_input');
695 729 // Register events that enable/disable the keyboard manager while raw
696 730 // input is focused.
697 731 IPython.keyboard_manager.register_events(raw_input);
698 732 // Note, the following line used to read raw_input.focus().focus().
699 733 // This seemed to be needed otherwise only the cell would be focused.
700 734 // But with the modal UI, this seems to work fine with one call to focus().
701 735 raw_input.focus();
702 736 }
703 737
704 738 OutputArea.prototype._submit_raw_input = function (evt) {
705 739 var container = this.element.find("div.raw_input_container");
706 740 var theprompt = container.find("span.raw_input_prompt");
707 741 var theinput = container.find("input.raw_input");
708 742 var value = theinput.val();
709 743 var content = {
710 744 output_type : 'stream',
711 745 name : 'stdout',
712 746 text : theprompt.text() + value + '\n'
713 747 }
714 748 // remove form container
715 749 container.parent().remove();
716 750 // replace with plaintext version in stdout
717 751 this.append_output(content, false);
718 752 $([IPython.events]).trigger('send_input_reply.Kernel', value);
719 753 }
720 754
721 755
722 756 OutputArea.prototype.handle_clear_output = function (msg) {
723 757 // msg spec v4 had stdout, stderr, display keys
724 758 // v4.1 replaced these with just wait
725 759 // The default behavior is the same (stdout=stderr=display=True, wait=False),
726 760 // so v4 messages will still be properly handled,
727 761 // except for the rarely used clearing less than all output.
728 762 this.clear_output(msg.content.wait || false);
729 763 };
730 764
731 765
732 766 OutputArea.prototype.clear_output = function(wait) {
733 767 if (wait) {
734 768
735 769 // If a clear is queued, clear before adding another to the queue.
736 770 if (this.clear_queued) {
737 771 this.clear_output(false);
738 772 };
739 773
740 774 this.clear_queued = true;
741 775 } else {
742 776
743 777 // Fix the output div's height if the clear_output is waiting for
744 778 // new output (it is being used in an animation).
745 779 if (this.clear_queued) {
746 780 var height = this.element.height();
747 781 this.element.height(height);
748 782 this.clear_queued = false;
749 783 }
750 784
751 785 // clear all, no need for logic
752 786 this.element.html("");
753 787 this.outputs = [];
754 788 this.trusted = true;
755 789 this.unscroll_area();
756 790 return;
757 791 };
758 792 };
759 793
760 794
761 795 // JSON serialization
762 796
763 797 OutputArea.prototype.fromJSON = function (outputs) {
764 798 var len = outputs.length;
765 799 var data;
766 800
767 801 for (var i=0; i<len; i++) {
768 802 data = outputs[i];
769 803 var msg_type = data.output_type;
770 804 if (msg_type === "display_data" || msg_type === "pyout") {
771 805 // convert short keys to mime keys
772 806 // TODO: remove mapping of short keys when we update to nbformat 4
773 807 data = this.rename_keys(data, OutputArea.mime_map_r);
774 808 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map_r);
775 809 }
776 810
777 811 this.append_output(data);
778 812 }
779 813 };
780 814
781 815
782 816 OutputArea.prototype.toJSON = function () {
783 817 var outputs = [];
784 818 var len = this.outputs.length;
785 819 var data;
786 820 for (var i=0; i<len; i++) {
787 821 data = this.outputs[i];
788 822 var msg_type = data.output_type;
789 823 if (msg_type === "display_data" || msg_type === "pyout") {
790 824 // convert mime keys to short keys
791 825 data = this.rename_keys(data, OutputArea.mime_map);
792 826 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map);
793 827 }
794 828 outputs[i] = data;
795 829 }
796 830 return outputs;
797 831 };
798 832
799 833 /**
800 834 * Class properties
801 835 **/
802 836
803 837 /**
804 838 * Threshold to trigger autoscroll when the OutputArea is resized,
805 839 * typically when new outputs are added.
806 840 *
807 841 * Behavior is undefined if autoscroll is lower than minimum_scroll_threshold,
808 842 * unless it is < 0, in which case autoscroll will never be triggered
809 843 *
810 844 * @property auto_scroll_threshold
811 845 * @type Number
812 846 * @default 100
813 847 *
814 848 **/
815 849 OutputArea.auto_scroll_threshold = 100;
816 850
817 851 /**
818 852 * Lower limit (in lines) for OutputArea to be made scrollable. OutputAreas
819 853 * shorter than this are never scrolled.
820 854 *
821 855 * @property minimum_scroll_threshold
822 856 * @type Number
823 857 * @default 20
824 858 *
825 859 **/
826 860 OutputArea.minimum_scroll_threshold = 20;
827 861
828 862
829 863
830 864 OutputArea.mime_map = {
831 865 "text/plain" : "text",
832 866 "text/html" : "html",
833 867 "image/svg+xml" : "svg",
834 868 "image/png" : "png",
835 869 "image/jpeg" : "jpeg",
836 870 "text/latex" : "latex",
837 871 "application/json" : "json",
838 872 "application/javascript" : "javascript",
839 873 };
840 874
841 875 OutputArea.mime_map_r = {
842 876 "text" : "text/plain",
843 877 "html" : "text/html",
844 878 "svg" : "image/svg+xml",
845 879 "png" : "image/png",
846 880 "jpeg" : "image/jpeg",
847 881 "latex" : "text/latex",
848 882 "json" : "application/json",
849 883 "javascript" : "application/javascript",
850 884 };
851 885
852 886 OutputArea.display_order = [
853 887 'application/javascript',
854 888 'text/html',
855 889 'text/latex',
856 890 'image/svg+xml',
857 891 'image/png',
858 892 'image/jpeg',
859 893 'application/pdf',
860 894 'text/plain'
861 895 ];
862 896
863 897 OutputArea.append_map = {
864 898 "text/plain" : append_text,
865 899 "text/html" : append_html,
866 900 "image/svg+xml" : append_svg,
867 901 "image/png" : append_png,
868 902 "image/jpeg" : append_jpeg,
869 903 "text/latex" : append_latex,
870 904 "application/javascript" : append_javascript,
871 905 "application/pdf" : append_pdf
872 906 };
873 907
874 908 IPython.OutputArea = OutputArea;
875 909
876 910 return IPython;
877 911
878 912 }(IPython));
General Comments 0
You need to be logged in to leave comments. Login now