devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
501 lines (480 loc) • 19.7 kB
JavaScript
/**
* DevExtreme (esm/__internal/grids/pivot_grid/remote_store/module.js)
* Version: 22.1.9
* Build date: Tue Apr 18 2023
*
* Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import {
isString,
isDefined
} from "../../../../core/utils/type";
import Class from "../../../../core/class";
import {
extend
} from "../../../../core/utils/extend";
import {
each
} from "../../../../core/utils/iterator";
import {
DataSource
} from "../../../../data/data_source/data_source";
import {
when,
Deferred
} from "../../../../core/utils/deferred";
import dateSerialization from "../../../../core/utils/date_serialization";
import {
normalizeLoadResult
} from "../../../../data/data_source/utils";
import pivotGridUtils, {
getFiltersByPath,
capitalizeFirstLetter,
getExpandedLevel,
setDefaultFieldValueFormatting
} from "../module_widget_utils";
import {
forEachGroup
} from "./module_utils";
function createGroupingOptions(dimensionOptions, useSortOrder) {
const groupingOptions = [];
each(dimensionOptions, (index, dimensionOption) => {
groupingOptions.push({
selector: dimensionOption.dataField,
groupInterval: dimensionOption.groupInterval,
desc: useSortOrder && "desc" === dimensionOption.sortOrder,
isExpanded: index < dimensionOptions.length - 1
})
});
return groupingOptions
}
function getFieldFilterSelector(field) {
let selector = field.dataField;
let {
groupInterval: groupInterval
} = field;
if ("date" === field.dataType && "string" === typeof groupInterval) {
if ("quarter" === groupInterval.toLowerCase()) {
groupInterval = "Month"
}
selector = `${selector}.${capitalizeFirstLetter(groupInterval)}`
}
return selector
}
function getIntervalFilterExpression(selector, numericInterval, numericValue, isExcludedFilterType) {
const startFilterValue = [selector, isExcludedFilterType ? "<" : ">=", numericValue];
const endFilterValue = [selector, isExcludedFilterType ? ">=" : "<", numericValue + numericInterval];
return [startFilterValue, isExcludedFilterType ? "or" : "and", endFilterValue]
}
function getFilterExpressionForFilterValue(field, filterValue) {
const selector = getFieldFilterSelector(field);
const isExcludedFilterType = "exclude" === field.filterType;
let expression = [selector, isExcludedFilterType ? "<>" : "=", filterValue];
if (isDefined(field.groupInterval)) {
if ("string" === typeof field.groupInterval && "quarter" === field.groupInterval.toLowerCase()) {
expression = getIntervalFilterExpression(selector, 3, 3 * (filterValue - 1) + 1, isExcludedFilterType)
} else if ("number" === typeof field.groupInterval && "date" !== field.dataType) {
expression = getIntervalFilterExpression(selector, field.groupInterval, filterValue, isExcludedFilterType)
}
}
return expression
}
function createFieldFilterExpressions(field, operation) {
const fieldFilterExpressions = [];
if (field.searchValue) {
return [field.dataField, "contains", field.searchValue]
}
if ("exclude" === field.filterType) {
operation = operation || "and"
} else {
operation = operation || "or"
}
each(field.filterValues, (index, filterValue) => {
let currentExpression = [];
if (Array.isArray(filterValue)) {
const parseLevelsRecursive = field.levels && field.levels.length;
if (parseLevelsRecursive) {
currentExpression = createFieldFilterExpressions({
filterValues: filterValue,
filterType: field.filterType,
levels: field.levels
}, "and")
}
} else {
const currentField = field.levels ? field.levels[index] : field;
currentExpression = getFilterExpressionForFilterValue(currentField, filterValue)
}
if (!currentExpression.length) {
return
}
if (fieldFilterExpressions.length) {
fieldFilterExpressions.push(operation)
}
fieldFilterExpressions.push(currentExpression)
});
return fieldFilterExpressions
}
function createFilterExpressions(fields) {
let filterExpressions = [];
each(fields, (_, field) => {
const fieldExpressions = createFieldFilterExpressions(field);
if (!fieldExpressions.length) {
return []
}
if (filterExpressions.length) {
filterExpressions.push("and")
}
filterExpressions.push(fieldExpressions);
return
});
if (1 === filterExpressions.length) {
filterExpressions = filterExpressions[0]
}
return filterExpressions
}
function mergeFilters(filter1, filter2) {
let mergedFilter;
const notEmpty = function(filter) {
return filter && filter.length
};
if (notEmpty(filter1) && notEmpty(filter2)) {
mergedFilter = [filter1, "and", filter2]
} else {
mergedFilter = notEmpty(filter1) ? filter1 : filter2
}
return mergedFilter
}
function createLoadOptions(options, externalFilterExpr, hasRows) {
let filterExpressions = createFilterExpressions(options.filters);
const groupingOptions = createGroupingOptions(options.rows, options.rowTake).concat(createGroupingOptions(options.columns, options.columnTake));
const loadOptions = {
groupSummary: [],
totalSummary: [],
group: groupingOptions.length ? groupingOptions : void 0,
take: groupingOptions.length ? void 0 : 1
};
if (options.rows.length && options.rowTake) {
loadOptions.skip = options.rowSkip;
loadOptions.take = options.rowTake;
loadOptions.requireGroupCount = true
} else if (options.columns.length && options.columnTake && !hasRows) {
loadOptions.skip = options.columnSkip;
loadOptions.take = options.columnTake;
loadOptions.requireGroupCount = true
}
if (externalFilterExpr) {
filterExpressions = mergeFilters(filterExpressions, externalFilterExpr)
}
if (filterExpressions.length) {
loadOptions.filter = filterExpressions
}
each(options.values, (_, value) => {
const summaryOption = {
selector: value.dataField,
summaryType: value.summaryType || "count"
};
loadOptions.groupSummary.push(summaryOption);
options.includeTotalSummary && loadOptions.totalSummary.push(summaryOption)
});
return loadOptions
}
function setValue(valuesArray, value, rowIndex, columnIndex, dataIndex) {
valuesArray[rowIndex] = valuesArray[rowIndex] || [];
valuesArray[rowIndex][columnIndex] = valuesArray[rowIndex][columnIndex] || [];
if (!isDefined(valuesArray[rowIndex][columnIndex][dataIndex])) {
valuesArray[rowIndex][columnIndex][dataIndex] = value
}
}
function parseValue(value, field) {
if (field && "number" === field.dataType && isString(value)) {
return Number(value)
}
if (field && "date" === field.dataType && !field.groupInterval && !(value instanceof Date)) {
return dateSerialization.deserializeDate(value)
}
return value
}
function parseResult(data, total, descriptions, result) {
const rowPath = [];
let columnPath = [];
const {
rowHash: rowHash
} = result;
const {
columnHash: columnHash
} = result;
if (total && total.summary) {
each(total.summary, (index, summary) => {
setValue(result.values, summary, result.grandTotalRowIndex, result.grandTotalColumnIndex, index)
})
}
if (total && total.groupCount >= 0) {
const skip = descriptions.rows.length ? descriptions.rowSkip : descriptions.columnSkip;
data = [...Array(skip)].concat(data);
data.length = total.groupCount
}
function getItem(dataItem, dimensionName, path, level, field) {
const dimensionHash = result[dimensionName + "Hash"];
let parentItem;
let parentItemChildren;
let item;
const pathValue = path.slice(0, level + 1).join("/");
let parentPathValue;
if (void 0 !== dimensionHash[pathValue]) {
item = dimensionHash[pathValue]
} else {
item = {
value: parseValue(dataItem.key, field),
index: result[dimensionName + "Index"]++,
displayText: dataItem.displayText
};
parentPathValue = path.slice(0, level).join("/");
if (level > 0 && void 0 !== dimensionHash[parentPathValue]) {
parentItem = dimensionHash[parentPathValue];
parentItemChildren = parentItem.children = parentItem.children || []
} else {
parentItemChildren = result[dimensionName + "s"]
}
parentItemChildren.push(item);
dimensionHash[pathValue] = item
}
return item
}
forEachGroup(data, (item, level) => {
const rowLevel = level >= descriptions.rows.length ? descriptions.rows.length : level;
const columnLevel = level >= descriptions.rows.length ? level - descriptions.rows.length : 0;
let columnItem;
let rowItem;
if (level >= descriptions.rows.length && columnLevel >= descriptions.columns.length) {
return
}
if (level < descriptions.rows.length) {
columnPath = []
}
if (level >= descriptions.rows.length) {
if (item) {
columnPath[columnLevel] = "" + item.key;
columnItem = getItem(item, "column", columnPath, columnLevel, descriptions.columns[columnLevel]);
rowItem = rowHash[rowPath.slice(0, rowLevel + 1).join("/")]
} else {
result.columns.push({})
}
} else if (item) {
rowPath[rowLevel] = "" + item.key;
rowItem = getItem(item, "row", rowPath, rowLevel, descriptions.rows[rowLevel]);
columnItem = columnHash[columnPath.slice(0, columnLevel + 1).join("/")]
} else {
result.rows.push({})
}
const currentRowIndex = rowItem && rowItem.index || result.grandTotalRowIndex;
const currentColumnIndex = columnItem && columnItem.index || result.grandTotalColumnIndex;
each(item && item.summary || [], (i, summary) => {
setValue(result.values, summary, currentRowIndex, currentColumnIndex, i)
})
});
return result
}
function getFiltersForDimension(fields) {
return (fields || []).filter(f => f.filterValues && f.filterValues.length || f.searchValue)
}
function getExpandedIndex(options, axis) {
if (options.headerName) {
if (axis === options.headerName) {
return options.path.length
}
if (options.oppositePath) {
return options.oppositePath.length
}
}
return 0
}
function getFiltersForExpandedDimension(options) {
return getFiltersByPath(options[options.headerName], options.path).concat(getFiltersByPath(options["rows" === options.headerName ? "columns" : "rows"], options.oppositePath || []))
}
function getExpandedPathSliceFilter(options, dimensionName, level, firstCollapsedFieldIndex) {
const result = [];
const startSliceIndex = level > firstCollapsedFieldIndex ? 0 : firstCollapsedFieldIndex;
const fields = options.headerName !== dimensionName ? options[dimensionName].slice(startSliceIndex, level) : [];
const paths = "rows" === dimensionName ? options.rowExpandedPaths : options.columnExpandedPaths;
each(fields, (index, field) => {
const filterValues = [];
each(paths, (_, path) => {
path = path.slice(startSliceIndex, level);
if (index < path.length) {
const filterValue = path[index];
if (!filterValues.includes(filterValue)) {
filterValues.push(filterValue)
}
}
});
if (filterValues.length) {
result.push(extend({}, field, {
filterType: "include",
filterValues: filterValues
}))
}
});
return result
}
function getGrandTotalRequest(options, dimensionName, expandedIndex, expandedLevel, commonFilters, firstCollapsedFieldIndex) {
const expandedPaths = ("columns" === dimensionName ? options.columnExpandedPaths : options.rowExpandedPaths) || [];
const oppositeDimensionName = "columns" === dimensionName ? "rows" : "columns";
const fields = options[dimensionName];
const result = [];
let newOptions;
if (expandedPaths.length) {
for (let i = expandedIndex; i < expandedLevel + 1; i += 1) {
newOptions = {
filters: commonFilters.concat(getExpandedPathSliceFilter(options, dimensionName, i, firstCollapsedFieldIndex))
};
newOptions[dimensionName] = fields.slice(expandedIndex, i + 1);
newOptions[oppositeDimensionName] = [];
result.push(extend({}, options, newOptions))
}
} else {
newOptions = {
filters: commonFilters
};
newOptions[dimensionName] = fields.slice(expandedIndex, expandedLevel + 1);
newOptions[oppositeDimensionName] = [];
result.push(extend({}, options, newOptions))
}
result[0].includeTotalSummary = true;
return result
}
function getFirstCollapsedIndex(fields) {
let firstCollapsedIndex = 0;
each(fields, (index, field) => {
if (!field.expanded) {
firstCollapsedIndex = index;
return false
}
return
});
return firstCollapsedIndex
}
function getRequestsData(options) {
const rowExpandedLevel = getExpandedLevel(options, "rows");
const columnExpandedLevel = getExpandedLevel(options, "columns");
let filters = options.filters || [];
const columnExpandedIndex = getExpandedIndex(options, "columns");
const firstCollapsedColumnIndex = getFirstCollapsedIndex(options.columns);
const firstCollapsedRowIndex = getFirstCollapsedIndex(options.rows);
const rowExpandedIndex = getExpandedIndex(options, "rows");
let data = [];
filters = filters.concat(getFiltersForDimension(options.rows)).concat(getFiltersForDimension(options.columns)).concat(getFiltersForExpandedDimension(options));
const columnTotalsOptions = getGrandTotalRequest(options, "columns", columnExpandedIndex, columnExpandedLevel, filters, firstCollapsedColumnIndex);
if (options.rows.length && options.columns.length) {
if ("rows" !== options.headerName) {
data = data.concat(columnTotalsOptions)
}
for (let i = rowExpandedIndex; i < rowExpandedLevel + 1; i += 1) {
const rows = options.rows.slice(rowExpandedIndex, i + 1);
const rowFilterByExpandedPaths = getExpandedPathSliceFilter(options, "rows", i, firstCollapsedRowIndex);
for (let j = columnExpandedIndex; j < columnExpandedLevel + 1; j += 1) {
const preparedOptions = extend({}, options, {
columns: options.columns.slice(columnExpandedIndex, j + 1),
rows: rows,
filters: filters.concat(getExpandedPathSliceFilter(options, "columns", j, firstCollapsedColumnIndex)).concat(rowFilterByExpandedPaths)
});
data.push(preparedOptions)
}
}
} else {
data = options.columns.length ? columnTotalsOptions : getGrandTotalRequest(options, "rows", rowExpandedIndex, rowExpandedLevel, filters, firstCollapsedRowIndex)
}
return data
}
function prepareFields(fields) {
each(fields || [], (_, field) => {
const {
levels: levels
} = field;
if (levels) {
prepareFields(levels)
}
setDefaultFieldValueFormatting(field)
})
}
const RemoteStore = Class.inherit({
ctor(options) {
this._dataSource = new DataSource(options);
this._store = this._dataSource.store()
},
getFields(fields) {
const d = new Deferred;
this._store.load({
skip: 0,
take: 20
}).done(data => {
const normalizedArguments = normalizeLoadResult(data);
d.resolve(pivotGridUtils.discoverObjectFields(normalizedArguments.data, fields))
}).fail(d.reject);
return d
},
key() {
return this._store.key()
},
load(options) {
const that = this;
const d = new Deferred;
const result = {
rows: [],
columns: [],
values: [],
grandTotalRowIndex: 0,
grandTotalColumnIndex: 0,
rowHash: {},
columnHash: {},
rowIndex: 1,
columnIndex: 1
};
const requestsData = getRequestsData(options);
const deferreds = [];
prepareFields(options.rows);
prepareFields(options.columns);
prepareFields(options.filters);
each(requestsData, (_, dataItem) => {
deferreds.push(that._store.load(createLoadOptions(dataItem, that.filter(), options.rows.length)))
});
when.apply(null, deferreds).done((function() {
const args = deferreds.length > 1 ? arguments : [arguments];
each(args, (index, argument) => {
const normalizedArguments = normalizeLoadResult(argument[0], argument[1]);
parseResult(normalizedArguments.data, normalizedArguments.extra, requestsData[index], result)
});
d.resolve({
rows: result.rows,
columns: result.columns,
values: result.values,
grandTotalRowIndex: result.grandTotalRowIndex,
grandTotalColumnIndex: result.grandTotalColumnIndex
})
})).fail(d.reject);
return d
},
filter() {
return this._dataSource.filter.apply(this._dataSource, arguments)
},
supportPaging: () => false,
createDrillDownDataSource(loadOptions, params) {
loadOptions = loadOptions || {};
params = params || {};
const store = this._store;
const filters = getFiltersByPath(loadOptions.rows, params.rowPath).concat(getFiltersByPath(loadOptions.columns, params.columnPath)).concat(getFiltersForDimension(loadOptions.rows)).concat(loadOptions.filters || []).concat(getFiltersForDimension(loadOptions.columns));
const filterExp = createFilterExpressions(filters);
return new DataSource({
load: loadOptions => store.load(extend({}, loadOptions, {
filter: mergeFilters(filterExp, loadOptions.filter),
select: params.customColumns
}))
})
}
});
export default {
RemoteStore: RemoteStore
};
export {
RemoteStore
};