SheetXL - v1.0.2
    Preparing search index...

    Interface ISnapshot<D, S, C, J, R>

    Represents an immutable reference to an Record, capturing its content and metadata.

    interface ISnapshot<D = any, S = any, C = any, J = any, R = C> {
        isISnapshot: true;
        copyTo(destination: D, options?: CopyToOptions): R;
        getCoords?(): Readonly<C>;
        getMarkOptions(): CopyOptions;
        getName?(): string;
        getSource(): S;
        prepare?(destination: D, options?: CopyToOptions): void | Promise<void>;
        toHtml?(): string | Promise<string>;
        toImage?(): Blob | Promise<Blob>;
        toJSON?(): J | Promise<J>;
        toText?(): string | Promise<string>;
    }

    Type Parameters

    • D = any

      The type of the destination for copyTo.

    • S = any

      The type of the source for getSource``. @template C The type of the coordinates the snapshot is bound to. @template J The type of the JSON for toJSON. @template R What copyTo` resolves with; the coordinates unless the source has more to report.

    • C = any
    • J = any
    • R = C

    Hierarchy (View Summary)

    Index
    isISnapshot
    copyTo getCoords? getMarkOptions getName? getSource prepare? toHtml? toImage? toJSON? toText?
    isISnapshot: true

    For runtime type checking.

    • Copies the snapshot to the specified range.

      Parameters

      Returns R

      The result of the copy.

      The copy is made inside the destination's transaction, so it completes synchronously; anything that has to wait belongs in prepare.

    • Retrieves the coordinates that bound the current snapshot.

      Returns Readonly<C>

      Different types of snapshots may have different coordinate systems.

    • Return the options used when creating.

      Returns CopyOptions

      This is done so that we can create a copy.

    • A user friendly name of a the snapshot item.

      Returns string

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

      Returns S

    • Does the asynchronous work a copy needs, before copyTo is called.

      Parameters

      Returns void | Promise<void>

      A copy is made inside the destination's transaction, which must not be held open across an await. Anything that has to wait - loading a kind of content, decoding an image - is done here, with the destination the copy will be made to, so that copyTo can complete synchronously. A snapshot with nothing to wait for leaves this out, or returns void.

    • Converts the snapshot to an HTML representation.

      Returns string | Promise<string>

      A string or promise resolving to the HTML representation of the snapshot.

    • Converts the snapshot to an image blob.

      Returns Blob | Promise<Blob>

      A Blob or promise resolving to the image representation of the snapshot.

    • Converts the snapshot to a JSON object.

      Returns J | Promise<J>

      A JSON object or promise resolving to the JSON representation of the snapshot.

    • Converts the snapshot to a plain text representation.

      Returns string | Promise<string>

      A string or promise resolving to the text representation of the snapshot.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods