Interface ISnapshot<T, J>

ReadonlyisISnapshot

copyTo

• copyTo(destination: ICellRange, options?: ICellRange.CopyOptions): Coords | null

  Copies the snapshot to the specified range.

  Parameters

  • destination: ICellRange

    The destination ICellRange where the snapshot will be copied.

  • Optionaloptions: ICellRange.CopyOptions

  Returns Coords | null

  The coordinates the copy covered, or null when it placed no cells.

  Remarks

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

OptionalgetCoords

• getCoords?(): Readonly<IRange.Coords>

  Retrieves the coordinates that bound the current snapshot.

  Returns Readonly<IRange.Coords>

  The IRange.Coords defining the bounds of the snapshot.

getMarkOptions

• getMarkOptions(): ICellRange.CopyOptions

  Return the options used when creating.

  Returns ICellRange.CopyOptions

  Remarks

  This is done so that we can create a copy.

OptionalgetName

• 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

Optionalprepare

• prepare?(
      destination: ICellRange,
      options?: ICellRange.CopyOptions,
  ): void | Promise<void>

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

  Parameters

  • destination: ICellRange

    The ICellRange the snapshot will be copied to, as the caller gave it.

  • Optionaloptions: ICellRange.CopyOptions

  Returns void | Promise<void>

  Remarks

  ICellRange.copyFrom calls this first, outside any transaction, and then copyTo inside the paste's transaction. Anything that has to wait - loading a kind of content, decoding an image - is done here, so that copyTo can complete synchronously. A snapshot with nothing to wait for leaves this out, or returns void; the paste then runs to its commit in the caller's synchronous extent.

OptionaltoHtml

• toHtml?(): string | Promise<string>

  Converts the snapshot to an HTML representation.

  Returns string | Promise<string>

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

OptionaltoImage

• toImage?(): Blob | Promise<Blob>

  Converts the snapshot to an image blob.

  Returns Blob | Promise<Blob>

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

OptionaltoJSON

• toJSON?(): J | Promise<J>

  Converts the snapshot to a JSON object.

  Returns J | Promise<J>

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

OptionaltoText

• toText?(): string | Promise<string>

  Converts the snapshot to a plain text representation.

  Returns string | Promise<string>

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