Interface ISnapshot

ReadonlyisISnapshot

copyTo

• copyTo(
      destination: IConditionalFormat.SnapshotDestination,
      options?: CopyToOptions,
  ): Coords | Promise<Coords>

  Copies the snapshot to the specified range.

  Parameters

  • destination: IConditionalFormat.SnapshotDestination

    The destination Snapshot source where the snapshot will be copied.

  • Optionaloptions: CopyToOptions

    IHistory.CopyToOptions

  Returns Coords | Promise<Coords>

  A promise that resolves when the copy is complete, or void if no asynchronous operation is required.

OptionalgetCoords

• getCoords?(): Readonly<C>

  Retrieves the coordinates that bound the current snapshot.

  Returns Readonly<C>

  Remarks

  Different types of snapshots may have different coordinate systems.

getMarkOptions

• getMarkOptions(): CopyOptions

  Return the options used when creating.

  Returns 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(): IConditionalFormat

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

  Returns IConditionalFormat

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?(): any

  Converts the snapshot to a JSON object.

  Returns any

  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.