Interface ISnapshot<T>

A snapshot of a header to use for laster copying.

interface ISnapshot<T = any> {
    isISnapshot: true;
    copyTo(
        range: ICellHeaderRange,
        options?: ICellHeaderRange.CopyOptions,
    ): RunCoords | Promise<RunCoords>;
    getCoords?(): RunCoords;
    getName?(): string;
    getSource(): T;
    toHtml?(): string | Promise<string>;
    toImage?(): Blob | Promise<Blob>;
    toText?(): string | Promise<string>;
}

Type Parameters

T = any

Index

Properties

Methods

copyTo getCoords? getName? getSource toHtml? toImage? toText?

Properties

`Readonly`isISnapshot

isISnapshot: true

For runtime type checking.

Methods

copyTo

copyTo(
range: ICellHeaderRange,
options?: ICellHeaderRange.CopyOptions,
): RunCoords | Promise<RunCoords>
Called when the item is copied to a new header range.
Parameters
- range: ICellHeaderRange
- Optionaloptions: ICellHeaderRange.CopyOptions
Returns RunCoords | Promise<RunCoords>

`Optional`getCoords

getCoords?(): RunCoords

The RunCoords that bounds the current item.

Returns RunCoords

`Optional`getName

getName?(): string

A user friendly name of a the snapshot item.

Returns string

getSource

getSource(): T

The source that created the snapshot. This is used by copy to quickly do comparisons.

Returns T

`Optional`toHtml

toHtml?(): string | Promise<string>

Allow items to be copied as html.

Returns string | Promise<string>

`Optional`toImage

toImage?(): Blob | Promise<Blob>

Allow items to be copied as an image Blob.

Returns Blob | Promise<Blob>

`Optional`toText

toText?(): string | Promise<string>

Allow items to be copied as text.

Returns string | Promise<string>