198 lines
12 KiB
JSON
198 lines
12 KiB
JSON
[
|
|
"Container of all the rendered script content",
|
|
"e.g.",
|
|
"ctrl+shift+a",
|
|
"specify namespace of the handler for the cases where call for bind may be repeated.\nIf a handler with this ID exists, it's replaced by the new handler.",
|
|
"Create a note link (jQuery object) for given note.",
|
|
"(or noteId)",
|
|
"Deprecated",
|
|
"use api.createLink() instead",
|
|
"Note where the script is currently executing, i.e. the note where the currently executing source code is written.",
|
|
"day.js library for date manipulation.\nSee",
|
|
"https://day.js.org",
|
|
"for documentation",
|
|
"See",
|
|
"this is producing local time! *",
|
|
"Returns",
|
|
"date in YYYY-MM-DD format",
|
|
"in bytes",
|
|
"use api.formatSize()",
|
|
"Returns day note for a given date. If it doesn't exist, it is automatically created.",
|
|
"Returns month-note. If it doesn't exist, it is automatically created.",
|
|
"Returns quarter note for given date. If such a note doesn't exist, it is automatically created.",
|
|
"Returns date-note for today. If it doesn't exist, it is automatically created.",
|
|
"Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.",
|
|
"Returns week note for given date. If such a note doesn't exist, it is automatically created.",
|
|
"Returns year-note. If it doesn't exist, it is automatically created.",
|
|
"Method",
|
|
"Entity whose event triggered this execution.",
|
|
"true to protect note, false to unprotect",
|
|
"true to protect subtree, false to unprotect",
|
|
"Return randomly generated string of given length. This random string generation is NOT cryptographically secure.",
|
|
"jquery object on which to set up the tooltip",
|
|
"Show confirm dialog to the user.",
|
|
"Show an error toast message to the user.",
|
|
"Show an info dialog to the user.",
|
|
"Show an info toast message to the user.",
|
|
"Show prompt dialog to the user.",
|
|
"Note where the script started executing, i.e., the (event) entrypoint of the current script execution.",
|
|
"Trigger command. This is a very low-level API which should be avoided if possible.",
|
|
"Trigger event. This is a very low-level API which should be avoided if possible.",
|
|
"Trilium runs in a backend and frontend process, when something is changed on the backend from a script,\nfrontend will get asynchronously synchronized.",
|
|
"This method returns a promise which resolves once all the backend -",
|
|
"frontend synchronization is finished.\nTypical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it.",
|
|
"Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.",
|
|
"Activates note in the tree and in the note detail.",
|
|
"Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.",
|
|
"you can now create/modify launchers in the top-left Menu -",
|
|
"Configure Launchbar\nfor special needs there's also backend API's createOrUpdateLauncher()",
|
|
"Adds given text to the editor cursor",
|
|
"this must be clear text, HTML is not supported.",
|
|
"https://codemirror.net/doc/manual.html#api",
|
|
"https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html",
|
|
"for documentation on the returned instance.",
|
|
"Get access to the widget handling note detail. Methods like",
|
|
"and",
|
|
"to get to the\nimplementation of actual widget type.",
|
|
"Returns component which owns the given DOM element (the nearest parent component in DOM tree)",
|
|
"DOM element",
|
|
"Instance name identifies particular Trilium instance. It can be useful for scripts\nif some action needs to happen on only one specific instance.",
|
|
"Returns note by given noteId. If note is missing from the cache, it's loaded.",
|
|
"Returns list of notes. If note is missing from the cache, it's loaded.",
|
|
"This is often used to bulk-fill the cache with notes which would have to be picked one by one\notherwise (by e.g. createLink())",
|
|
"don't report error if the note is not found",
|
|
"Log given message to the log pane in UI",
|
|
"Open a note in a new split.",
|
|
"set to true to activate the new split, false to stay on the current split",
|
|
"Open a note in a new tab.",
|
|
"set to true to activate the new tab, false to stay on the current tab",
|
|
"This will refresh all currently opened notes which have included note specified in the parameter",
|
|
"noteId of the included note",
|
|
"Update frontend tree (note) cache from the backend.",
|
|
"Executes given anonymous function on the backend.\nInternally this serializes the anonymous function into string and sends it to backend via AJAX.\nThis function is meant for advanced needs where an async function is necessary.\nIn this case, the automatic request-scoped transaction management is not applied,\nand you need to manually define transaction via api.transactional().",
|
|
"If you have a synchronous function, please use api.runOnBackend().",
|
|
"(synchronous) function to be executed on the backend",
|
|
"list of parameters to the anonymous function to be sent to backend",
|
|
"Executes given anonymous function on the backend.\nInternally this serializes the anonymous function into string and sends it to backend via AJAX.\nPlease make sure that the supplied function is synchronous. Only sync functions will work correctly\nwith transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()",
|
|
"This is a powerful search method - you can search by attributes and their values, e.g.:",
|
|
"#dateModified =* MONTH AND #log",
|
|
". See full documentation for all options at:",
|
|
"https://triliumnext.github.io/Docs/Wiki/search.html",
|
|
"Hoist note in the current tab. See",
|
|
"https://triliumnext.github.io/Docs/Wiki/note-hoisting.html",
|
|
"set hoisted note. 'root' will effectively unhoist",
|
|
"Note is the main node and concept in Trilium.",
|
|
"content-type, e.g.",
|
|
"application/json",
|
|
"Executes this FNote as a front-end or back-end script.",
|
|
"Throws",
|
|
"an Error if the note has an incorrect note type or MIME for execution.",
|
|
"Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)",
|
|
"attribute type (label, relation, etc.)",
|
|
"attribute name",
|
|
"attribute type to filter",
|
|
"attribute name to filter",
|
|
"Returns the note path considered to be the",
|
|
"best",
|
|
"use getParentBranches() instead",
|
|
"use getParentBranchIds() instead",
|
|
"label name",
|
|
"label name to filter",
|
|
"Provides note's date metadata.",
|
|
"use getBlob() instead",
|
|
"relation name",
|
|
"relation name to filter",
|
|
"Get relations which target this note",
|
|
"NOOP",
|
|
"This object contains",
|
|
"at your risk",
|
|
"no BC guarantees",
|
|
"objects for advanced use cases.",
|
|
"provides access to the backend in-memory object graph, see",
|
|
"Becca",
|
|
"Axios library for HTTP requests. See",
|
|
"https://axios-http.com",
|
|
"use native (browser compatible) fetch() instead",
|
|
"cheerio library for HTML parsing and manipulation. See",
|
|
"https://cheerio.js.org",
|
|
"Note where the script is currently executing. This comes into play when your script is spread in multiple code\nnotes, the script starts in",
|
|
"startNote",
|
|
", but then through function calls may jump into another note (currentNote).\nA similar concept in C would be",
|
|
"FILE",
|
|
"Don't mix this up with the concept of active note.",
|
|
"day.js library for date manipulation. See",
|
|
"Entity whose event triggered this execution",
|
|
"sql",
|
|
"Note where the script started executing (entrypoint).\nAs an analogy, in C this would be the file which contains the main() function of the current process.",
|
|
"xml2js library for XML parsing. See",
|
|
"https://github.com/Leonidas-from-XIV/node-xml2js",
|
|
"If the backupName is e.g.",
|
|
"now",
|
|
", then the backup will be written to",
|
|
"backup-now.db",
|
|
"file",
|
|
"Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and\nJSON MIME type. See also createNewNote() for more options.",
|
|
"create new note under this parent",
|
|
"should the note be JSON",
|
|
"please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs",
|
|
"Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.",
|
|
"name of the boxicon to be used (e.g.",
|
|
"bx-time",
|
|
"id of the launcher, only alphanumeric at least 6 characters long",
|
|
"if true, will be created in the",
|
|
"Visible launchers",
|
|
", otherwise in",
|
|
"Available launchers",
|
|
"will activate the target note/script upon pressing, e.g.",
|
|
"ctrl+e",
|
|
"for type",
|
|
"script",
|
|
"note",
|
|
"one of",
|
|
"- activating the launcher will navigate to the target note (specified in targetNoteId param)",
|
|
"- activating the launcher will execute the script (specified in scriptNoteId param)",
|
|
"customWidget",
|
|
"- the launcher will be rendered with a custom widget (specified in widgetNoteId param)",
|
|
"Create text note. See also createNewNote() for more options.",
|
|
"If there's a branch between note and parent note, remove it. Otherwise, do nothing.",
|
|
"If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.",
|
|
"if branch is created between note and parent note, set this prefix",
|
|
"either 'html' or 'markdown'",
|
|
"Returns day note for given date. If such note doesn't exist, it is created.",
|
|
"in YYYY-MM-DD format",
|
|
"specify calendar root note, normally leave empty to use the default calendar",
|
|
"Returns month note for given date. If such a note doesn't exist, it is created.",
|
|
"in YYYY-MM format",
|
|
"Retrieves notes with given label name",
|
|
"value",
|
|
"attribute value",
|
|
"Retrieves first note with given label name",
|
|
"Returns quarter note for given date. If such a note doesn't exist, it is created.",
|
|
"Returns root note of the calendar.",
|
|
"Returns today's day note. If such note doesn't exist, it is created.",
|
|
"Returns note for the first date of the week of the given date.",
|
|
"Returns week note for given date. If such a note doesn't exist, it is created.",
|
|
"Returns year note for given year. If such a note doesn't exist, it is created.",
|
|
"in YYYY format",
|
|
"Log given message to trilium logs and log pane in UI",
|
|
"of the string",
|
|
"Executes given anonymous function on the frontend(s).\nInternally, this serializes the anonymous function into string and sends it to frontend(s) via WebSocket.\nNote that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all\ninstances execute the given function.",
|
|
"script to be executed on the frontend",
|
|
"list of parameters to the anonymous function to be sent to frontend",
|
|
"Sync process can make data intermittently inconsistent. Scripts which require strong data consistency\ncan use this function to wait for a possible sync process to finish and prevent new sync process from starting\nwhile it is running.",
|
|
"Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case\nyou need to make some DB changes, you need to surround your call with api.transactional(...)",
|
|
"function to be executed while sync process is not running",
|
|
". See",
|
|
"for full documentation for all options",
|
|
"This method finds note by its noteId and prefix and either sets it to the given parentNoteId\nor removes the branch (if parentNoteId is not given).",
|
|
"This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.",
|
|
"this method is pretty confusing and serves specialized purpose only",
|
|
"Sort child notes of a given note.",
|
|
"'title', 'dateCreated', 'dateModified' or a label name\nSee",
|
|
"https://triliumnext.github.io/Docs/Wiki/sorting.html",
|
|
"for details.",
|
|
"Based on the value, either create or remove branch between note and parent note.",
|
|
"true if we want the branch to exist, false if we want it gone",
|
|
"This functions wraps code which is supposed to be running in transaction. If transaction already\nexists, then we'll use that transaction.",
|
|
"to unescape"
|
|
] |