[PR #7078] Formula Card: Add budget analysis functions #6924

Open
opened 2026-02-28 21:34:29 -06:00 by GiteaMirror · 0 comments
Owner

Original Pull Request: https://github.com/actualbudget/actual/pull/7078

State: open
Merged: No


Description

Adds four new formula functions for budget analysis:

Query Extraction Functions:

  • QUERY_EXTRACT_CATEGORIES(queryName) - Array of category IDs from query
  • QUERY_EXTRACT_TIMEFRAME_START(queryName) - Start month (YYYY-MM) from query
  • QUERY_EXTRACT_TIMEFRAME_END(queryName) - End month (YYYY-MM) from query

Budget Query Function:

  • BUDGET_QUERY(dimension, categories, startMonth, endMonth) - Budget data for dimension

Supported dimensions: budgeted, spent, balance_start, balance_end, goal

Parameters support literal values, array notation, or extraction functions:

=BUDGET_QUERY("spent", {"internal-cat-id-1";"internal-cat-id-2"}, "2025-01", "2025-12")
=BUDGET_QUERY("budgeted", QUERY_EXTRACT_CATEGORIES("savings"), QUERY_EXTRACT_TIMEFRAME_START("fy"), QUERY_EXTRACT_TIMEFRAME_END("fy"))
=BUDGET_QUERY("balance_end", {"expenses"}, "2025-01", QUERY_EXTRACT_TIMEFRAME_END("fy"))

https://github.com/actualbudget/actual/issues/5949

Testing

I tested by visual checks within the formula query manager alongside my real budget file to ensure the results were consistent.

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 27 14.85 MB → 14.86 MB (+14.88 kB) +0.10%
loot-core 1 5.82 MB 0%
api 1 4.43 MB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
27 14.85 MB → 14.86 MB (+14.88 kB) +0.10%
Changeset
File Δ Size
src/hooks/useFormulaExecution.ts 📈 +11.28 kB (+140.67%) 8.02 kB → 19.3 kB
src/components/formula/codeMirror-excelLanguage.tsx 📈 +2.2 kB (+10.43%) 21.06 kB → 23.26 kB
src/components/formula/queryModeFunctions.ts 📈 +1.41 kB (+5.96%) 23.57 kB → 24.97 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/ReportRouter.js 1.16 MB → 1.17 MB (+11.28 kB) +0.95%
static/js/FormulaEditor.js 1.04 MB → 1.05 MB (+3.6 kB) +0.34%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/index.js 9.54 MB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 12.94 kB 0%
static/js/workbox-window.prod.es5.js 5.64 kB 0%
static/js/ca.js 188.15 kB 0%
static/js/da.js 106.35 kB 0%
static/js/de.js 180.07 kB 0%
static/js/en-GB.js 7.18 kB 0%
static/js/en.js 170.37 kB 0%
static/js/es.js 174.55 kB 0%
static/js/fr.js 179.6 kB 0%
static/js/it.js 171.16 kB 0%
static/js/nb-NO.js 156.96 kB 0%
static/js/nl.js 106.37 kB 0%
static/js/pl.js 88.37 kB 0%
static/js/pt-BR.js 154.22 kB 0%
static/js/th.js 181.87 kB 0%
static/js/uk.js 214.74 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 120.54 kB 0%
static/js/narrow.js 637.77 kB 0%
static/js/TransactionList.js 106.22 kB 0%
static/js/wide.js 164.15 kB 0%
static/js/AppliedFilters.js 9.71 kB 0%
static/js/usePayeeRuleCounts.js 10.04 kB 0%
static/js/useTransactionBatchActions.js 13.23 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 5.82 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.BwrdDDMW.js 5.82 MB 0%

api

Total

Files count Total bundle size % Changed
1 4.43 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
bundle.api.js 4.43 MB 0%
**Original Pull Request:** https://github.com/actualbudget/actual/pull/7078 **State:** open **Merged:** No --- <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description Adds four new formula functions for budget analysis: **Query Extraction Functions:** - `QUERY_EXTRACT_CATEGORIES(queryName)` - Array of category IDs from query - `QUERY_EXTRACT_TIMEFRAME_START(queryName)` - Start month (YYYY-MM) from query - `QUERY_EXTRACT_TIMEFRAME_END(queryName)` - End month (YYYY-MM) from query **Budget Query Function:** - `BUDGET_QUERY(dimension, categories, startMonth, endMonth)` - Budget data for dimension Supported dimensions: `budgeted`, `spent`, `balance_start`, `balance_end`, `goal` Parameters support literal values, array notation, or extraction functions: ``` =BUDGET_QUERY("spent", {"internal-cat-id-1";"internal-cat-id-2"}, "2025-01", "2025-12") =BUDGET_QUERY("budgeted", QUERY_EXTRACT_CATEGORIES("savings"), QUERY_EXTRACT_TIMEFRAME_START("fy"), QUERY_EXTRACT_TIMEFRAME_END("fy")) =BUDGET_QUERY("balance_end", {"expenses"}, "2025-01", QUERY_EXTRACT_TIMEFRAME_END("fy")) ``` ## Related issue(s) https://github.com/actualbudget/actual/issues/5949 ## Testing I tested by visual checks within the formula query manager alongside my real budget file to ensure the results were consistent. ## Checklist - [ ] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 27 | 14.85 MB → 14.86 MB (+14.88 kB) | +0.10% loot-core | 1 | 5.82 MB | 0% api | 1 | 4.43 MB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 27 | 14.85 MB → 14.86 MB (+14.88 kB) | +0.10% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `src/hooks/useFormulaExecution.ts` | 📈 +11.28 kB (+140.67%) | 8.02 kB → 19.3 kB `src/components/formula/codeMirror-excelLanguage.tsx` | 📈 +2.2 kB (+10.43%) | 21.06 kB → 23.26 kB `src/components/formula/queryModeFunctions.ts` | 📈 +1.41 kB (+5.96%) | 23.57 kB → 24.97 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- static/js/ReportRouter.js | 1.16 MB → 1.17 MB (+11.28 kB) | +0.95% static/js/FormulaEditor.js | 1.04 MB → 1.05 MB (+3.6 kB) | +0.34% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 9.54 MB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 12.94 kB | 0% static/js/workbox-window.prod.es5.js | 5.64 kB | 0% static/js/ca.js | 188.15 kB | 0% static/js/da.js | 106.35 kB | 0% static/js/de.js | 180.07 kB | 0% static/js/en-GB.js | 7.18 kB | 0% static/js/en.js | 170.37 kB | 0% static/js/es.js | 174.55 kB | 0% static/js/fr.js | 179.6 kB | 0% static/js/it.js | 171.16 kB | 0% static/js/nb-NO.js | 156.96 kB | 0% static/js/nl.js | 106.37 kB | 0% static/js/pl.js | 88.37 kB | 0% static/js/pt-BR.js | 154.22 kB | 0% static/js/th.js | 181.87 kB | 0% static/js/uk.js | 214.74 kB | 0% static/js/resize-observer.js | 18.37 kB | 0% static/js/BackgroundImage.js | 120.54 kB | 0% static/js/narrow.js | 637.77 kB | 0% static/js/TransactionList.js | 106.22 kB | 0% static/js/wide.js | 164.15 kB | 0% static/js/AppliedFilters.js | 9.71 kB | 0% static/js/usePayeeRuleCounts.js | 10.04 kB | 0% static/js/useTransactionBatchActions.js | 13.23 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 5.82 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.BwrdDDMW.js | 5.82 MB | 0% </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.43 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- bundle.api.js | 4.43 MB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end --->
GiteaMirror added the pull-request label 2026-02-28 21:34:29 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#6924