4.3 KiB
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
data: IEditorData
options: IEditorOption
} = instance.command.getValue(options?: IGetValueOption)
getImage
Feature: Gets the base64 string of the current page image
Usage:
const base64StringList = await instance.command.getImage(option?: IGetImageOption)
getOptions
Feature: Get editor options
Usage:
const editorOption = await instance.command.getOptions()
getWordCount
Feature: Get document word count
Usage:
const wordCount = await instance.command.getWordCount()
getCursorPosition
Feature: Get cursor position with coordinates
Usage:
const range = instance.command.getCursorPosition()
getRange
Feature: Get range
Usage:
const range = instance.command.getRange()
getRangeText
Feature: Get range text
Usage:
const rangeText = instance.command.getRangeText()
getRangeContext
Feature: Get range context
Usage:
const rangeContext = instance.command.getRangeContext()
getRangeRow
Feature: Get range row element list
Usage:
const rowElementList = instance.command.getRangeRow()
getKeywordRangeList
Feature: Get range list by keyword
Usage:
const rangeList = instance.command.getKeywordRangeList()
getKeywordContext
Feature: Get context list by keyword
Usage:
const keywordContextList = instance.command.getKeywordContext(payload: string)
getRangeParagraph
Feature: Get range paragraph element list
Usage:
const paragraphElementList = instance.command.getRangeParagraph()
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()
getText
Feature: Get text
Usage:
const {
header: string
main: string
footer: string
} = await instance.command.getText()
getLocale
Feature: Get current locale
Usage:
const locale = await instance.command.getLocale()
getGroupIds
Feature: Get all group ids
Usage:
const groupIds = await instance.command.getGroupIds()
getControlValue
Feature: Get control value
Usage:
const {
value: string | null
innerText: string | null
zone: EditorZone
elementList?: IElement[]
} = await instance.command.getControlValue(payload: IGetControlValueOption)
getControlList
Feature: Get control list
Usage:
const controlList = await instance.command.getControlList()
getContainer
Feature: Get editor container
Usage:
const container = await instance.command.getContainer()
getTitleValue
Feature: Get title value
Usage:
const {
value: string | null
elementList: IElement[]
zone: EditorZone
}[] = await instance.command.getTitleValue(payload: IGetTitleValueOption)
getPositionContextByEvent
Feature: Get position context by mouse event
Usage:
const {
pageNo: number
element: IElement | null
rangeRect: RangeRect | null
}[] = await instance.command.getPositionContextByEvent(evt: MouseEvent)
demo:
instance.eventBus.on(
'mousemove',
debounce(evt => {
const positionContext = instance.command.getPositionContextByEvent(evt)
console.log(positionContext)
}, 200)
)``
getElementById
Feature: Get element list by id
Usage:
const elementList = await instance.command.getElementById(payload: IGetElementByIdOption)