This plugin was designed to read code blocks in YAML format. The key-value pairs in the code blocks tell the plugin what data to collect and how to represent the result.
Here are all the parameters (key-value pairs) defined in this plugin. They are used for collecting data, evaluating targets, data preprocessing, and rendering output.
Providing parameters searchType and searchTarget is the minimum requirement for a successful data collection. searchType can be tag, frontmatter, wiki, dvField, table, fileMeta, task, or text. Then the cooresponding searchTarget should be provided according to the specified type.
Depends on the searchType and the searchTarget you provided, the evaluation of a target would be different. Simply speaking, you can track the occurrences of a target or the value attached/embedded in it.
To see the detail about the target evaluation, please check the document Target Evaluation.
Currently, obsidian-tracker provides five kinds of rendering output: line, bar, summary, bullet, month and pie. You have to provide at least one output parameter in a code block.
With output type set to line or bar, Tracker plugin will generate a customizable chart. These charts are very good at seeing the variation of collected number in the notes.
With the output type summary, a text block based on your 'template' parameter will be created. You can use expressions like '{{sum()}}' or '{{maxStreak()}}' in the template parameter, to get a statistical summary of collected data.
Output type bullet creates a bullet chart and could serve as a gauge showing the status (level, performance, progress) of a dataset.
Output type month creates a month view with circled dates exceeding the given threshold and streaks showing how long it persisted.
Output type pie creates a pie chart. The data parameter should be applied for circular sectors you want to add. Parameter label and extLabel are used for displaying labels and dataName is used for the diplay names on legend.
Detailed description for all parameters of the output types can be found here.