-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCode.gs
More file actions
executable file
·671 lines (592 loc) · 28 KB
/
Code.gs
File metadata and controls
executable file
·671 lines (592 loc) · 28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
/**
* Google App Script code to manage my budget input and visual display
* Functions interact with Google Forms for data input
* Functions interact with Google Sheets for data storage and display
*/
// Constants for Google Form data spreadsheet
const RAW_DATASHEET_NAME = 'Form Responses';
const RAW_DATASHEET_TIMESHEET_COL = 0;
const RAW_DATASHEET_CATEGORY_COL = 1;
const RAW_DATASHEET_DESCRIPTION_COL = 2;
const RAW_DATASHEET_AMOUNT = 3;
const RAW_DATASHEET_TIMESTAMP = 0;
// Constants for stored data spreadsheet
const DATASTORE_DATASHEET_NAME = 'Data';
const DATASTORE_DEFAULT_MEASUREMENTS_CELL = 'A1';
const DATASTORE_TEMP_CELL = 'G1';
const DATASTORE_TEMP_RANGE = 'G1:G';
const DATASTORE_TEMP_ROW = 1;
const DATASTORE_TEMP_COL1 = 7;
const DATASTORE_TEMP_COL2 = 8;
const DATASTORE_TEMP_TWO_COLS = 2;
const DATASTORE_MONTH_KEY_RANGE = 'E1:E';
const DATASTORE_MONTH_VAL_RANGE = 'F1:F';
const DATASTORE_MONTH_KEY_COL = 5;
const DATASTORE_MONTH_VAL_COL = 6;
const DATASTORE_BAR_INIT_CELLS = ['B2', 'C2', 'D2'];
const DATASTORE_BAR_INCOME_COL = 3;
const DATASTORE_BAR_EXPENSE_COL = 4;
const DATASTORE_BAR_MONTHS_RANGE = 'B1:B';
const DATASTORE_BAR_MONTHS_DISPLAY_RANGE = 'B2:B';
const DATASTORE_BAR_EXCESS_MONTHS = 'B13:B';
const DATASTORE_BAR_TOTAL_RANGE = 'B:D';
const DATASTORE_BAR_MONTHS_ARR = ['Jan.', 'Feb.', 'Mar.', 'Apr.', 'May', 'June', 'July', 'Aug.', 'Sept.', 'Oct.', 'Nov.', 'Dec.'];
const DATASTORE_LAST_COMPUTED_TIMESTAMP_CELL = 'A2';
const DATASTORE_LAST_COMPUTED_TOTAL_BALANCE = 'A3';
const DATASTORE_LAST_COMPUTED_MONTH_INCOME = 'A4';
const DATASTORE_LAST_COMPUTED_MONTH_EXPENSES = 'A5';
const DATASTORE_LAST_COMPUTED_YEAR_INCOME = 'A6';
const DATASTORE_LAST_COMPUTED_YEAR_EXPENSES = 'A7';
// Constants for dashboard spreadsheet
const DASHBOARD_DATASHEET_NAME = 'Dashboard';
const DASHBOARD_DATE_EXPENSE_CELL = 'B2';
const DASHBOARD_MONTH_EXPENSE_CELL = 'B3';
const DASHBOARD_YEAR_EXPENSE_CELL = 'B4';
const DASHBOARD_MONTH_INCOME_CELL = 'B5';
const DASHBOARD_YEAR_INCOME_CELL = 'B6';
const DASHBOARD_MONTH_BALANCE_CELL = 'B7';
const DASHBOARD_YEAR_BALANCE_CELL = 'B8';
const DASHBOARD_TOTAL_BALANCE_CELL = 'B9';
// Query and formatting constants
const CURRENCY_FORMAT = "$#,##0.00";
const POSITIVE_AMOUNT_COLOR = 'green';
const NEGATIVE_AMOUNT_COLOR = 'red';
const FORM_QUERY_TARGET = '\'Form Responses\'!A:D';
const FORM_DATE_EXPENSE_SQL = 'select D where A >= date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\' and B != \'Income\'';
const FORM_MONTH_EXPENSE_SQL = 'select D where MONTH(A) = MONTH(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and YEAR(A) = YEAR(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and B != \'Income\'';
const FORM_YEAR_EXPENSE_SQL = 'select D where YEAR(A) = YEAR(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and B != \'Income\'';
const FORM_MONTH_INCOME_SQL = 'select D where MONTH(A) = MONTH(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and YEAR(A) = YEAR(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and B = \'Income\'';
const FORM_YEAR_INCOME_SQL = 'select D where YEAR(A) = YEAR(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and B = \'Income\'';
const FORM_MONTH_CATEGORY_EXPENSE_SQL = 'select B,D where MONTH(A) = MONTH(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and YEAR(A) = YEAR(date \'"&TEXT(TODAY(), "yyyy-mm-dd")&"\') and B != \'Income\'';
const EXPENSES_QUERY_CONTENT = 'B != \'Income\'';
const INCOME_QUERY_CONTENT = 'B = \'Income\'';
const DurationEnum = Object.freeze({"day": 1, "month": 2, "year": 3, "beginning_of_time": 0});
// Budget Overview table constants
const TALBE_NUM_ROWS = 9;
const TABLE_ROWS = [1, 9];
const TABLE_COLS = [1, 2];
const TABLE_CELL_HEIGHT = 35;
const TABLE_CELL_KEY_WIDTH = 250;
const TABLE_CELL_VAL_WIDTH = 180;
const TABLE_STRINGS = new Map([
['A1', 'Budget Overview'],
['B1', ''],
['A2', 'Current Date Expenses:'],
['A3', 'Current Month Expenses:'],
['A4', 'Current Year Expenses:'],
['A5', 'Current Month Income:'],
['A6', 'Current Year Income:'],
['A7', 'Current Month Balance:'],
['A8', 'Current Year Balance:'],
['A9', 'Total Balance:']
]);
const TABLE_TITLE_RANGE = 'A1:B1';
const TABLE_TITLE_FONT_SIZE = 24;
const TABLE_TITLE_COLOR = '#a4c2f4';
const TABLE_KEY_VAL_RANGE = 'A2:B9';
const TABLE_BODY_FONT_SIZE = 14;
const TABLE_BODY_ALTER_COLOR_RANGES = ['A2:B4', 'A7:B8'];
const TABLE_BODY_ALTER_COLOR = '#d9d9d9';
const TABLE_BODY_WHITE_COLOR_RANGES = ['A5:B6', 'A9:B9'];
const TABLE_BODY_WHITE_COLOR = '#ffffff';
const TABLE_RANGE = 'A1:B9';
// Graph constants
const DATASTORE_MONTH_GRAPH_ROW_POS = 1;
const DATASTORE_MONTH_GRAPH_COL_POS = 4;
const MONTH_GRAPH_TITLE = 'Current Month Expenses';
const MONTH_GRAPH_COL_RANGE = [4, 8];
const BAR_LABEL_INCOME = 'Income';
const BAR_LABEL_EXPENSE = 'Expense';
const BAR_GRAPH_ROW_RANGE = [11, 29];
const BAR_GRAPH_EXTRA_COL_RANGE = [3, 8];
const DATASTORE_BAR_GRAPH_ROW_POS = 11;
const DATASTORE_BAR_GRAPH_COL_POS = 1;
const NUM_MONTHS = 12;
function init() {
// Call functions to initialize various components
formatOverviewTable();
deleteTriggers();
createUpdateTriggers();
// Sets initial cell for monthly data info
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
dataSheet.getRange(DATASTORE_BAR_INIT_CELLS[0]).setValue(DATASTORE_BAR_MONTHS_ARR[new Date().getMonth()]);
dataSheet.getRange(DATASTORE_BAR_INIT_CELLS[1]).setValue(0);
dataSheet.getRange(DATASTORE_BAR_INIT_CELLS[2]).setValue(0);
// Updates the dashboard
updateDashboard();
}
/**
* Creates the 'Budget Overview' table on the Dashboard
*/
function formatOverviewTable() {
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dashboard = spreadsheet.getSheetByName("Dashboard");
//Sets the dimensions of the Budget Overview table
dashboard.setRowHeights(TABLE_ROWS[0], TABLE_ROWS[1] - TABLE_ROWS[0] + 1, TABLE_CELL_HEIGHT);
dashboard.setColumnWidth(TABLE_COLS[0], TABLE_CELL_KEY_WIDTH);
dashboard.setColumnWidth(TABLE_COLS[1], TABLE_CELL_VAL_WIDTH);
// Sets table text
for (const [k, v] of TABLE_STRINGS) {
var cell = dashboard.getRange(k);
cell.setValue(v);
}
// Merges cells of table heading
dashboard.getRange(TABLE_TITLE_RANGE).mergeAcross();
// Formats cells for table heading
var titleRange = dashboard.getRange(TABLE_TITLE_RANGE);
titleRange.setHorizontalAlignment('center')
titleRange.setVerticalAlignment('middle');
titleRange.setFontWeight('bold');
titleRange.setFontSize(TABLE_TITLE_FONT_SIZE);
titleRange.setBackground(TABLE_TITLE_COLOR);
// Formats cells for table body
var bodyRange = dashboard.getRange(TABLE_KEY_VAL_RANGE);
bodyRange.setHorizontalAlignment('right');
bodyRange.setVerticalAlignment('middle');
bodyRange.setFontSize(TABLE_BODY_FONT_SIZE);
// Formats alternating colors for table body
var alterColorRanges = dashboard.getRangeList(TABLE_BODY_ALTER_COLOR_RANGES);
alterColorRanges.setBackground(TABLE_BODY_ALTER_COLOR);
var whiteColorRanges = dashboard.getRangeList(TABLE_BODY_WHITE_COLOR_RANGES);
whiteColorRanges.setBackground(TABLE_BODY_WHITE_COLOR);
// Sets the table border
var tableRange = dashboard.getRange(TABLE_RANGE);
tableRange.setBorder(true, true, true, true, true, true);
}
/**
* Creates Triggers to update the dashboard whenever the Google Form is submitted and each new day
* NOTE: MUST BE MANUALLY CALLED TO CREATE THE TRIGGER
*/
function createUpdateTriggers() {
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Checks if the Triggers currently exist
var createFormTrigger = true;
var createDateTrigger = true;
var createMonthTrigger = true;
var triggers = ScriptApp.getProjectTriggers();
triggers.forEach((trigger) => {
if (trigger.getEventType() === ScriptApp.EventType.ON_FORM_SUBMIT && trigger.getHandlerFunction() === 'updateDashboard') {
createFormTrigger = false;
} else if (trigger.getEventType() === ScriptApp.EventType.CLOCK && trigger.getHandlerFunction() === 'updateDashboard') {
createDateTrigger = false;
} else if (trigger.getEventType() === ScriptApp.EventType.CLOCK && trigger.getHandlerFunction() === 'updateMonthData') {
createMonthTrigger = false;
}
});
// Creates a Trigger for Form submits
if (createFormTrigger) {
ScriptApp.newTrigger('updateDashboard')
.forSpreadsheet(spreadsheet)
.onFormSubmit()
.create();
}
// Creates a Trigger for date changes
if (createDateTrigger) {
ScriptApp.newTrigger('updateDashboard')
.timeBased()
.atHour(0)
.nearMinute(30)
.everyDays(1)
.create();
}
if (createMonthTrigger) {
ScriptApp.newTrigger('updateMonthData')
.timeBased()
.atHour(0)
.nearMinute(30)
.everyDays(1)
.create();
}
}
/**
* Deletes all currently active Triggers
* NOTE: MUST BE MANUALLY CALLED TO DELETE
*/
function deleteTriggers() {
var triggers = ScriptApp.getProjectTriggers();
for(var i = 0; i < triggers.length; i++){
ScriptApp.deleteTrigger(triggers[i]);
}
}
/**
* Updates the month data at the beginning of each month for the column chart
*/
function updateMonthData() {
// Only runs on the first of the month
var date = new Date();
if (date.getDate() != 1) {
return;
}
// Gets the necessary data sheet to edit the sheet
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var currentMonth = DATASTORE_BAR_MONTHS_ARR[new Date().getMonth()];
var rangeVals = dataSheet.getRange(DATASTORE_BAR_MONTHS_DISPLAY_RANGE).getValues();
var numRows = rangeVals.filter(String).length;
// Reduces the table if there are already 12 months displayed, and then sets the data
if (numRows >= NUM_MONTHS) {
for (var i = 3; i <= numRows + 1; i++) {
dataSheet.getRange(i-1, 2, 1, 3).setValues(dataSheet.getRange(i, 2, 1, 3).getValues());
}
dataSheet.getRange(DATASTORE_BAR_EXCESS_MONTHS).clear();
dataSheet.getRange(13, 2).setValue(currentMonth);
dataSheet.getRange(13, 3).setValue(0);
dataSheet.getRange(13, 4).setValue(0);
} else {
dataSheet.getRange(numRows + 2, 2).setValue(currentMonth);
dataSheet.getRange(numRows + 2, 3).setValue(0);
dataSheet.getRange(numRows + 2, 4).setValue(0);
}
}
/**
* Gets the total balance from all data from the Google Form spreadsheet
*/
function totalBalance() {
// Tries to get cached values exist
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var datasheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var rawDatasheet = spreadsheet.getSheetByName(RAW_DATASHEET_NAME);
var storedTimestamp = datasheet.getRange(DATASTORE_LAST_COMPUTED_TIMESTAMP_CELL).getValue();
var storedValue = datasheet.getRange(DATASTORE_LAST_COMPUTED_TOTAL_BALANCE).getValue();
// Defines computation variables
var totalIncome = 0;
var totalExpenses = 0;
// Accumulates the cached values if it exists
if (typeof storedTimestamp == 'object' && typeof storedValue == 'number') {
var sql = 'select D where A >= datetime \'"&TEXT($A2, "yyyy-mm-dd HH:mm:ss")&"\' and ';
var queryIncomeData = query(FORM_QUERY_TARGET, sql + INCOME_QUERY_CONTENT);
for (var i = 1; i < queryIncomeData.length; i++) {
totalIncome += queryIncomeData[i];
}
var queryExpensesData = query(FORM_QUERY_TARGET, sql + EXPENSES_QUERY_CONTENT);
for (var i = 1; i < queryExpensesData.length; i++) {
totalExpenses += queryExpensesData[i];
}
// Cached values are invalid, so we iterate through all data entries
} else {
storedValue = 0;
// Gets the raw data from the Google Form spreadsheet
var data = rawDatasheet.getDataRange().getValues();
// Calculates the total income and expenses
for (var i = 1; i < data.length; i++) {
if (data[i][RAW_DATASHEET_CATEGORY_COL] == 'Income') {
totalIncome += data[i][RAW_DATASHEET_AMOUNT];
} else {
totalExpenses += data[i][RAW_DATASHEET_AMOUNT];
}
}
}
// Sets the result on the dashboard
var totalBalance = totalIncome - totalExpenses + storedValue;
var dashboard = spreadsheet.getSheetByName(DASHBOARD_DATASHEET_NAME);
var cell = dashboard.getRange(DASHBOARD_TOTAL_BALANCE_CELL);
cell.setNumberFormat(CURRENCY_FORMAT);
cell.setValue(totalBalance);
// Sets the color of the text
if (totalBalance >= 0) {
cell.setFontColor(POSITIVE_AMOUNT_COLOR);
} else {
cell.setFontColor(NEGATIVE_AMOUNT_COLOR);
}
// Tries to cache the timestamp of the last entry and current total
// Errors when totalBalance is called when there are no data entries (e.g. when called on init)
try {
var lastComputedTimestamp = rawDatasheet.getRange(rawDatasheet.getLastRow(), RAW_DATASHEET_TIMESTAMP + 1).getValue();
datasheet.getRange(DATASTORE_LAST_COMPUTED_TIMESTAMP_CELL).setValue(new Date(lastComputedTimestamp.getTime() + 1000));
datasheet.getRange(DATASTORE_LAST_COMPUTED_TOTAL_BALANCE).setValue(totalBalance);
} catch (err) {}
}
/**
* Sets the sum of a query sum to the specified sheet and cell
* @param {String} target The target of the query
* @param {String} sql The query parameters to search for
* @param {String} resultSheet The sheet to display the result in
* @param {String} resultCell The cell on the sheet to display the result in
* @param {String} resultFormat The format to display the result
* @param {String} cacheCell The cell on the data sheet to cache the current result
* @param {Number} cachedValue The value of previously cached data
*/
function totalQuerySum(target, sql, resultSheet, resultCell, resultFormat, cacheCell, cachedValue) {
// Gets the sheet to display the result
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName(resultSheet);
// Queries the data and sums the query output
var queryData = query(target, sql);
var sum = cachedValue;
for (var i = 1; i < queryData.length; i++) {
sum += queryData[i][0];
}
// Sets the query sum to resultCell using resultFormat
var cell = sheet.getRange(resultCell);
cell.setNumberFormat(resultFormat);
cell.setValue(sum);
// Sets the query sum to the cacheCell
if (cacheCell != null) {
var datasheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
datasheet.getRange(cacheCell).setValue(sum);
}
}
/**
* Checks if a cached value could be used to reduce query amount before computing the sum
* @param {String} target The target of the query
* @param {String} sql The query parameters to search for
* @param {String} duration The time duration the query is for
* @param {String} resultSheet The sheet to display the result in
* @param {String} resultCell The cell on the sheet to display the result in
* @param {String} resultFormat The format to display the result
* @param {String} cacheCell The cell on the data sheet to cache the current result
*/
function cachedTotalQuerySum(target, sql, duration, resultSheet, resultCell, resultFormat, cacheCell) {
// Gets the cached values in the data sheet
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var datasheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var storedTimestamp = datasheet.getRange(DATASTORE_LAST_COMPUTED_TIMESTAMP_CELL).getValue();
var storedValue = (cacheCell == null) ? null : datasheet.getRange(cacheCell).getValue();
// Checks if the cached value is valid for the given duration
var validCache = false;
if (typeof storedTimestamp == 'object' && typeof storedValue == 'number') {
var today = new Date();
switch (duration) {
case 1:
validCache = false;
break;
case 2:
validCache = (storedTimestamp.getMonth() == today.getMonth() && storedTimestamp.getFullYear() == today.getFullYear());
break;
case 3:
validCache = (storedTimestamp.getFullYear() == today.getFullYear());
break;
default:
validCache = true;
}
}
// Runs an updated query sum on valid caches
if (validCache) {
var isIncomeQuery = sql.includes(INCOME_QUERY_CONTENT);
var updated_sql = 'select D where A >= datetime \'"&TEXT($A2, "yyyy-mm-dd HH:mm:ss")&"\' and ';
updated_sql += (isIncomeQuery) ? INCOME_QUERY_CONTENT : EXPENSES_QUERY_CONTENT;
totalQuerySum(target, updated_sql, resultSheet, resultCell, resultFormat, cacheCell, storedValue);
return;
}
// Uses original query sum on invalid caches
totalQuerySum(target, sql, resultSheet, resultCell, resultFormat, cacheCell, 0);
}
/**
* Displays column chart with monthly expense and income data
* @param {String} dataRange The cell range of data
* @param {Integer} rowPos The row of the top-left corner of the chart (Google Sheets uses 1-based indexing)
* @param {Integer} colPos The column of the top-left corner of the chart (Google Sheets uses 1-based indexing)
*/
function displayBarChart(dataRange, rowPos, colPos) {
// Gets the data sheet to pull data
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var dashboard = spreadsheet.getSheetByName(DASHBOARD_DATASHEET_NAME);
var data = sheet.getRange(dataRange);
// Calculates the dimensions of the graph
var width = TABLE_CELL_KEY_WIDTH + TABLE_CELL_VAL_WIDTH + dashboard.getColumnWidth(BAR_GRAPH_EXTRA_COL_RANGE[0]) * (BAR_GRAPH_EXTRA_COL_RANGE[1] - BAR_GRAPH_EXTRA_COL_RANGE[0] + 1);
var height = dashboard.getRowHeight(BAR_GRAPH_ROW_RANGE[0]) * (BAR_GRAPH_ROW_RANGE[1] - BAR_GRAPH_ROW_RANGE[0] + 1);
// Sets the parameters of the chart
var chartBuilder = sheet.newChart()
.setChartType(Charts.ChartType.COLUMN)
.addRange(data)
.setOption('colors', [POSITIVE_AMOUNT_COLOR, NEGATIVE_AMOUNT_COLOR])
.setPosition(rowPos, colPos, 1, 1)
.setOption('legend.position', 'right')
.setOption('series', {0:{labelInLegend:BAR_LABEL_INCOME}, 1:{labelInLegend:BAR_LABEL_EXPENSE}})
.setOption('width', width)
.setOption('height', height);
var chart = chartBuilder.build();
dashboard.insertChart(chart);
}
/**
* Displays pie chart with data from datasheet with given key and value ranges
* @param {String} keyRange The range of the keys
* @param {String} valRange The range of the values
* @param {Integer} rowPos The row of the top-left corner of the chart (Google Sheets uses 1-based indexing)
* @param {Integer} colPos The column of the top-left corner of the chart (Google Sheets uses 1-based indexing)
* @param {String} title The title of the plot
*/
function displayPieChart(keyRange, valRange, rowPos, colPos, title) {
// Gets the necessary sheets
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var dashboard = spreadsheet.getSheetByName(DASHBOARD_DATASHEET_NAME);
// Sets default column widths
setDefaultWidths(DASHBOARD_DATASHEET_NAME, MONTH_GRAPH_COL_RANGE);
// Gets the ranges for the labels and data values
var totalChartLabels = dataSheet.getRange(keyRange);
var totalChartValues = dataSheet.getRange(valRange);
// Gets width and height of chart based on the Budget Overview table
var width = dashboard.getColumnWidth(MONTH_GRAPH_COL_RANGE[0]) * (MONTH_GRAPH_COL_RANGE[1] - MONTH_GRAPH_COL_RANGE[0] + 1);
var height = dashboard.getRowHeight(1) * TALBE_NUM_ROWS;
// Sets parameters for the pie chart
var totalsChart = dataSheet.newChart()
.setChartType(Charts.ChartType.PIE)
.addRange(totalChartLabels)
.addRange(totalChartValues)
.setPosition(rowPos, colPos, 0, 0)
.setOption('legend.position', 'right')
.setOption('pieSliceText', 'value-and-percentage')
.setOption('title', title)
.setOption('width', width)
.setOption('height', height)
.setNumHeaders(1)
.build();
// Inserts the chart into the dashboard
dashboard.insertChart(totalsChart);
}
/**
* Sets the pie chart data of aggregates of each expense type to the data sheet
* @param {String} target The target of the query
* @param {String} sql The query parameters to search for
* @param {Integer} keyCol The column to store keys (Google Sheets uses 1-based indexing)
* @param {Integer} valCol The column to store values (Google Sheets used 1-based indexing)
*/
function setPieChartData(target, sql, keyCol, valCol) {
// Uses the data sheet for query process and data storage
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
// Clears currently stored data
dataSheet.getRange(1, valCol, dataSheet.getLastRow()).clear();
dataSheet.getRange(1, keyCol, dataSheet.getLastRow()).clear();
// Queries data and stores in it in columns dedicated to temporary storage
var query = '=QUERY(' + target + ', \"' + sql + '\")';
var pushQuery = dataSheet.getRange(DATASTORE_TEMP_CELL).setFormula(query);
var range = dataSheet.getRange(DATASTORE_TEMP_RANGE).getValues();
var numRows = range.filter(String).length;
var pullResult = dataSheet.getRange(DATASTORE_TEMP_ROW, DATASTORE_TEMP_COL1, numRows, DATASTORE_TEMP_TWO_COLS).getValues();
// Adds queried data to a map to aggregate data of each category
var expenses = {};
for (var i = 1; i < pullResult.length; i++) {
var key = pullResult[i][0];
var val = pullResult[i][1];
if (expenses.hasOwnProperty(key)) {
expenses[key] = expenses[key] + val;
} else {
expenses[key] = val;
}
}
// Sets aggregate data to the the specified keyCol and valCol, starting on the second row
var row = 2;
for (const [key, val] of Object.entries(expenses)) {
dataSheet.getRange(row, keyCol).setValue(key);
dataSheet.getRange(row, valCol).setValue(val);
row += 1;
}
// Clears temporary data
dataSheet.getRange(1, DATASTORE_TEMP_COL1, dataSheet.getLastRow()).clear();
dataSheet.getRange(1, DATASTORE_TEMP_COL2, dataSheet.getLastRow()).clear();
}
/**
* Queries data from the spreadsheet with given parameters
* @param {String} target The target of the query
* @param {String} sql The query parameters to search for
* @return {Array} the result
*/
function query(target, sql) {
// Uses the data sheet for query process
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
// Creates the query string
var query = '=QUERY(' + target + ', \"' + sql + '\")';
// Sets query results in the data sheet for temporary storage
var pushQuery = dataSheet.getRange(DATASTORE_TEMP_CELL).setFormula(query);
// Finds the number of rows in the data sheet for the temp column and gets the results
var range = dataSheet.getRange(DATASTORE_TEMP_RANGE).getValues();
var numRows = range.filter(String).length;
var pullResult = dataSheet.getRange(DATASTORE_TEMP_ROW, DATASTORE_TEMP_COL1, numRows).getValues();
// Deletes the column returns the queried data
dataSheet.getRange(1, DATASTORE_TEMP_COL1, dataSheet.getLastRow()).clear();
return pullResult;
}
/**
* Clears all figures from a sheet
* @param {String} sheetName The name of the sheet to clear figures of
*/
function clearFigures(sheetName) {
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName(sheetName);
var charts = sheet.getCharts();
for (var i = 0; i < charts.length; i++) {
sheet.removeChart(charts[i]);
}
}
/**
* Sets a range of columns to default widths, determined by column 1 of the Data sheet
* @param {String} sheetName The name of the sheet to set columns to default width
* @param {Array} cols The array storing the start and end columns to set the widths, inclusive
*/
function setDefaultWidths(sheetName, cols) {
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var sheet = spreadsheet.getSheetByName(sheetName);
var width = dataSheet.getColumnWidth(1);
var col = cols[0];
while (col <= cols[1]) {
sheet.setColumnWidth(col, width);
col += 1;
}
}
/**
* Main function to update the dashboard
*/
function updateDashboard() {
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var dashboard = spreadsheet.getSheetByName(DASHBOARD_DATASHEET_NAME);
// Clears current figures to generate figures that reflect potential updates
clearFigures(DASHBOARD_DATASHEET_NAME);
// Queries data from Google Form responses and sets the data
// First tries to build from cached data, but recomputes all if cached data is not found
cachedTotalQuerySum(FORM_QUERY_TARGET, FORM_DATE_EXPENSE_SQL, DurationEnum.day, DASHBOARD_DATASHEET_NAME, DASHBOARD_DATE_EXPENSE_CELL, CURRENCY_FORMAT, null);
cachedTotalQuerySum(FORM_QUERY_TARGET, FORM_MONTH_EXPENSE_SQL, DurationEnum.month, DASHBOARD_DATASHEET_NAME, DASHBOARD_MONTH_EXPENSE_CELL, CURRENCY_FORMAT, DATASTORE_LAST_COMPUTED_MONTH_EXPENSES);
cachedTotalQuerySum(FORM_QUERY_TARGET, FORM_YEAR_EXPENSE_SQL, DurationEnum.year, DASHBOARD_DATASHEET_NAME, DASHBOARD_YEAR_EXPENSE_CELL, CURRENCY_FORMAT, DATASTORE_LAST_COMPUTED_YEAR_EXPENSES);
cachedTotalQuerySum(FORM_QUERY_TARGET, FORM_MONTH_INCOME_SQL, DurationEnum.month, DASHBOARD_DATASHEET_NAME, DASHBOARD_MONTH_INCOME_CELL, CURRENCY_FORMAT, DATASTORE_LAST_COMPUTED_MONTH_INCOME);
cachedTotalQuerySum(FORM_QUERY_TARGET, FORM_YEAR_INCOME_SQL, DurationEnum.year, DASHBOARD_DATASHEET_NAME, DASHBOARD_YEAR_INCOME_CELL, CURRENCY_FORMAT, DATASTORE_LAST_COMPUTED_YEAR_INCOME);
totalBalance();
// Computes and sets the total monthly balance
var monthBalanceCell = dashboard.getRange(DASHBOARD_MONTH_BALANCE_CELL);
var monthIncomeValue = dashboard.getRange(DASHBOARD_MONTH_INCOME_CELL).getValue();
var monthExpenseValue = dashboard.getRange(DASHBOARD_MONTH_EXPENSE_CELL).getValue();
var monthBalanceValue = monthIncomeValue - monthExpenseValue;
monthBalanceCell.setNumberFormat(CURRENCY_FORMAT);
monthBalanceCell.setValue(monthBalanceValue);
if (monthBalanceValue >= 0) {
monthBalanceCell.setFontColor(POSITIVE_AMOUNT_COLOR);
} else {
monthBalanceCell.setFontColor(NEGATIVE_AMOUNT_COLOR);
}
// Computes and sets the total yearly balance
var yearBalanceCell = dashboard.getRange(DASHBOARD_YEAR_BALANCE_CELL);
var yearIncomeValue = dashboard.getRange(DASHBOARD_YEAR_INCOME_CELL).getValue();
var yearExpenseValue = dashboard.getRange(DASHBOARD_YEAR_EXPENSE_CELL).getValue();
var yearBalanceValue = yearIncomeValue - yearExpenseValue;
yearBalanceCell.setNumberFormat(CURRENCY_FORMAT);
yearBalanceCell.setValue(yearBalanceValue);
if (yearBalanceValue >= 0) {
yearBalanceCell.setFontColor(POSITIVE_AMOUNT_COLOR);
} else {
yearBalanceCell.setFontColor(NEGATIVE_AMOUNT_COLOR);
}
// Updates data for bar graph
var dataSheet = spreadsheet.getSheetByName(DATASTORE_DATASHEET_NAME);
var currentMonth = DATASTORE_BAR_MONTHS_ARR[new Date().getMonth()];
var months = dataSheet.getRange(DATASTORE_BAR_MONTHS_RANGE).getValues();
var row = -1;
for (var i = 0; i < months.length; i++) {
if (months[i][0] == currentMonth) {
row = i;
break;
}
}
if (row != -1) {
dataSheet.getRange(row + 1, DATASTORE_BAR_INCOME_COL).setValue(dashboard.getRange(DASHBOARD_MONTH_INCOME_CELL).getValue());
dataSheet.getRange(row + 1, DATASTORE_BAR_EXPENSE_COL).setValue(dashboard.getRange(DASHBOARD_MONTH_EXPENSE_CELL).getValue());
}
// Plots the income and expenses column chart
displayBarChart(DATASTORE_BAR_TOTAL_RANGE, DATASTORE_BAR_GRAPH_ROW_POS, DATASTORE_BAR_GRAPH_COL_POS);
// Plots the monthly expenses as a pie chart
setPieChartData(FORM_QUERY_TARGET, FORM_MONTH_CATEGORY_EXPENSE_SQL, DATASTORE_MONTH_KEY_COL, DATASTORE_MONTH_VAL_COL);
displayPieChart(DATASTORE_MONTH_KEY_RANGE, DATASTORE_MONTH_VAL_RANGE, DATASTORE_MONTH_GRAPH_ROW_POS, DATASTORE_MONTH_GRAPH_COL_POS, MONTH_GRAPH_TITLE);
}