devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
671 lines (565 loc) • 28.1 kB
JavaScript
var extend = require("../../core/utils/extend").extend,
each = require("../../core/utils/iterator").each,
gridCore = require("./ui.data_grid.core"),
normalizeSortingInfo = gridCore.normalizeSortingInfo,
groupingCore = require("./ui.data_grid.grouping.core"),
createGroupFilter = groupingCore.createGroupFilter,
createOffsetFilter = groupingCore.createOffsetFilter,
errors = require("../widget/ui.errors"),
dataErrors = require("../../data/errors").errors,
deferredUtils = require("../../core/utils/deferred"),
when = deferredUtils.when,
Deferred = deferredUtils.Deferred;
exports.GroupingHelper = groupingCore.GroupingHelper.inherit(function () {
var foreachExpandedGroups = function foreachExpandedGroups(that, callback, updateGroups) {
return that.foreachGroups(function (groupInfo, parents) {
if (groupInfo.isExpanded) {
return callback(groupInfo, parents);
}
}, true, false, updateGroups, updateGroups);
};
var processGroupItems = function processGroupItems(that, items, groupsCount, expandedInfo, path, isCustomLoading, isLastGroupExpanded) {
var i, item, groupInfo, isExpanded;
expandedInfo.items = expandedInfo.items || [];
expandedInfo.paths = expandedInfo.paths || [];
expandedInfo.count = expandedInfo.count || 0;
expandedInfo.lastCount = expandedInfo.lastCount || 0;
if (!groupsCount) return;
for (i = 0; i < items.length; i++) {
item = items[i];
if (item.items !== undefined) {
path.push(item.key);
if (isCustomLoading) {
isExpanded = true;
} else {
groupInfo = that.findGroupInfo(path);
isExpanded = groupInfo && groupInfo.isExpanded;
}
if (!isExpanded) {
item.collapsedItems = item.items;
item.items = null;
} else {
if (item.items) {
processGroupItems(that, item.items, groupsCount - 1, expandedInfo, path, isCustomLoading, isLastGroupExpanded);
} else if (groupsCount === 1 && item.count && (!isCustomLoading || isLastGroupExpanded)) {
expandedInfo.items.push(item);
expandedInfo.paths.push(path.slice(0));
expandedInfo.count += expandedInfo.lastCount;
expandedInfo.lastCount = item.count;
}
}
path.pop();
}
}
};
var updateGroupInfoItem = function updateGroupInfoItem(that, item, isLastGroupLevel, path, offset) {
var groupInfo = that.findGroupInfo(path),
count;
if (!groupInfo) {
if (isLastGroupLevel) {
count = item.count > 0 ? item.count : item.items.length;
}
that.addGroupInfo({
isExpanded: that._isGroupExpanded(path.length - 1),
path: path.slice(0),
offset: offset,
count: count || 0
});
} else {
if (isLastGroupLevel) {
groupInfo.count = item.count > 0 ? item.count : item.items && item.items.length || 0;
} else {
item.count = groupInfo.count || item.count;
}
groupInfo.offset = offset;
}
};
var updateGroupInfos = function updateGroupInfos(that, options, items, loadedGroupCount, groupIndex, path) {
var item,
groupCount = options.group ? options.group.length : 0,
isLastGroupLevel = groupCount === loadedGroupCount,
remotePaging = options.remoteOperations.paging,
offset = 0,
totalCount = 0,
count,
i;
groupIndex = groupIndex || 0;
path = path || [];
if (remotePaging) {
offset = groupIndex === 0 ? options.skip || 0 : options.skips[groupIndex - 1] || 0;
}
if (groupIndex >= loadedGroupCount) return items.length;
for (i = 0; i < items.length; i++) {
item = items[i];
if (item) {
path.push(item.key);
if (!item.count && !item.items || item.items === undefined) {
return -1;
}
updateGroupInfoItem(that, item, isLastGroupLevel, path, offset + i);
count = item.items ? updateGroupInfos(that, options, item.items, loadedGroupCount, groupIndex + 1, path) : item.count || -1;
if (count < 0) {
return -1;
}
totalCount += count;
path.pop();
}
}
return totalCount;
};
var isGroupExpanded = function isGroupExpanded(groups, groupIndex) {
return groups && groups.length && groups[groupIndex] && !!groups[groupIndex].isExpanded;
};
var getTotalOffset = function getTotalOffset(groupInfos, pageSize, offset) {
var groupIndex,
groupSize,
totalOffset = offset;
for (groupIndex = 0; groupIndex < groupInfos.length; groupIndex++) {
groupSize = groupInfos[groupIndex].offset + 1;
if (groupIndex > 0) {
groupSize += groupInfos[groupIndex - 1].childrenTotalCount;
if (pageSize) {
groupSize += getContinuationGroupCount(totalOffset, pageSize, groupSize, groupIndex - 1) * groupIndex;
}
}
totalOffset += groupSize;
}
return totalOffset;
};
var getContinuationGroupCount = function getContinuationGroupCount(groupOffset, pageSize, groupSize, groupIndex) {
groupIndex = groupIndex || 0;
if (pageSize > 1 && groupSize > 0) {
var pageOffset = groupOffset - Math.floor(groupOffset / pageSize) * pageSize || pageSize;
pageOffset += groupSize - groupIndex - 2;
if (pageOffset < 0) {
pageOffset += pageSize;
}
return Math.floor(pageOffset / (pageSize - groupIndex - 1));
}
return 0;
};
///#DEBUG
exports.getContinuationGroupCount = getContinuationGroupCount;
///#ENDDEBUG
function applyContinuationToGroupItem(options, expandedInfo, groupLevel, expandedItemIndex) {
var item = expandedInfo.items[expandedItemIndex],
skip = options.skips && options.skips[groupLevel],
take = options.takes && options.takes[groupLevel],
isLastExpandedItem = expandedItemIndex === expandedInfo.items.length - 1,
isFirstExpandedItem = expandedItemIndex === 0,
lastExpandedItemSkip = isFirstExpandedItem && skip || 0,
isItemsTruncatedByTake = item.count > take + lastExpandedItemSkip;
if (isFirstExpandedItem && skip !== undefined) {
item.isContinuation = true;
}
if (isLastExpandedItem && take !== undefined && isItemsTruncatedByTake) {
item.isContinuationOnNextPage = true;
}
}
function fillSkipTakeInExpandedInfo(options, expandedInfo, currentGroupCount) {
var currentGroupIndex = currentGroupCount - 1,
groupCount = options.group ? options.group.length : 0;
expandedInfo.skip = options.skips && options.skips[currentGroupIndex];
if (options.takes && options.takes[currentGroupIndex] !== undefined) {
if (groupCount === currentGroupCount) {
expandedInfo.take = expandedInfo.count ? expandedInfo.count - (expandedInfo.skip || 0) : 0;
} else {
expandedInfo.take = 0;
}
expandedInfo.take += options.takes[currentGroupIndex];
}
}
function isDataDeferred(data) {
return !Array.isArray(data);
}
function makeDataDeferred(options) {
if (!isDataDeferred(options.data)) {
options.data = new Deferred();
}
}
function loadGroupItems(that, options, loadedGroupCount, expandedInfo, groupLevel, data) {
if (!options.isCustomLoading) {
expandedInfo = {};
processGroupItems(that, data, loadedGroupCount, expandedInfo, []);
fillSkipTakeInExpandedInfo(options, expandedInfo, loadedGroupCount);
}
var groupCount = options.group ? options.group.length : 0;
if (expandedInfo.paths.length && groupCount - loadedGroupCount > 0) {
makeDataDeferred(options);
loadExpandedGroups(that, options, expandedInfo, loadedGroupCount, groupLevel, data);
} else if (expandedInfo.paths.length && options.storeLoadOptions.group) {
makeDataDeferred(options);
loadLastLevelGroupItems(that, options, expandedInfo, data);
} else if (isDataDeferred(options.data)) {
options.data.resolve(data);
}
}
function loadExpandedGroups(that, options, expandedInfo, loadedGroupCount, groupLevel, data) {
var groups = options.group || [],
currentGroup = groups[groupLevel + 1],
deferreds = [];
each(expandedInfo.paths, function (expandedItemIndex) {
var loadOptions = {
requireTotalCount: false,
requireGroupCount: true,
group: [currentGroup],
groupSummary: options.storeLoadOptions.groupSummary,
filter: createGroupFilter(expandedInfo.paths[expandedItemIndex], {
filter: options.storeLoadOptions.filter,
group: groups
})
};
if (expandedItemIndex === 0) {
loadOptions.skip = expandedInfo.skip || 0;
}
if (expandedItemIndex === expandedInfo.paths.length - 1) {
loadOptions.take = expandedInfo.take;
}
var loadResult = loadOptions.take === 0 ? [] : that._dataSource.loadFromStore(loadOptions);
when(loadResult).done(function (data) {
var item = expandedInfo.items[expandedItemIndex];
applyContinuationToGroupItem(options, expandedInfo, groupLevel, expandedItemIndex);
item.items = data;
});
deferreds.push(loadResult);
});
when.apply(null, deferreds).done(function () {
updateGroupInfos(that, options, data, loadedGroupCount + 1);
loadGroupItems(that, options, loadedGroupCount + 1, expandedInfo, groupLevel + 1, data);
});
}
function loadLastLevelGroupItems(that, options, expandedInfo, data) {
var expandedFilters = [],
groups = options.group || [];
each(expandedInfo.paths, function (_, expandedPath) {
expandedFilters.push(createGroupFilter(expandedPath, {
group: options.isCustomLoading ? options.storeLoadOptions.group : groups
}));
});
var filter = options.storeLoadOptions.filter;
if (!options.storeLoadOptions.isLoadingAll) {
filter = gridCore.combineFilters([filter, gridCore.combineFilters(expandedFilters, "or")]);
}
var loadOptions = extend({}, options.storeLoadOptions, {
requireTotalCount: false,
requireGroupCount: false,
group: null,
sort: groups.concat(normalizeSortingInfo(options.storeLoadOptions.sort || [])),
filter: filter
});
var isPagingLocal = that._dataSource.isLastLevelGroupItemsPagingLocal();
if (!isPagingLocal) {
loadOptions.skip = expandedInfo.skip;
loadOptions.take = expandedInfo.take;
}
when(expandedInfo.take === 0 ? [] : that._dataSource.loadFromStore(loadOptions)).done(function (items, extra) {
if (isPagingLocal) {
items = that._dataSource.sortLastLevelGroupItems(items, groups, expandedInfo.paths);
items = expandedInfo.skip ? items.slice(expandedInfo.skip) : items;
items = expandedInfo.take ? items.slice(0, expandedInfo.take) : items;
}
each(expandedInfo.items, function (index, item) {
var itemCount = item.count - (index === 0 && loadOptions.skip || 0),
expandedItems = items.splice(0, itemCount);
applyContinuationToGroupItem(options, expandedInfo, groups.length - 1, index);
item.items = expandedItems;
});
options.data.resolve(data);
}).fail(options.data.reject);
}
var loadGroupTotalCount = function loadGroupTotalCount(dataSource, options) {
var d = new Deferred(),
isGrouping = !!(options.group && options.group.length),
loadOptions = extend({ skip: 0, take: 1, requireGroupCount: isGrouping, requireTotalCount: !isGrouping }, options, { group: isGrouping ? options.group : null });
dataSource.load(loadOptions).done(function (data, extra) {
var count = extra && (isGrouping ? extra.groupCount : extra.totalCount);
if (!isFinite(count)) {
throw dataErrors.Error(isGrouping ? "E4022" : "E4021");
}
d.resolve(count);
}).fail(d.reject.bind(d));
return d;
};
return {
updateTotalItemsCount: function updateTotalItemsCount(options) {
var totalItemsCount = 0,
totalCount = options.extra && options.extra.totalCount || 0,
groupCount = options.extra && options.extra.groupCount || 0,
pageSize = this._dataSource.pageSize(),
isVirtualPaging = this._isVirtualPaging();
foreachExpandedGroups(this, function (groupInfo) {
groupInfo.childrenTotalCount = 0;
});
foreachExpandedGroups(this, function (groupInfo, parents) {
var totalOffset = getTotalOffset(parents, isVirtualPaging ? 0 : pageSize, totalItemsCount),
count = groupInfo.count + groupInfo.childrenTotalCount;
if (!isVirtualPaging) {
count += getContinuationGroupCount(totalOffset, pageSize, count, parents.length - 1);
}
if (parents[parents.length - 2]) {
parents[parents.length - 2].childrenTotalCount += count;
} else {
totalItemsCount += count;
}
});
this.callBase(totalItemsCount - totalCount + groupCount);
},
_isGroupExpanded: function _isGroupExpanded(groupIndex) {
var groups = this._dataSource.group();
return isGroupExpanded(groups, groupIndex);
},
_updatePagingOptions: function _updatePagingOptions(options) {
var that = this,
isVirtualPaging = that._isVirtualPaging(),
pageSize = that._dataSource.pageSize(),
skips = [],
takes = [],
skipChildrenTotalCount = 0,
childrenTotalCount = 0;
if (options.take) {
foreachExpandedGroups(this, function (groupInfo) {
groupInfo.childrenTotalCount = 0;
groupInfo.skipChildrenTotalCount = 0;
});
foreachExpandedGroups(that, function (groupInfo, parents) {
var skip,
take,
takeCorrection = 0,
parentTakeCorrection = 0,
totalOffset = getTotalOffset(parents, isVirtualPaging ? 0 : pageSize, childrenTotalCount),
continuationGroupCount = 0,
skipContinuationGroupCount = 0,
groupInfoCount = groupInfo.count + groupInfo.childrenTotalCount,
childrenGroupInfoCount = groupInfoCount;
skip = options.skip - totalOffset;
if (totalOffset <= options.skip + options.take && groupInfoCount) {
take = options.take;
if (!isVirtualPaging) {
continuationGroupCount = getContinuationGroupCount(totalOffset, pageSize, groupInfoCount, parents.length - 1);
groupInfoCount += continuationGroupCount * parents.length;
childrenGroupInfoCount += continuationGroupCount;
if (pageSize && skip >= 0) {
takeCorrection = parents.length;
parentTakeCorrection = parents.length - 1;
skipContinuationGroupCount = Math.floor(skip / pageSize);
}
}
if (skip >= 0) {
if (totalOffset + groupInfoCount > options.skip) {
skips.unshift(skip - skipContinuationGroupCount * takeCorrection - groupInfo.skipChildrenTotalCount);
}
if (totalOffset + groupInfoCount >= options.skip + take) {
takes.unshift(take - takeCorrection - groupInfo.childrenTotalCount + groupInfo.skipChildrenTotalCount);
}
} else {
if (totalOffset + groupInfoCount >= options.skip + take) {
takes.unshift(take + skip - groupInfo.childrenTotalCount);
}
}
}
if (totalOffset <= options.skip) {
if (parents[parents.length - 2]) {
parents[parents.length - 2].skipChildrenTotalCount += Math.min(childrenGroupInfoCount, skip + 1 - skipContinuationGroupCount * parentTakeCorrection);
} else {
skipChildrenTotalCount += Math.min(childrenGroupInfoCount, skip + 1);
}
}
if (totalOffset <= options.skip + take) {
groupInfoCount = Math.min(childrenGroupInfoCount, skip + take - (skipContinuationGroupCount + 1) * parentTakeCorrection);
if (parents[parents.length - 2]) {
parents[parents.length - 2].childrenTotalCount += groupInfoCount;
} else {
childrenTotalCount += groupInfoCount;
}
}
});
options.skip -= skipChildrenTotalCount;
options.take -= childrenTotalCount - skipChildrenTotalCount;
}
options.skips = skips;
options.takes = takes;
},
changeRowExpand: function changeRowExpand(path) {
var that = this,
groupInfo = that.findGroupInfo(path),
dataSource = that._dataSource,
remoteGroupPaging = dataSource.remoteOperations().groupPaging,
groups = normalizeSortingInfo(dataSource.group());
if (groupInfo) {
groupInfo.isExpanded = !groupInfo.isExpanded;
if (remoteGroupPaging && groupInfo.isExpanded && path.length < groups.length) {
return loadGroupTotalCount(dataSource, {
filter: createGroupFilter(path, {
filter: dataSource.filter(),
group: dataSource.group()
}),
group: [groups[path.length]]
}).done(function (groupCount) {
groupInfo.count = groupCount;
});
}
return new Deferred().resolve();
}
return new Deferred().reject();
},
handleDataLoading: function handleDataLoading(options) {
var that = this,
storeLoadOptions = options.storeLoadOptions,
groups = normalizeSortingInfo(storeLoadOptions.group || options.loadOptions.group);
if (options.isCustomLoading || !groups.length) {
return;
}
if (options.remoteOperations.grouping) {
var remotePaging = that._dataSource.remoteOperations().paging;
storeLoadOptions.group = normalizeSortingInfo(storeLoadOptions.group);
storeLoadOptions.group.forEach(function (group, index) {
var isLastGroup = index === storeLoadOptions.group.length - 1;
group.isExpanded = !remotePaging || !isLastGroup;
});
}
options.group = options.group || groups;
if (options.remoteOperations.paging) {
options.skip = storeLoadOptions.skip;
options.take = storeLoadOptions.take;
storeLoadOptions.requireGroupCount = true;
storeLoadOptions.group = groups.slice(0, 1);
that._updatePagingOptions(options);
storeLoadOptions.skip = options.skip;
storeLoadOptions.take = options.take;
} else {
that.foreachGroups(function (groupInfo) {
groupInfo.count = 0;
});
}
},
handleDataLoadedCore: function handleDataLoadedCore(options, callBase) {
var that = this,
loadedGroupCount = normalizeSortingInfo(options.storeLoadOptions.group || options.loadOptions.group).length,
groupCount = options.group ? options.group.length : 0,
totalCount,
expandedInfo = {};
if (options.isCustomLoading) {
callBase(options);
processGroupItems(that, options.data, loadedGroupCount, expandedInfo, [], options.isCustomLoading, options.storeLoadOptions.isLoadingAll);
} else {
totalCount = updateGroupInfos(that, options, options.data, loadedGroupCount);
if (totalCount < 0) {
throw errors.Error("E1037");
}
if (!options.remoteOperations.paging) {
if (loadedGroupCount && options.extra && options.loadOptions.requireTotalCount) {
options.extra.totalCount = totalCount;
options.extra.groupCount = options.data.length;
}
}
if (groupCount && options.storeLoadOptions.requireGroupCount && !isFinite(options.extra.groupCount)) {
throw dataErrors.Error("E4022");
}
that.updateTotalItemsCount(options);
if (!options.remoteOperations.paging) {
that._updatePagingOptions(options);
}
callBase(options);
if (!options.remoteOperations.paging) {
that._processPaging(options, loadedGroupCount);
}
}
loadGroupItems(that, options, loadedGroupCount, expandedInfo, 0, options.data);
},
_processSkips: function _processSkips(items, skips, groupCount) {
if (!groupCount) return;
var firstItem = items[0],
skip = skips[0],
children = firstItem && firstItem.items;
if (skip !== undefined) {
firstItem.isContinuation = true;
if (children) {
firstItem.items = children.slice(skip);
this._processSkips(firstItem.items, skips.slice(1), groupCount - 1);
}
}
},
_processTakes: function _processTakes(items, skips, takes, groupCount, parents) {
if (!groupCount || !items) return;
parents = parents || [];
var lastItem = items[items.length - 1],
children = lastItem && lastItem.items,
take = takes[0],
skip = skips[0];
if (lastItem) {
var maxTakeCount = lastItem.count - (lastItem.isContinuation && skip || 0) || children.length;
if (take !== undefined && maxTakeCount > take) {
lastItem.isContinuationOnNextPage = true;
parents.forEach(function (parent) {
parent.isContinuationOnNextPage = true;
});
if (children) {
children = children.slice(0, take);
lastItem.items = children;
}
}
parents.push(lastItem);
this._processTakes(children, skips.slice(1), takes.slice(1), groupCount - 1, parents);
}
},
_processPaging: function _processPaging(options, groupCount) {
this._processSkips(options.data, options.skips, groupCount);
this._processTakes(options.data, options.skips, options.takes, groupCount);
},
isLastLevelGroupItemsPagingLocal: function isLastLevelGroupItemsPagingLocal() {
return false;
},
sortLastLevelGroupItems: function sortLastLevelGroupItems(items) {
return items;
},
refresh: function refresh(options, isReload, operationTypes) {
var that = this,
dataSource = that._dataSource,
storeLoadOptions = options.storeLoadOptions,
group = options.group || options.storeLoadOptions.group,
oldGroups = normalizeSortingInfo(that._group),
isExpanded,
groupIndex;
function handleGroup(groupInfo, parents) {
if (parents.length === groupIndex + 1) {
groupInfo.isExpanded = isExpanded;
}
}
for (groupIndex = 0; groupIndex < oldGroups.length; groupIndex++) {
isExpanded = isGroupExpanded(group, groupIndex);
if (isGroupExpanded(that._group, groupIndex) !== isExpanded) {
that.foreachGroups(handleGroup);
}
}
that.callBase.apply(this, arguments);
if (group && options.remoteOperations.paging && (isReload || operationTypes.reload)) {
return foreachExpandedGroups(that, function (groupInfo) {
var groupCountQuery = loadGroupTotalCount(dataSource, {
filter: createGroupFilter(groupInfo.path, {
filter: storeLoadOptions.filter,
group: group
}),
group: group.slice(groupInfo.path.length)
}),
groupOffsetQuery = loadGroupTotalCount(dataSource, {
filter: createOffsetFilter(groupInfo.path, {
filter: storeLoadOptions.filter,
group: group
}),
group: group.slice(groupInfo.path.length - 1, 1)
});
return when(groupOffsetQuery, groupCountQuery).done(function (offset, count) {
offset = parseInt(offset.length ? offset[0] : offset);
count = parseInt(count.length ? count[0] : count);
groupInfo.offset = offset;
if (groupInfo.count !== count) {
groupInfo.count = count;
that.updateTotalItemsCount(options);
}
});
}, true);
}
}
};
}());
;