Skip to content

Commit bd2b0ea

Browse files
committed
Describe update_display_data message
1 parent 7e5bb9c commit bd2b0ea

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/messaging.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,6 +1022,25 @@ When a ``display_id`` is specified for a display, it can be updated later
10221022
with an ``update_display_data`` message. This message has the same format as `display_data`_
10231023
messages and must contain a ```transient`` field with a ``display_id``.
10241024

1025+
.. _update_display_data:
1026+
1027+
Message type: ``update_display_data``::
1028+
1029+
content = {
1030+
1031+
# The data dict contains key/value pairs, where the keys are MIME
1032+
# types and the values are the raw data of the representation in that
1033+
# format.
1034+
'data' : dict,
1035+
1036+
# Any metadata that describes the data
1037+
'metadata' : dict
1038+
1039+
# Any information not to be persisted to a notebook or other environment
1040+
# Intended to live only during a kernel session
1041+
'transient': dict
1042+
}
1043+
10251044
Code inputs
10261045
-----------
10271046

0 commit comments

Comments
 (0)