How to use Zotero.BetterNotes.api.editor.xxx?

[ramonmi]

FYR, Better Notes plugin offers various useful APIs, granting full control over note content: https://github.com/windingwind/zotero-better-notes?tab=readme-ov-file#-api

Originally posted by @windingwind in windingwind/zotero-actions-tags#346 (reply in thread)

I want to use await Zotero.BetterNotes.api.editor.del(Zotero.EditorInstance, 2, 5); to delete some lines in my notes, but I encountered the following error message. And what string should its first argument be?

[windingwind]

The first argument of Zotero.BetterNotes.api.editor.del should come from Zotero.BetterNotes.api.editor.getEditorInstance(noteId)

[windingwind]

By the way, the second & third args are not line index; they are the position defined by the ProseMirror editor. You can get the position from line index by calling Zotero.BetterNotes.api.editor.getPositionAtLine(editor, lineIndex, type)

[ramonmi]

Thank you for your guidance. I have attached my cases for future reference.

/**
 * Insert note to the current note using the default Better Notes template 
 * @author windingwind, ramonmi
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/341
 * @refs https://github.com/windingwind/zotero-actions-tags/discussions/108
 * @usage Trigger with shortcuts
 * @Hint must set the line number according to the actual situation
 */

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Action:Insert-Template] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}
if (!item) {
	return "[Action:Insert-Template] Target item is empty";
}

const parentItem = Zotero.Items.getTopLevel([item])[0];

if (parentItem.isRegularItem()&&item.isNote()) {
	let html = "";
	html = await Zotero.BetterNotes.api.template.runItemTemplate("[item]Journal_Data", {
		itemIds: [parentItem.id],
		targetNoteId: item.id,
	});
	let pos = Zotero.BetterNotes.api.editor.getEditorInstance(item.id);
	let linestart = Zotero.BetterNotes.api.editor.getPositionAtLine(pos, 1, "start"); // Must set the line number according to your Note or template
	let lineend = Zotero.BetterNotes.api.editor.getPositionAtLine(pos, 4, "end"); // Must set the line number according to your Note or template
	await Zotero.BetterNotes.api.editor.del(pos, linestart, lineend);
	await Zotero.BetterNotes.api.note.insert(
		item,
		html,
		1, // Must set the line number according to your Note or template
	);
	return `[Action:Insert-Template] Note is inserted to the note ${item.getNoteTitle()}`;
} else {
	return `[Action:Insert-Template] Please check if the selected item is a Childnote item!`
}

[windingwind]

Maybe better to post in Actions&Tags discussions

[ramonmi]

Done. windingwind/zotero-actions-tags#448. Thank you for your guidance.