执行动作命令
使用方式
import Editor from "@hufe921/canvas-editor"
const instance = new Editor(container, <IElement[]>data, options)
instance.command.commandName()
executeMode
功能:切换编辑器模式(编辑、清洁、只读、表单)
用法:
instance.command.executeMode(editorMode: EditorMode)
executeCut
功能:剪切
用法:
instance.command.executeCut()
executeCopy
功能:复制
用法:
instance.command.executeCopy()
executePaste
功能:粘贴
用法:
instance.command.executePaste(payload?: IPasteOption)
executeSelectAll
功能:全选
用法:
instance.command.executeSelectAll()
executeBackspace
功能:向前删除
用法:
instance.command.executeBackspace()
executeSetRange
功能:设置选区
用法:
instance.command.executeSetRange(
startIndex: number,
endIndex: number,
tableId?: string,
startTdIndex?: number,
endTdIndex?: number,
startTrIndex?: number,
endTrIndex?: number
)
executeReplaceRange
功能:替换选区
用法:
instance.command.executeReplaceRange(range: IRange)
executeSetPositionContext
功能:设置位置上下文
用法:
instance.command.executeSetPositionContext(range: IRange)
executeForceUpdate
功能:强制重新渲染文档
用法:
instance.command.executeForceUpdate(options?: IForceUpdateOption)
executeBlur
功能:设置编辑器失焦
用法:
instance.command.executeBlur()
executeUndo
功能:撤销
用法:
instance.command.executeUndo()
executeRedo
功能:重做
用法:
instance.command.executeRedo()
executePainter
功能:格式刷-复制样式
用法:
instance.command.executePainter()
executeApplyPainterStyle
功能:格式刷-应用样式
用法:
instance.command.executeApplyPainterStyle()
executeFormat
功能:清除样式
用法:
instance.command.executeFormat()
executeFont
功能:设置字体
用法:
instance.command.executeFont(font: string)
executeSize
功能:设置字号
用法:
instance.command.executeSize(size: number)
executeSizeAdd
功能:增大字号
用法:
instance.command.executeSizeAdd()
executeSizeMinus
功能:减小字号
用法:
instance.command.executeSizeMinus()
executeBold
功能:字体加粗
用法:
instance.command.executeBold()
executeItalic
功能:字体斜体
用法:
instance.command.executeItalic()
executeUnderline
功能:下划线
用法:
instance.command.executeUnderline(textDecoration?: ITextDecoration)
executeStrikeout
功能:删除线
用法:
instance.command.executeStrikeout()
executeSuperscript
功能:上标
用法:
instance.command.executeSuperscript()
executeSubscript
功能:上下标
用法:
instance.command.executeSubscript()
executeColor
功能:字体颜色
用法:
instance.command.executeColor(color: string | null)
executeHighlight
功能:高亮
用法:
instance.command.executeHighlight(color: string | null)
executeTitle
功能:标题设置
用法:
instance.command.executeTitle(TitleLevel | null)
executeList
功能:列表设置
用法:
instance.command.executeList(listType: ListType | null, listStyle?: ListStyle)
executeRowFlex
功能:行对齐
用法:
instance.command.executeRowFlex(rowFlex: RowFlex)
executeRowMargin
功能:行间距
用法:
instance.command.executeRowMargin(rowMargin: number)
executeInsertTable
功能:插入表格
用法:
instance.command.executeInsertTable(row: number, col: number)
executeInsertTableTopRow
功能:向上插入一行
用法:
instance.command.executeInsertTableTopRow()
executeInsertTableBottomRow
功能:向下插入一行
用法:
instance.command.executeInsertTableBottomRow()
executeInsertTableLeftCol
功能:向左插入一列
用法:
instance.command.executeInsertTableLeftCol()
executeInsertTableRightCol
功能:向右插入一列
用法:
instance.command.executeInsertTableRightCol()
executeDeleteTableRow
功能:删除当前行
用法:
instance.command.executeDeleteTableRow()
executeDeleteTableCol
功能:删除当前列
用法:
instance.command.executeDeleteTableCol()
executeDeleteTable
功能:删除表格
用法:
instance.command.executeDeleteTable()
executeMergeTableCell
功能:合并表格
用法:
instance.command.executeMergeTableCell()
executeCancelMergeTableCell
功能:取消合并表格
用法:
instance.command.executeCancelMergeTableCell()
executeTableTdVerticalAlign
功能:表格单元格垂直对齐方式
用法:
instance.command.executeTableTdVerticalAlign(payload: VerticalAlign)
executeTableBorderType
功能:表格边框类型
用法:
instance.command.executeTableBorderType(payload: TableBorder)
executeTableTdBorderType
功能:表格单元格边框类型
用法:
instance.command.executeTableTdBorderType(payload: TdBorder)
executeTableTdSlashType
功能:表格单元格内斜线
用法:
instance.command.executeTableTdSlashType(payload: TdSlash)
executeTableTdBackgroundColor
功能:表格单元格背景色
用法:
instance.command.executeTableTdBackgroundColor(payload: string)
executeTableSelectAll
功能:选中整个表格
用法:
instance.command.executeTableSelectAll()
executeImage
功能:插入图片
用法:
instance.command.executeImage({
width: number;
height: number;
value: string;
})
executeHyperlink
功能:插入链接
用法:
instance.command.executeHyperlink({
type: ElementType.HYPERLINK,
value: string,
url: string,
valueList: IElement[]
})
executeDeleteHyperlink
功能:删除链接
用法:
instance.command.executeDeleteHyperlink()
executeCancelHyperlink
功能:取消链接
用法:
instance.command.executeCancelHyperlink()
executeEditHyperlink
功能:编辑链接
用法:
instance.command.executeEditHyperlink(newUrl: string)
executeSeparator
功能:插入分割线
用法:
instance.command.executeSeparator(dashArray: number[])
executePageBreak
功能:分页符
用法:
instance.command.executePageBreak()
executeAddWatermark
功能:添加水印
用法:
instance.command.executeAddWatermark({
data: string;
color?: string;
opacity?: number;
size?: number;
font?: string;
})
executeDeleteWatermark
功能:删除水印
用法:
instance.command.executeDeleteWatermark()
executeSearch
功能:搜索
用法:
instance.command.executeSearch(keyword: string)
executeSearchNavigatePre
功能:搜索导航-上一个
用法:
instance.command.executeSearchNavigatePre()
executeSearchNavigateNext
功能:搜索导航-下一个
用法:
instance.command.executeSearchNavigateNext()
executeReplace
功能:搜索替换
用法:
instance.command.executeReplace(newWord: string)
executePrint
功能:打印
用法:
instance.command.executePrint()
executeReplaceImageElement
功能:替换图片
用法:
instance.command.executeReplaceImageElement(newUrl: string)
executeSaveAsImageElement
功能:另存为图片
用法:
instance.command.executeSaveAsImageElement()
executeChangeImageDisplay
功能:改变图片行显示方式
用法:
instance.command.executeSaveAsImageElement(element: IElement, display: ImageDisplay)
executePageMode
功能:页面模式
用法:
instance.command.executePageMode(pageMode: PageMode)
executePageScaleRecovery
功能:恢复页面原始缩放比例
用法:
instance.command.executePageScaleRecovery()
executePageScaleMinus
功能:页面缩小
用法:
instance.command.executePageScaleMinus()
executePageScaleAdd
功能:页面放大
用法:
instance.command.executePageScaleAdd()
executePaperSize
功能:设置纸张大小
用法:
instance.command.executePaperSize(width: number, height: number)
executePaperDirection
功能:设置纸张方向
用法:
instance.command.executePaperDirection(paperDirection: PaperDirection)
executeSetPaperMargin
功能:设置纸张页边距
用法:
instance.command.executeSetPaperMargin([top: number, right: number, bottom: number, left: number])
executeInsertElementList
功能:插入元素
用法:
instance.command.executeInsertElementList(elementList: IElement[])
executeAppendElementList
功能:追加元素
用法:
instance.command.executeAppendElementList(elementList: IElement[], options?: IAppendElementListOption)
executeSetValue
功能:设置编辑器数据
用法:
instance.command.executeSetValue(payload: Partial<IEditorData>)
executeRemoveControl
功能:删除控件
用法:
instance.command.executeRemoveControl()
executeSetLocale
功能:设置本地语言
用法:
instance.command.executeSetLocale(locale: string)
executeLocationCatalog
功能:定位目录位置
用法:
instance.command.executeLocationCatalog(titleId: string)
executeWordTool
功能:文字工具(删除空行、行首空格)
用法:
instance.command.executeWordTool()
executeSetHTML
功能:设置编辑器 HTML 数据
用法:
instance.command.executeSetHTML(payload: Partial<IEditorHTML)
executeSetGroup
功能:设置成组
用法:
instance.command.executeSetGroup()
executeDeleteGroup
功能:删除成组
用法:
instance.command.executeDeleteGroup(groupId: string)
executeLocationGroup
功能:定位成组位置
用法:
instance.command.executeLocationGroup(groupId: string)
executeSetZone
功能:设置激活区域(页眉、正文、页脚)
用法:
instance.command.executeSetZone(zone: EditorZone)
executeSetControlValue
功能:设置控件值
用法:
instance.command.executeSetControlValue(payload: ISetControlValueOption)
executeSetControlExtension
功能:设置控件扩展值
用法:
instance.command.executeSetControlExtension(payload: ISetControlExtensionOption)
executeSetControlProperties
功能:设置控件属性
用法:
instance.command.executeSetControlProperties(payload: ISetControlProperties)
executeSetControlHighlight
功能:设置控件高亮(根据关键词)
用法:
instance.command.executeSetControlHighlight(payload: ISetControlHighlightOption)