Interface IAttachmentsModel

The model for attachments.

Hierarchy

IDisposable
- IAttachmentsModel

Implemented by

AttachmentsModel

Index

Properties

changed contentFactory isDisposed keys length remove stateChanged

Methods

clear dispose fromJSON get has set toJSON

Properties

`Readonly` changed

changed: ISignal<IAttachmentsModel, IAttachmentsModel.ChangedArgs>

A signal emitted when the model changes.

`Readonly` contentFactory

contentFactory: IAttachmentsModel.IContentFactory

The attachment content factory used by the model.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly` keys

keys: readonly string[]

The keys of the attachments in the model.

`Readonly` length

length: number

The length of the items in the model.

remove

remove: ((key) => void)

Type declaration

- (key): void
- Remove the attachment whose name is the specified key. Note that this is optional only until Jupyterlab 2.0 release.
  Parameters
  - key: string
  Returns void

`Readonly` stateChanged

stateChanged: ISignal<IAttachmentsModel, void>

A signal emitted when the model state changes.

Methods

clear

clear(): void
Clear all of the attachments.

Returns void
- Defined in packages/attachments/lib/model.d.ts:51

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

fromJSON

fromJSON(values): void
Deserialize the model from JSON.

Notes
This will clear any existing data.
Parameters
- values: IAttachments
Returns void
- Defined in packages/attachments/lib/model.d.ts:58

get

get(key): IAttachmentModel
Get an item for the specified key.
Parameters
- key: string
Returns IAttachmentModel
- Defined in packages/attachments/lib/model.d.ts:38

has

has(key): boolean
Whether the specified key is set.
Parameters
- key: string
Returns boolean
- Defined in packages/attachments/lib/model.d.ts:34

set

set(key, attachment): void
Set the value of the specified key.
Parameters
- key: string
- attachment: IMimeBundle
Returns void
- Defined in packages/attachments/lib/model.d.ts:42

toJSON

toJSON(): IAttachments
Serialize the model to JSON.

Returns IAttachments
- Defined in packages/attachments/lib/model.d.ts:62

Generated using TypeDoc