am-editor-001/docs/api/editor-card.zh-CN.md

Card

编辑卡片的相关操作

类型：CardModelInterface

使用

new Engine(...).card

构造函数

new (editor: EditorInterface): CardModelInterface

属性

classes

已实例化的卡片集合对象

active

当前已激活的卡片

length

已实例化的卡片集合对象长度

方法

init

实例化

/**
 * 实例化卡片
 * @param cards 卡片集合
 */
init(cards: Array<CardEntry>): void;

add

增加卡片

/**
 * 增加卡片
 * @param name 名称
 * @param clazz 类
 */
add(clazz: CardEntry): void;

each

遍历所有已创建的卡片

/**
 * 遍历所有已创建的卡片
 * @param callback 回调函数
 */
each(callback: (card: CardInterface) => boolean | void): void;

closest

查询父节点距离最近的卡片节点

/**
 * 查询父节点距离最近的卡片节点
 * @param selector 查询器
 * @param ignoreEditable 是否忽略可编辑节点
 */
closest(
    selector: Node | NodeInterface,
    ignoreEditable?: boolean,
): NodeInterface | undefined;

find

根据选择器查找 Card

/**
 * 根据选择器查找Card
 * @param selector 卡片ID，或者子节点
 * @param ignoreEditable 是否忽略可编辑节点
 */
find(
    selector: NodeInterface | Node | string,
    ignoreEditable?: boolean,
): CardInterface | undefined;

findBlock

根据选择器查找 Block 类型 Card

/**
 * 根据选择器查找Block 类型 Card
 * @param selector 卡片ID，或者子节点
 */
findBlock(selector: Node | NodeInterface): CardInterface | undefined;

getSingleCard

获取光标选区中的单个卡片

/**
 * 获取单个卡片
 * @param range 光标范围
 */
getSingleCard(range: RangeInterface): CardInterface | undefined;

getSingleSelectedCard

获取选区选中一个节点时候的卡片

/**
 * 获取选区选中一个节点时候的卡片
 * @param rang 选区
 */
getSingleSelectedCard(rang: RangeInterface): CardInterface | undefined;

insertNode

插入卡片

/**
 * 插入卡片
 * @param range 选区
 * @param card 卡片
 */
insertNode(range: RangeInterface, card: CardInterface): CardInterface;

removeNode

移除卡片节点

/**
 * 移除卡片节点
 * @param card 卡片
 */
removeNode(card: CardInterface): void;

replaceNode

将指定节点替换成等待创建的 Card DOM 节点

/**
 * 将指定节点替换成等待创建的Card DOM 节点
 * @param node 节点
 * @param name 卡片名称
 * @param value 卡片值
 */
replaceNode(
    node: NodeInterface,
    name: string,
    value?: CardValue,
): NodeInterface;

updateNode

更新卡片重新渲染

/**
 * 更新卡片重新渲染
 * @param card 卡片
 * @param value 值
 */
updateNode(card: CardInterface, value: CardValue): void;

activate

激活卡片节点所在的卡片

/**
 * 激活卡片节点所在的卡片
 * @param node 节点
 * @param trigger 激活方式
 * @param event 事件
 */
activate(
    node: NodeInterface,
    trigger?: CardActiveTrigger,
    event?: MouseEvent,
): void;

select

选中卡片

/**
 * 选中卡片
 * @param card 卡片
 */
select(card: CardInterface): void;

focus

聚焦卡片

/**
 * 聚焦卡片
 * @param card 卡片
 * @param toStart 是否聚焦到开始位置
 */
focus(card: CardInterface, toStart?: boolean): void;

insert

插入卡片

/**
 * 插入卡片
 * @param name 卡片名称
 * @param value 卡片值
 */
insert(name: string, value?: CardValue): CardInterface;

update

更新卡片

/**
 * 更新卡片
 * @param selector 卡片选择器
 * @param value 要更新的卡片值
 */
update(selector: NodeInterface | Node | string, value: CardValue): void;

replace

把一个卡片所在位置替换成另一个指定的待渲染卡片

/**
 * 替换卡片
 * @param source 需要替换的卡片
 * @param name 新的卡片名称
 * @param value 新的卡片值
 */
replace(source: CardInterface, name: string, value?: CardValue)

remove

移除卡片

/**
 * 移除卡片
 * @param selector 卡片选择器
 */
remove(selector: NodeInterface | Node | string): void;

create

创建卡片

/**
 * 创建卡片
 * @param name 插件名称
 * @param options 选项
 */
create(
    name: string,
    options?: {
        value?: CardValue;
        root?: NodeInterface;
    },
): CardInterface;

render

渲染卡片

/**
 * 渲染卡片
 * @param container 需要重新渲染包含卡片的节点，如果不传，则渲染全部待创建的卡片节点
 */
render(container?: NodeInterface): void;

focusPrevBlock

聚焦卡片所在位置的前一个块级节点

/**
 * 聚焦卡片所在位置的前一个块级节点
 * @param card 卡片
 * @param range 光标
 * @param hasModify 没有节点时，是否创建一个空节点并聚焦
 */
focusPrevBlock(card: CardInterface, range: RangeInterface, hasModify: boolean): void;

focusNextBlock

聚焦卡片所在位置的下一个块级节点

/**
 * 聚焦卡片所在位置的下一个块级节点
 * @param card 卡片
 * @param range 光标
 * @param hasModify 没有节点时，是否创建一个空节点并聚焦
 */
focusNextBlock(card: CardInterface, range: RangeInterface, hasModify: boolean): void;

gc

释放卡片

/**
 * 释放卡片
 */
gc(): void;