Options
All
  • Public
  • Public/Protected
  • All
Menu

joplin.workspace

The workspace service provides access to all the parts of Joplin that are being worked on - i.e. the currently selected notes or notebooks as well as various related events, such as when a new note is selected, or when the note content changes.

View the demo plugin

Index

Methods

filterEditorContextMenu

onNoteAlarmTrigger

onNoteChange

  • Called when the content of the current note changes.

    Parameters

onNoteContentChange

  • Called when the content of a note changes.

    deprecated

    Use onNoteChange() instead, which is reliably triggered whenever the note content, or any note property changes.

    Parameters

onNoteSelectionChange

onResourceChange

  • Called when a resource is changed. Currently this handled will not be called when a resource is added or deleted.

    Parameters

onSyncComplete

onSyncStart

  • Called when the synchronisation process is starting.

    Parameters

selectedFolder

  • selectedFolder(): Promise<FolderEntity>
  • Gets the currently selected folder. In some cases, for example during search or when viewing a tag, no folder is actually selected in the user interface. In that case, that function would return the last selected folder.

selectedNote

  • selectedNote(): Promise<any>
  • Gets the currently selected note. Will be null if no note is selected.

selectedNoteHash

  • selectedNoteHash(): Promise<string>
  • Gets the last hash (note section ID) from cross-note link targeting specific section. New hash is available after onNoteSelectionChange() is triggered. Example of cross-note link where hello-world is a hash: Other Note Title. Method returns empty value when a note was navigated with method other than cross-note link containing valid hash.

selectedNoteIds

  • selectedNoteIds(): Promise<string[]>
  • Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes.