Interface IAttachmentModel

The interface for an attachment model.

interface IAttachmentModel {
    changed: ISignal<IAttachmentModel, void>;
    data: ReadonlyPartialJSONObject;
    metadata: ReadonlyPartialJSONObject;
    trusted: boolean;
    dispose(): void;
    setData(options): void;
    toJSON(): IMimeBundle;
}

Hierarchy (view full)

IRenderMime.IMimeModel
- IAttachmentModel

Implemented by

AttachmentModel

Index

Properties

changed data metadata trusted

Methods

dispose setData toJSON

Properties

`Readonly` changed

changed: ISignal<IAttachmentModel, void>

A signal emitted when the attachment model changes.

`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

dispose

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

Returns void
- Defined in packages/rendermime/src/attachmentmodel.ts:31

setData

setData(options): 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(): IMimeBundle
Serialize the model to JSON.

Returns IMimeBundle
- Defined in packages/rendermime/src/attachmentmodel.ts:36