Visit Event
What are visit events
Events that power Visit History to answer the question: When did you visit a Note and for how long?
Two types of Visit Events:
What is a FOCUS event?
FOCUS: A visit event that represents you focusing on the editor view of a particular note.
When is FOCUS eligible to be persisted?
For pre-existing notes
You need to spend more than the Min Visitation Time Threshold with the note in focus for the FOCUS - Visit Event to be eligible for persistence.
For brand new notes
FOCUS will be eligible for persistence right away for a newly created note.
What is NOT a visit event
Rapidly jumping in and out of pre-existing note: Not a visit event
If you jump into a note for less than the minimum amount of time (default is a few seconds) and jump out before the minimum time passes, we will NOT record that as a visit event. From the visitation history, it will appear as if you haven't opened that note at all (unless you just created the note).
Seeing the preview of an embedded note: Not a visit event
If note-A has note-B embedded in it and you preview note-A, you will see note-B's contents. However, this is NOT considered a visit to note-B (only a visit to note-A).
You need to navigate to note-B explicitly for it to be considered a visit to note-B.
FOCUS is written to file with UNFOCUS
FOCUS is persisted to file with UNFOCUS
A FOCUS visit event is persisted into the Visit history File when its corresponding UNFOCUS - Visit Event is processed and persisted.
Therefore, if you want your FOCUS event to be persisted (after it has met FOCUS eligibility for persistence), you need to trigger an UNFOCUS event, which is triggered by:
UNFOCUS - Visit Event is triggered when you unfocus the editor view of the note that you had in focus. There are two main categories that trigger unfocus:
-
User action:
- Navigating to a different note
- Navigating to settings
- Focusing on non-editor view of the note (e.g., Dendron preview)
- Focusing on a different application (e.g., IntelliJ)
- Closing VSCode
-
Prolonged user inaction:
- If you focus on a note editor and then leave it without any actions (not scrolling or changing cursor position) for a period longer than thorg.visitHistory.autoUnfocusTtlSeconds - VSConfig (Default: 180 seconds), we will auto-unfocus.
What is an UNFOCUS event?
UNFOCUS: A visit-event that symbolizes loss of focus from a Note.
It can only occur after a FOCUS - Visit Event for the note in question.
Triggered by:
UNFOCUS - Visit Event is triggered when you unfocus the editor view of the note that you had in focus. There are two main categories that trigger unfocus:
-
User action:
- Navigating to a different note
- Navigating to settings
- Focusing on non-editor view of the note (e.g., Dendron preview)
- Focusing on a different application (e.g., IntelliJ)
- Closing VSCode
-
Prolonged user inaction:
- If you focus on a note editor and then leave it without any actions (not scrolling or changing cursor position) for a period longer than thorg.visitHistory.autoUnfocusTtlSeconds - VSConfig (Default: 180 seconds), we will auto-unfocus.
Where are visit events stored?
Visit events are stored in visit history files
Available configuration of Visit History:
Children
Backlinks