Interface IMimeModel

A model for mime data.

interface IMimeModel {
    data: ReadonlyPartialJSONObject;
    metadata: ReadonlyPartialJSONObject;
    trusted: boolean;
    setData(options: IRenderMime.IMimeModel.ISetDataOptions): void;
}

Hierarchy (View Summary)

IMimeModel
- IAttachmentModel
- IOutputModel

Implemented by

MimeModel

Index

Properties

data metadata trusted

Methods

Properties

`Readonly`data

data: ReadonlyPartialJSONObject

The data associated with 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.

`Readonly`trusted

trusted: boolean

Whether the data in the model is trusted.

Methods

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
- Defined in packages/rendermime-interfaces/lib/index.d.ts:38