You are viewing an older version (9.10.0). Go to latest (9.13.0)
{ } Raw JSON

bundles / IPython 9.10.0 / IPython / core / display_functions / publish_display_data

function

IPython.core.display_functions:publish_display_data

source: /IPython/core/display_functions.py :37

Signature

def   publish_display_data ( data metadata = None * transient = None ** kwargs )

Summary

Publish data and metadata to all frontends.

Extended Summary

See the display_data message in the messaging documentation for more details about this message type.

Keys of data and metadata can be any mime-type.

Parameters

data : dict

A dictionary having keys that are valid MIME types (like 'text/plain' or 'image/svg+xml') and values that are the data for that MIME type. The data itself must be a JSON'able data structure. Minimally all data should have the 'text/plain' data, which can be displayed by all frontends. If more than the plain text is given, it is up to the frontend to decide which representation to use.

metadata : dict

A dictionary for metadata related to the data. This can contain arbitrary key, value pairs that frontends can use to interpret the data. mime-type keys matching those in data can be used to specify metadata about particular representations.

transient : dict, keyword-only

A dictionary of transient data, such as display_id.

Aliases

  • IPython.display.publish_display_data