Developer Documentation

Technical documentation for extending and customizing FinDoc.

Architecture

• Architecture Overview - Plugin structure, components, and design patterns
• API Reference - TypeScript interfaces and types

Data Processing

• Models Reference - All built-in models and how to create custom ones
• Data Processing - Split functions and generator functions
• Charts - Chart rendering and Chart.js configuration
• Reports - Report generation system

Configuration

• Advanced Settings - Detailed configuration options and implementation

Performance

• Performance Guide - Optimization techniques and handling large datasets

Key Concepts

Model Pipeline:

1. CSV data loaded
2. Split function organizes data
3. Generator creates datasets
4. Chart/report renders output

Custom Model Example:

{
  dataSource: "splitByYearMonth",
  categories: ["Income"],
  output: "generateSumDataSet",
  chartLabelType: "money",
  dataSourceKey: "timestamp"
}

Available Split Functions:

• splitDailyDates
• splitByYearMonth
• splitByQuarter
• splitByWeek
• splitByYear
• splitByCategory
• splitByValueRange

Available Generators:

• generateDailyDataSet
• generateSumDataSet
• generateAverageDataSet
• generateCountDataSet
• generateMinMaxDataSet

Extension Points

Create custom:

• Models (combine split + generator)
• Categories
• Color schemes
• Report formats

Back to User Documentation