Obsidian Tracker Plugin

This is an Obsidian plugin that helps you collect data from notes and represent it comprehensively.

Here is a table containing simplified examples showing what you can track.

What's New

Version 1.19.0

• Add searchType: frontmatter.exists for tracking field existence

Version 1.18.0

• Support all days for startWeekOn parameter
• Handle numeric YAML parsing for startDate/endDate with YYYYMMDD format
• Add searchType for frontmatter keys containing lists
• Update dependencies

Version 1.17.0

• Adding colorByStreak parameter to Calendars allowing for increase color intensity based on streak
• Update dependencies

Version 1.16.0

• Adding thresholdType parameter to Calendars
• Enable bar chart full-bar display at beginning and end
• Update dependencies

Version 1.15.1

• Fix: Added DatasetName as title for calendar in annotation mode
• Fix: Resolve scaling issue when navigating between monthly views
• Update dependencies

Version 1.15.0

• Fix: Minor spelling error in Examples.md
• Added new expression functions - First and Last
• Updated dates in examples to fix plots
• Respect thresholds in scaled months
• Update dependencies

Version 1.14.0

• Update dependencies
• Prevent overlapping external labels in pie chart
• Enable Stacked Bar Chart

Version 1.13.3

• Update dependencies
• Fix typo in FinanceTracker.md
• Fix typo in TestExpression.md
• Update main.ts - use new format for {{average}}

Version 1.13.2

• Update dependencies
• Fix typo in README.md
• Change streak counts to terminate on falsey values rather than null

Version 1.13.1

• Fix packaging script

Version 1.13.0

• Add support for inline dataview fields (including emoji support for values)
• Update dependencies

Version 1.12.0

• Add aspect ratio parameter for graphs
• Reorganize release notes in readme to be in descending order (latest release first)

Version 1.11.0

• Add support for checkboxes in new properties added in Obsidian 1.4
• Fix typos in documentation and examples

Version 1.10.9

• Replace tab characters by spaces
• Accept more unicode characters in dvField
• Allow emojis in the folder path
• Fixed bugs

Version 1.10.8

• Fixed startDate/endDate misread as a relative date

Version 1.10.7

• Allow using html image tags as emoji inputs

Version 1.10.6

• Fixed the coloring for missing data in the month view

Version 1.10.5

• Allow using a relative date value in initMonth in the month view

Version 1.10.4

• Allow using a regular expression as a key of the parameter textValueMap
• Add a parameter shiftOnlyValueLargerThan to determine when to do valueShift
• Fixed bugs reported by users
• Fixed typo in plugin settings

Version 1.10.3

• Allow using the parameter fitPanelWidth with the output type month and pie
• Fixed the resizing and positioning of the chart tooltip

Version 1.10.2

• Fixed plugin not rendering on some macOS machines

Version 1.10.1

• Fixed 'failed to load plugin' on iOS

Version 1.10.0

• Add annotation mode for month view (examples)
• Add parameters xAxisTickInterval, yAxisTickInterval, xAxisTickLabelFormat and yAxisTickLabelFormat for the line and bar chart (examples)
• Allow using regular expression in parameter dateFormatPrefix and dateFormatSuffix (examples)
• Add parameters file, specifiedFilesOnly, fileContainsLinkedFiles, and fileMultiplierAfterLink to retrieve data from specified files (examples)
• Add a parameter textValueMap to convert texts or emojis to specified values (examples)
• Fixed bugs
• Enhanced error messages

!!! Breaking Changes !!!

From version 1.9.0, template variables, e.g. '{{sum}}', are deprecated. Instead, Tracker provide operators (+, -, *, /, %) and functions (dataset(), sum(), maxStreak(), ......etc) to help us do data processing. For users having code blocks from previous version, please replace '{{sum}}' by '{{sum()}}' or '{{sum(1)}}' by '{{sum(dataset(1))}}'. More information about the new expressions could be found here.

Usage

1. Have some targets you want to track in daily notes.
2. Add a new note for displaying the tracker.
3. Add tracker code blocks manually (examples) or using commands.
4. Switch the document view mode to 'Preview', then the code block will get rendered.

For more use cases, please download and open the examples folder in obsidian with this plugin installed and enabled.

Development

Running Tests

The plugin includes automated unit tests. To run them:

npm test              # Run all tests
npm run test:watch    # Watch mode (re-runs on changes)
npm run test:coverage # Generate coverage report

See TESTING.md for detailed testing documentation.

Building

npm run build  # Build for production
npm run dev    # Build in watch mode for development

More Details You May Want to Know

• Installation: Install the plugin from Obsidian or install it manually
• Concepts: Explain how this plugin works and what to setup
  • Target Evaluation
  • Input Parameters
  • Expressions
• Examples
• Plugin Settings
• Release Notes
• Road Map
• Frequently Asked Questions
• Testing: How to run and write tests

Support

• If you like this plugin or want to support further development, you can Buy Me a Coffee.
• Please report bugs and request features in GitHub Issues