-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement initial credit/debit sums
This commit implements the initial version of the debit/credit sum indicators on the posting journal ui-grid. There is still some work to be done to ensure that the currency ids are available at startup. A subsequent commit should introduce auto-loading (and caching) currency formats on application start for all available currencies. Closes #290.
- Loading branch information
Showing
6 changed files
with
112 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,126 @@ | ||
| angular.module('bhima.services') | ||
| .service('JournalGroupingService', JournalGroupingService); | ||
|
|
||
| JournalGroupingService.$inject = []; | ||
| JournalGroupingService.$inject = [ | ||
| 'uiGridGroupingConstants', '$filter', 'SessionService' | ||
| ]; | ||
|
|
||
| /** | ||
| * Posting Journal Grouping Service | ||
| * Posting Journal Grouping Service | ||
| * | ||
| * This service is responsible for setting the grouping configuration for the | ||
| * client side posting journal module. It also provides a number of helper | ||
| * methods that can be used to provide custom transaction grouping. | ||
| * This service is responsible for setting the grouping configuration for the | ||
| * client side posting journal module. It also provides a number of helper | ||
| * methods that can be used to provide custom transaction grouping. | ||
| */ | ||
| function JournalGroupingService() { | ||
| function JournalGroupingService(uiGridGroupingConstants, $filter, Session) { | ||
| var service = this; | ||
| // Variable used to track and share the current grids API object | ||
|
|
||
| // variable used to track and share the current grids API object | ||
| var gridApi; | ||
|
|
||
|
|
||
| // cache the enterprise currency id for easy lookup | ||
| var currencyId = Session.enterprise.currency_id; | ||
|
|
||
| // cache the currency filter for later lookup | ||
| var $currency = $filter('currency'); | ||
|
|
||
| /** | ||
| * This method enables group level selections when the posting journal is grouped | ||
| * according to a column. It first checks to ensure the row that changed is a | ||
| * header and then selects each of the rows children. | ||
| * | ||
| * @params {object} rowChanged Object containing the row that has just been selected | ||
| * @param {object} rowChanged Object containing the row that has just been selected | ||
| */ | ||
| function selectAllGroupElements(rowChanged) { | ||
|
|
||
| // determine that this selection is a header row | ||
| if (angular.isDefined(rowChanged.treeLevel) && rowChanged.treeLevel > -1) { | ||
| if (angular.isDefined(rowChanged.treeLevel) && rowChanged.treeLevel > -1) { | ||
|
|
||
| var children = gridApi.treeBase.getRowChildren(rowChanged); | ||
| children.forEach(function (child) { | ||
| children.forEach(function (child) { | ||
|
|
||
| // determine if we should we be selected or deselecting | ||
| var select = rowChanged.isSelected ? gridApi.selection.selectRow : gridApi.selection.unSelectRow; | ||
| select(child.entity); | ||
| }); | ||
| } | ||
| } | ||
| /** | ||
| * This method binds grouping utility methods to UI grid API actions. It sets | ||
| * up the default grouping functionality of the grid, specifically: | ||
|
|
||
| /** | ||
| * This method binds grouping utility methods to UI grid API actions. It sets | ||
| * up the default grouping functionality of the grid, specifically: | ||
| * - Selecting a header row will select all children elements | ||
| * - Grid transactions will be expanded on initialisation | ||
| * | ||
| * @params {object} gridApi Angular UI Grid API | ||
| * | ||
| * @param {object} gridApi Angular UI Grid API | ||
| */ | ||
| function configureDefaultGroupingOptions(gridApi) { | ||
| function configureDefaultGroupingOptions(gridApi) { | ||
| var initialised = false; | ||
|
|
||
| // bind the group selection method | ||
| gridApi.selection.on.rowSelectionChanged(null, selectAllGroupElements); | ||
|
|
||
| // hook into rows rendered call to ensure the grid is ready before expanding initial nodes | ||
| gridApi.core.on.rowsRendered(null, function () { | ||
| gridApi.core.on.rowsRendered(null, function () { | ||
|
|
||
| // only do something if we haven't yet initialised the grid | ||
| if (!initialised) { | ||
| if (!initialised) { | ||
| gridApi.treeBase.expandAllRows(); | ||
| initialised = true; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| // used to render amounts in the aggregate columns | ||
| function amountRenderer(aggregation) { | ||
| aggregation.rendered = $currency(aggregation.value, currencyId); | ||
| } | ||
|
|
||
| /** | ||
| * Groups the Grid by Transaction | ||
| */ | ||
| function groupByTransaction() { | ||
|
|
||
| // remove previous groupings | ||
| gridApi.grouping.clearGrouping(); | ||
|
|
||
| // makes sure aggregates are being properly labeled | ||
| var debits = gridApi.grid.getColumn('debit_equiv'); | ||
| var credits = gridApi.grid.getColumn('credit_equiv'); | ||
| debits.customTreeAggregationFinalizerFn = amountRenderer; | ||
| credits.customTreeAggregationFinalizerFn = amountRenderer; | ||
|
|
||
| // group by transaction id | ||
| gridApi.grouping.groupColumn('trans_id'); | ||
|
|
||
| // set aggregate | ||
| gridApi.grouping.aggregateColumn('debit_equiv', uiGridGroupingConstants.aggregation.SUM); | ||
| gridApi.grouping.aggregateColumn('credit_equiv', uiGridGroupingConstants.aggregation.SUM); | ||
| } | ||
|
|
||
| function groupInstance(gridOptions) { | ||
| var cacheGridApi = gridOptions.onRegisterApi; | ||
| // global grouping configuration | ||
|
|
||
| // global grouping configuration | ||
| gridOptions.enableGroupHeaderSelection = true; | ||
| gridOptions.treeRowHeaderAlwaysVisible = false; | ||
|
|
||
| // register for the Grid API | ||
| gridOptions.onRegisterApi = function (api) { | ||
| // register for the grid API | ||
| gridOptions.onRegisterApi = function (api) { | ||
| gridApi = api; | ||
| configureDefaultGroupingOptions(gridApi); | ||
|
|
||
| // call the method that had previously been registered to request the grids api | ||
| if (angular.isDefined(cacheGridApi)) { | ||
| if (angular.isDefined(cacheGridApi)) { | ||
| cacheGridApi(api); | ||
| } | ||
| }; | ||
|
|
||
| /** @todo expose a succinct API for the service, if necessary */ | ||
| return { | ||
| groupByTransaction : groupByTransaction | ||
| }; | ||
| } | ||
|
|
||
| return groupInstance; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <div class="ngCellText" ng-class="col.colIndex()"> | ||
| <span ng-cell-text>{{ row.getProperty(col.field) | currency:grid.appScope.$parent.currencyId }}</span> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters