| Field name | Data Type | Description |
|---|---|---|
status | Text | The completion status of this task, as determined by the character inside the [] brackets. Generally a space " " for incomplete tasks and an "x" for completed tasks, but allows for plugins which support alternative task statuses. |
checked | Boolean | Whether or not this task’s status is not empty, meaning it has some status character (which may or may not be "x") instead of a space in its [] brackets. |
completed | Boolean | Whether or not this specific task has been completed; this does not consider the completion or non-completion of any child tasks. A task is explicitly considered “completed” if it has been marked with an "x". If you use a custom status, e.g. [-], checked will be true, whereas completed will be false. |
fullyCompleted | Boolean | Whether or not this task and all of its subtasks are completed. |
text | Text | The plain text of this task, including any metadata field annotations. |
visual | Text | The text of this task, which is rendered by Dataview. This field can be overridden in DataviewJS to allow for different task text to be rendered than the regular task text, while still allowing the task to be checked (since Dataview validation logic normally checks the text against the text in-file). |
line | Number | The line of the file this task shows up on. |
lineCount | Number | The number of Markdown lines that this task takes up. |
path | Text | The full path of the file this task is in. Equals to file.path for pages. |
section | Link | Link to the section this task is contained in. |
tags | List | Any tags inside the task text. |
outlinks | List | Any links defined in this task. |
link | Link | Link to the closest linkable block near this task; useful for making links which go to the task. |
children | List | Any subtasks or sublists of this task. |
task | Boolean | If true, this is a task; otherwise, it is a regular list element. |
annotated | Boolean | True if the task text contains any metadata fields, false otherwise. |
parent | Number | The line number of the task above this task, if present; will be null if this is a root-level task. |
blockId | Text | The block ID of this task / list element, if one has been defined with the ^blockId syntax; otherwise null. |
(echo:: @ ᯤ)