canvas-editor_fex765/docs/en/guide/command-get.md

Get Data Command

How to Use

import Editor from "@hufe921/canvas-editor"

const instance = new Editor(container, <IElement[]>data, options)
const value = instance.command.commandName()

getValue

Feature: Get the current document value

Usage:

const {
  version: string;
  width: number;
  height: number;
  margins: IMargin;
  header?: IHeader;
  watermark?: IWatermark;
  data: IEditorData;
} = instance.command.getValue(options?: IGetValueOption)

getImage

Feature: Gets the base64 string of the current page image

Usage:

const base64StringList = await instance.command.getImage(pixelRatio?: number)

getWordCount

Feature: Get document word count

Usage:

const wordCount = await instance.command.getWordCount()

getRangeText

Feature: Get selection text

Usage:

const rangeText = instance.command.getRangeText()

getRangeContext

Feature: Get selection context

Usage:

const rangeContext = instance.command.getRangeContext()

getPaperMargin

Feature: Gets the margins

Usage:

const [top: number, right: number, bottom: number, left: number] =
  instance.command.getPaperMargin()

getSearchNavigateInfo

Feature: Get search navigation information

Usage:

const {
  index: number;
  count: number;
} = instance.command.getSearchNavigateInfo()

getCatalog

Feature: Get directory

Usage:

const catalog = await instance.command.getCatalog()

getHTML

Feature: Get HTML

Usage:

const {
  header: string
  main: string
  footer: string
} = await instance.command.getHTML()