Interface IOutputModel

The interface for an output model.

interface IOutputModel {
    changed: ISignal<IOutputModel, void>;
    data: ReadonlyPartialJSONObject;
    executionCount: ExecutionCount;
    metadata: ReadonlyPartialJSONObject;
    streamText?: IObservableString;
    trusted: boolean;
    type: string;
    dispose(): void;
    setData(options: IRenderMime.IMimeModel.ISetDataOptions): void;
    toJSON(): IOutput;
}

Hierarchy (View Summary)

IRenderMime.IMimeModel
- IOutputModel
  - ILogOutputModel

Implemented by

OutputModel

Index

Properties

changed data executionCount metadata streamText? trusted type

Methods

dispose setData toJSON

Properties

`Readonly`changed

changed: ISignal<IOutputModel, void>

A signal emitted when the output model changes.

`Readonly`data

data: ReadonlyPartialJSONObject

The data associated with the model.

`Readonly`executionCount

executionCount: ExecutionCount

The execution count of the model.

`Readonly`metadata

metadata: ReadonlyPartialJSONObject

The metadata associated with the model.

Among others, it can include an attribute named fragment that stores a URI fragment identifier for the MIME resource.

`Optional` `Readonly`streamText

streamText?: IObservableString

The observable text, present when the output type is set to "stream".

trusted

trusted: boolean

Whether the output is trusted.

`Readonly`type

type: string

The output type.

Methods

dispose

dispose(): void
Dispose of the resources used by the output model.

Returns void
- Defined in packages/rendermime/src/outputmodel.ts:56

setData

setData(options: IRenderMime.IMimeModel.ISetDataOptions): void
Set the data associated with the model.

Notes
Calling this function may trigger an asynchronous operation that could cause the renderer to be rendered with a new model containing the new data.
Parameters
- options: IRenderMime.IMimeModel.ISetDataOptions
Returns void
Inherited from IMimeModel.setData
- Defined in packages/rendermime-interfaces/lib/index.d.ts:38

toJSON

toJSON(): IOutput
Serialize the model to JSON.

Returns IOutput
- Defined in packages/rendermime/src/outputmodel.ts:61

Interface IOutputModel

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

`Readonly`changed

`Readonly`data

`Readonly`executionCount

`Readonly`metadata

`Optional` `Readonly`streamText

trusted

`Readonly`type

Methods

dispose

Returns void

setData

Notes

Parameters

Returns void

toJSON

Returns IOutput

Settings

On This Page

Interface IOutputModel

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlychanged

Readonlydata

ReadonlyexecutionCount

Readonlymetadata

Optional ReadonlystreamText

trusted

Readonlytype

Methods

dispose

Returns void

setData

Notes

Parameters

Returns void

toJSON

Returns IOutput

Settings

On This Page

`Readonly`changed

`Readonly`data

`Readonly`executionCount

`Readonly`metadata

`Optional` `Readonly`streamText

`Readonly`type