mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-03-13 13:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

allow updating display_data messages in-place using display_id

Browse Source
This commit is contained in:
Min RK 2016-10-21 20:38:48 +02:00
parent 1c930b1b9c
commit 30d3406f54
2 changed files with 70 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
notebook/static/notebook/js/outputarea.js
View File

@ -1,6 +1,6 @@
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
// jshint esnext: true
define([
'base/js/utils',
'base/js/security',
@ -34,6 +34,7 @@ define([
} else {
this.prompt_area = options.prompt_area;
}
this._display_id_targets = {};
this.create_elements();
this.style();
this.bind_events();
@ -236,7 +237,7 @@ define([
console.log("unhandled output message", msg);
return;
}
this.append_output(json);
this.append_output(json, msg);
};
// Declare mime type as constants
@ -286,7 +287,7 @@ define([
return bundle;
};
OutputArea.prototype.append_output = function (json) {
OutputArea.prototype.append_output = function (json, msg) {
this.expand();
// Clear the output if clear is queued.
@ -333,7 +334,8 @@ define([
that.element.trigger('resize');
};
if (json.output_type === 'display_data') {
this.append_display_data(json, handle_appended);
var display_id = msg && msg.content.display_id;
record_output = this.append_display_data(json, handle_appended, display_id);
} else {
handle_appended();
}
@ -419,7 +421,7 @@ define([
.append($('<div/>').text('See your browser Javascript console for more details.').addClass('js-error'));
};
OutputArea.prototype._safe_append = function (toinsert) {
OutputArea.prototype._safe_append = function (toinsert, toreplace) {
/**
* safely append an item to the document
* this is an object created by user code,
@ -427,7 +429,11 @@ define([
* under any circumstances.
*/
try {
this.element.append(toinsert);
if (toreplace) {
toreplace.replaceWith(toinsert);
} else {
this.element.append(toinsert);
}
} catch(err) {
console.log(err);
// Create an actual output_area and output_subarea, which creates
@ -564,10 +570,30 @@ define([
};
OutputArea.prototype.append_display_data = function (json, handle_inserted) {
OutputArea.prototype.append_display_data = function (json, handle_inserted, display_id) {
var toinsert = this.create_output_area();
var record = true;
var target;
if (display_id) {
// it has a display_id;
target = this._display_id_targets[display_id];
if (target) {
// we've seen it before, update output data
this.outputs[target.index] = json;
record = false;
} else {
// not seen before, create and record new output area
target = this._display_id_targets[display_id] = {
index: this.outputs.length,
element: null
};
}
}
if (this.append_mime_type(json, toinsert, handle_inserted)) {
this._safe_append(toinsert);
this._safe_append(toinsert, target && target.element);
if (target) {
target.element = toinsert;
}
// If we just output latex, typeset it.
if ((json.data[MIME_LATEX] !== undefined) ||
(json.data[MIME_HTML] !== undefined) ||
@ -575,6 +601,7 @@ define([
this.typeset();
}
}
return record;
};
@ -859,7 +886,7 @@ define([
// remove form container
container.parent().remove();
// replace with plaintext version in stdout
this.append_output(content, false);
this.append_output(content);
this.events.trigger('send_input_reply.Kernel', value);
};
@ -905,6 +932,7 @@ define([
this.element.trigger('changed');
this.outputs = [];
this._display_id_targets = {};
this.trusted = true;
this.unscroll_area();
return;

35
notebook/static/services/kernels/kernel.js
View File

@ -41,6 +41,7 @@ define([
this.username = "username";
this.session_id = utils.uuid();
this._msg_callbacks = {};
this._display_id_targets = {};
this._msg_queue = Promise.resolve();
this.info_reply = {}; // kernel_info_reply stored here after starting
@ -631,7 +632,7 @@ define([
} else {
this._pending_messages.push(msg);
}
}
};
Kernel.prototype.send_shell_message = function (msg_type, content, callbacks, metadata, buffers) {
/**
@ -854,6 +855,14 @@ define([
*/
Kernel.prototype.clear_callbacks_for_msg = function (msg_id) {
if (this._msg_callbacks[msg_id] !== undefined ) {
var callbacks = this._msg_callbacks[msg_id];
var kernel = this;
// clear display_id:msg_id map for display_ids associated with this msg_id
callbacks.display_ids.map(function (display_id) {
if (kernel._display_id_targets[display_id]) {
delete kernel._display_id_targets[display_id];
}
});
delete this._msg_callbacks[msg_id];
}
};
@ -904,6 +913,7 @@ define([
cbcopy.clear_on_done = callbacks.clear_on_done;
cbcopy.shell_done = (!callbacks.shell);
cbcopy.iopub_done = (!callbacks.iopub);
cbcopy.display_ids = [];
if (callbacks.clear_on_done === undefined) {
// default to clear-on-done
cbcopy.clear_on_done = true;
@ -1053,7 +1063,28 @@ define([
* @function _handle_output_message
*/
Kernel.prototype._handle_output_message = function (msg) {
var callbacks = this.get_callbacks_for_msg(msg.parent_header.msg_id);
var msg_id = msg.parent_header.msg_id;
var callbacks = this.get_callbacks_for_msg(msg_id);
if (msg.header.msg_type === 'display_data') {
// display_data messages may re-route based on their display_id
var display_id = msg.content.display_id;
if (display_id) {
// it has a display_id
var target_msg_id = this._display_id_targets[display_id];
if (target_msg_id) {
// we've seen it before, route to existing destination
callbacks = this.get_callbacks_for_msg(target_msg_id);
} else {
// new display_id, record it for future updating
// in display_id_targets for future lookup
this._display_id_targets[display_id] = msg_id;
// and in callbacks for cleanup on clear_callbacks_for_msg
callbacks.display_ids.push(display_id);
}
}
}
if (!callbacks || !callbacks.iopub) {
// The message came from another client. Let the UI decide what to
// do with it.