am-editor-001/docs/api/editor-node-id.md

1.3 KiB

NodeId

Node data-id generator

Type: NodeIdInterface

use

init

initialization

/**
* Initialization
*/
init(): void;

getRules

Get rules

/**
* Obtain the label name collection that needs to create data-id for the node according to the rules
* @returns
*/
getRules(): {[key: string]: SchemaRule[] };

create

Create data-id for the node

/**
* Create data-id for the node
* @param node node
* @returns
*/
create(node: Node | NodeInterface): string;

generateAll

Create a data-id for the child node that needs to create a data-id in the root node

/**
* Create a data-id in the root node for the child node that needs to create a data-id
* @param root root node
*/
generateAll(root?: Element | NodeInterface, force?: boolean): void;

generate

Create a random data-id for the node

/**
* Create a random data-id for the node
* @param node node
* @param isCreate If yes, do you need to recreate
* @returns
*/
generate(
    root: Element | NodeInterface | DocumentFragment,
    force?: boolean,
): string | undefined;

isNeed

Determine whether a node needs to create data-id

/**
* Determine whether a node needs to create data-id
* @param name node name
* @returns
*/
isNeed(node: NodeInterface): boolean;