Class NotebookCellOutputItem

One representation of a notebook output, defined by MIME type and data.

Implemented by

NotebookCellOutputItem

Index

Constructors

Properties

Methods

error json stderr stdout text

Constructors

constructor

new NotebookCellOutputItem(
data: Uint8Array,
mime: string,
): NotebookCellOutputItem
Create a new notebook cell output item.
Parameters
- data: Uint8Array
  The value of the output item.
- mime: string
  The mime type of the output item.
Returns NotebookCellOutputItem
- Defined in packages/plugin/src/theia.d.ts:16359

Properties

data

data: Uint8Array

The data of this output item. Must always be an array of unsigned 8-bit integers.

mime

mime: string

The mime type which determines how the data-property is interpreted.

Notebooks have built-in support for certain mime-types, extensions can add support for new types and override existing types.

Methods

`Static`error

error(value: Error): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.error mime type.
Parameters
- value: Error
  An error object.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin/src/theia.d.ts:16337

`Static`json

json(value: any, mime?: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem from a JSON object.

Note that this function is not expecting "stringified JSON" but an object that can be stringified. This function will throw an error when the passed value cannot be JSON-stringified.
Parameters
- value: any
  A JSON-stringifyable value.
- Optionalmime: string
  Optional MIME type, defaults to application/json
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin/src/theia.d.ts:16310

`Static`stderr

stderr(value: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.stderr mime type.
Parameters
- value: string
  A string.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin/src/theia.d.ts:16328

`Static`stdout

stdout(value: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.stdout mime type.
Parameters
- value: string
  A string.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin/src/theia.d.ts:16319

`Static`text

text(value: string, mime?: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem from a string.

Note that an UTF-8 encoder is used to create bytes for the string.
Parameters
- value: string
  A string.
- Optionalmime: string
  Optional MIME type, defaults to text/plain.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin/src/theia.d.ts:16296