Interface IDisplayDataMsg

A 'display_data' message on the 'iopub' channel.

See Display data.

interface IDisplayDataMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "iopub";
    content: {
        data: IMimeBundle;
        metadata: PartialJSONObject;
        transient?: {
            display_id?: string;
        };
    };
    header: IHeader<"display_data">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;
}

Hierarchy (view full)

Properties

buffers? channel content header metadata parent_header

Properties

Optional buffers

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel

channel: "iopub"

The channel on which the message is transmitted.

content

content: {
    data: IMimeBundle;
    metadata: PartialJSONObject;
    transient?: {
        display_id?: string;
    };
}

The content of the message.

Type declaration

  • data: IMimeBundle
  • metadata: PartialJSONObject
  • Optional transient?: {
        display_id?: string;
    }
    • Optional display_id?: string

header

header: IHeader<"display_data">

The message header.

metadata

metadata: JSONObject

Metadata associated with the message.

parent_header

parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>

The parent message

Settings

Member Visibility

Theme

On This Page

bufferschannelcontentheadermetadataparent_header