Class Picture

Implementation for IPicture.

Hierarchy

AbstractModel<State, IPicture.JSON>
- Picture

Implements

IPicture

Index

Constructors

Accessors

Methods

addListeners beginCommit close delete doBatch getDetails getType getTypeDescription isClosed isDeleted isReadOnly toHtml toImage toJSON

Constructors

constructor

new Picture(options: Picture.ConstructorOptions): Picture
Parameters
- options: Picture.ConstructorOptions
Returns Picture
Overrides AbstractModel<State, IPicture.JSON>.constructor

Accessors

isIModel

get isIModel(): true
For runtime type checking.

Returns true
Implementation of IPicture.isIModel
Inherited from AbstractModel.isIModel

Methods

addListeners

addListeners(
listeners: Callbacks<IModel, EVENTS>,
options?: IListener.Options,
): Remove
{@inheritDoc IListener.ISource.addListeners}
Parameters
- listeners: Callbacks<IModel, EVENTS>
- Optionaloptions: IListener.Options
Returns Remove
Implementation of IPicture.addListeners
Inherited from AbstractModel.addListeners

beginCommit

beginCommit(options?: string | OperationOptions): ITransaction
Batches all 'transactional' changes until they have all be committed or rolled back.
Parameters
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns ITransaction
Remarks
Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.

Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.

Implementation of IPicture.beginCommit
Inherited from AbstractModel.beginCommit

close

close(): void
Close the record and cleans resources. Can't be undone.

Returns void
Implementation of IPicture.close
Inherited from AbstractModel.close

delete

delete(options?: OperationOptions): void
Delete the item.
Parameters
- Optionaloptions: OperationOptions
Returns void
Remarks
Not all objects can be deleted.

Implementation of IPicture.delete
Inherited from AbstractModel.delete

doBatch

doBatch<R>(
callback: (commit: ICommit) => R | Promise<R>,
options?: string | OperationOptions,
): R | Promise<R>
Provides a mechanism to perform a set of operations in a batch.
Type Parameters
- R
Parameters
- callback: (commit: ICommit) => R | Promise<R>
  A callback that performs multiple operations all within the same transaction.
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns R | Promise<R>
Implementation of IPicture.doBatch
Inherited from AbstractModel.doBatch

getDetails

getDetails(): Promise<Details>
Returns a local object URL for placing in an image tag.

Returns Promise<Details>
Implementation of IPicture.getDetails

getType

getType(): string
Returns an immutable type string.

Returns string
Implementation of IPicture.getType
Overrides AbstractModel.getType

getTypeDescription

getTypeDescription(): string
Returns string

isClosed

isClosed(): boolean
Returns true if no more operations are allowed.

Returns boolean
Implementation of IPicture.isClosed
Inherited from AbstractModel.isClosed

isDeleted

isDeleted(): boolean
If the model unable to be modified.

Returns boolean
Implementation of IPicture.isDeleted
Inherited from AbstractModel.isDeleted

isReadOnly

isReadOnly(): boolean
If the model unable to be modified.

Returns boolean
Implementation of IPicture.isReadOnly
Inherited from AbstractModel.isReadOnly

toHtml

toHtml(): string | Promise<string>
Return an html string.

Returns string | Promise<string>
Implementation of IPicture.toHtml

toImage

toImage(): Promise<Blob>
Returns an image blob.

Returns Promise<Blob>
Implementation of IPicture.toImage

toJSON

toJSON(toResourceId?: (resource: IResource) => number): JSON
Parameters
- OptionaltoResourceId: (resource: IResource) => number
Returns JSON
Implementation of IPicture.toJSON