devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
366 lines (363 loc) • 15.2 kB
JavaScript
/**
* DevExtreme (esm/ui/pivot_grid/ui.pivot_grid.field_chooser_base.js)
* Version: 21.1.4
* Build date: Mon Jun 21 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import $ from "../../core/renderer";
import eventsEngine from "../../events/core/events_engine";
import ArrayStore from "../../data/array_store";
import {
name as clickEventName
} from "../../events/click";
import {
noop
} from "../../core/utils/common";
import {
isDefined
} from "../../core/utils/type";
import {
inArray
} from "../../core/utils/array";
import {
extend
} from "../../core/utils/extend";
import {
each,
map
} from "../../core/utils/iterator";
import localizationMessage from "../../localization/message";
import registerComponent from "../../core/component_registrator";
import Widget from "../widget/ui.widget";
import {
HeaderFilterView as HeaderFilterViewBase,
updateHeaderFilterItemSelectionState,
headerFilterMixin
} from "../grid_core/ui.grid_core.header_filter_core";
import columnStateMixin from "../grid_core/ui.grid_core.column_state_mixin";
import sortingMixin from "../grid_core/ui.grid_core.sorting_mixin";
import {
foreachTree,
createPath
} from "./ui.pivot_grid.utils";
import Sortable from "./ui.sortable";
import {
Deferred
} from "../../core/utils/deferred";
var IE_FIELD_WIDTH_CORRECTION = 1;
var DIV = "<div>";
var HeaderFilterView = HeaderFilterViewBase.inherit({
_getSearchExpr: function(options) {
options.useDefaultSearchExpr = true;
return this.callBase(options)
}
});
var processItems = function(groupItems, field) {
var filterValues = [];
var isTree = !!field.groupName;
var isExcludeFilterType = "exclude" === field.filterType;
if (field.filterValues) {
each(field.filterValues, (function(_, filterValue) {
filterValues.push(Array.isArray(filterValue) ? filterValue.join("/") : filterValue && filterValue.valueOf())
}))
}
foreachTree(groupItems, (function(items) {
var item = items[0];
var path = createPath(items);
var preparedFilterValueByText = isTree ? map(items, (function(item) {
return item.text
})).reverse().join("/") : item.text;
item.value = isTree ? path.slice(0) : item.key || item.value;
var preparedFilterValue = isTree ? path.join("/") : item.value && item.value.valueOf();
if (item.children) {
item.items = item.children;
item.children = null
}
updateHeaderFilterItemSelectionState(item, item.key && inArray(preparedFilterValueByText, filterValues) > -1 || inArray(preparedFilterValue, filterValues) > -1, isExcludeFilterType)
}))
};
function getMainGroupField(dataSource, sourceField) {
var field = sourceField;
if (isDefined(sourceField.groupIndex)) {
field = dataSource.getAreaFields(sourceField.area, true)[sourceField.areaIndex]
}
return field
}
function getStringState(state) {
state = state || {};
return JSON.stringify([state.fields, state.columnExpandedPaths, state.rowExpandedPaths])
}
var FieldChooserBase = Widget.inherit(columnStateMixin).inherit(sortingMixin).inherit(headerFilterMixin).inherit({
_getDefaultOptions: function() {
return extend(this.callBase(), {
allowFieldDragging: true,
applyChangesMode: "instantly",
state: null,
headerFilter: {
width: 252,
height: 325,
searchTimeout: 500,
texts: {
emptyValue: localizationMessage.format("dxDataGrid-headerFilterEmptyValue"),
ok: localizationMessage.format("dxDataGrid-headerFilterOK"),
cancel: localizationMessage.format("dxDataGrid-headerFilterCancel")
}
}
})
},
_init: function() {
this.callBase();
this._headerFilterView = new HeaderFilterView(this);
this._refreshDataSource();
this.subscribeToEvents()
},
_refreshDataSource: function() {
var dataSource = this.option("dataSource");
if (dataSource && dataSource.fields && dataSource.load) {
this._dataSource = dataSource
}
},
_optionChanged: function(args) {
switch (args.name) {
case "dataSource":
this._refreshDataSource();
break;
case "applyChangesMode":
break;
case "state":
if (this._skipStateChange || !this._dataSource) {
break
}
if ("instantly" === this.option("applyChangesMode") && getStringState(this._dataSource.state()) !== getStringState(args.value)) {
this._dataSource.state(args.value)
} else {
this._clean(true);
this._renderComponent()
}
break;
case "headerFilter":
case "allowFieldDragging":
this._invalidate();
break;
default:
this.callBase(args)
}
},
renderField: function(field, showColumnLines) {
var $fieldContent = $(DIV).addClass("dx-area-field-content").text(field.caption || field.dataField);
var $fieldElement = $(DIV).addClass("dx-area-field").addClass("dx-area-box").data("field", field).append($fieldContent);
var mainGroupField = getMainGroupField(this._dataSource, field);
if ("data" !== field.area) {
if (field.allowSorting) {
this._applyColumnState({
name: "sort",
rootElement: $fieldElement,
column: {
alignment: this.option("rtlEnabled") ? "right" : "left",
sortOrder: "desc" === field.sortOrder ? "desc" : "asc"
},
showColumnLines: showColumnLines
})
}
this._applyColumnState({
name: "headerFilter",
rootElement: $fieldElement,
column: {
alignment: this.option("rtlEnabled") ? "right" : "left",
filterValues: mainGroupField.filterValues,
allowFiltering: mainGroupField.allowFiltering && !field.groupIndex
},
showColumnLines: showColumnLines
})
}
if (field.groupName) {
$fieldElement.attr("item-group", field.groupName)
}
return $fieldElement
},
_clean: function() {},
_render: function() {
this.callBase();
this._headerFilterView.render(this.$element())
},
renderSortable: function() {
var that = this;
that._createComponent(that.$element(), Sortable, extend({
allowDragging: that.option("allowFieldDragging"),
itemSelector: ".dx-area-field",
itemContainerSelector: ".dx-area-field-container",
groupSelector: ".dx-area-fields",
groupFilter: function() {
var dataSource = that._dataSource;
var $sortable = $(this).closest(".dx-sortable-old");
var pivotGrid = $sortable.data("dxPivotGrid");
var pivotGridFieldChooser = $sortable.data("dxPivotGridFieldChooser");
if (pivotGrid) {
return pivotGrid.getDataSource() === dataSource
}
if (pivotGridFieldChooser) {
return pivotGridFieldChooser.option("dataSource") === dataSource
}
return false
},
itemRender: function($sourceItem, target) {
var $item;
if ($sourceItem.hasClass("dx-area-box")) {
$item = $sourceItem.clone();
if ("drag" === target) {
each($sourceItem, (function(index, sourceItem) {
$item.eq(index).css("width", parseInt($(sourceItem).outerWidth(), 10) + IE_FIELD_WIDTH_CORRECTION)
}))
}
} else {
$item = $(DIV).addClass("dx-area-field").addClass("dx-area-box").text($sourceItem.text())
}
if ("drag" === target) {
var wrapperContainer = $(DIV);
each($item, (function(_, item) {
var wrapper = $("<div>").addClass("dx-pivotgrid-fields-container").addClass("dx-widget").append($(item));
wrapperContainer.append(wrapper)
}));
return wrapperContainer.children()
}
return $item
},
onDragging: function(e) {
var field = e.sourceElement.data("field");
var targetGroup = e.targetGroup;
e.cancel = false;
if (true === field.isMeasure) {
if ("column" === targetGroup || "row" === targetGroup || "filter" === targetGroup) {
e.cancel = true
}
} else if (false === field.isMeasure && "data" === targetGroup) {
e.cancel = true
}
},
useIndicator: true,
onChanged: function(e) {
var dataSource = that._dataSource;
var field = e.sourceElement.data("field");
e.removeSourceElement = !!e.sourceGroup;
that._adjustSortableOnChangedArgs(e);
if (field) {
that._applyChanges([getMainGroupField(dataSource, field)], {
area: e.targetGroup,
areaIndex: e.targetIndex
})
}
}
}, that._getSortableOptions()))
},
_processDemandState: function(func) {
var isInstantlyMode = "instantly" === this.option("applyChangesMode");
var dataSource = this._dataSource;
if (isInstantlyMode) {
func(dataSource, isInstantlyMode)
} else {
var currentState = dataSource.state();
var pivotGridState = this.option("state");
if (pivotGridState) {
dataSource.state(pivotGridState, true)
}
func(dataSource, isInstantlyMode);
dataSource.state(currentState, true)
}
},
_applyChanges(fields, props) {
var that = this;
that._processDemandState((function(dataSource, isInstantlyMode) {
fields.forEach(_ref => {
var {
index: index
} = _ref;
dataSource.field(index, props)
});
if (isInstantlyMode) {
dataSource.load()
} else {
that._changedHandler()
}
}))
},
_adjustSortableOnChangedArgs: function(e) {
e.removeSourceElement = false;
e.removeTargetElement = true;
e.removeSourceClass = false
},
_getSortableOptions: function() {
return {
direction: "auto"
}
},
subscribeToEvents: function(element) {
var that = this;
var func = function(e) {
var field = $(e.currentTarget).data("field");
var mainGroupField = extend(true, {}, getMainGroupField(that._dataSource, field));
var isHeaderFilter = $(e.target).hasClass("dx-header-filter");
var dataSource = that._dataSource;
var type = mainGroupField.groupName ? "tree" : "list";
var paginate = dataSource.paginate() && "list" === type;
if (isHeaderFilter) {
that._headerFilterView.showHeaderFilterMenu($(e.currentTarget), extend(mainGroupField, {
type: type,
encodeHtml: that.option("encodeHtml"),
dataSource: {
useDefaultSearch: !paginate,
load: function(options) {
var userData = options.userData;
if (userData.store) {
return userData.store.load(options)
} else {
var d = new Deferred;
dataSource.getFieldValues(mainGroupField.index, that.option("headerFilter.showRelevantValues"), paginate ? options : void 0).done((function(data) {
var emptyValue = that.option("headerFilter.texts.emptyValue");
data.forEach(element => {
if (!element.text) {
element.text = emptyValue
}
});
if (paginate) {
d.resolve(data)
} else {
userData.store = new ArrayStore(data);
userData.store.load(options).done(d.resolve).fail(d.reject)
}
})).fail(d.reject);
return d
}
},
postProcess: function(data) {
processItems(data, mainGroupField);
return data
}
},
apply: function() {
that._applyChanges([mainGroupField], {
filterValues: this.filterValues,
filterType: this.filterType
})
}
}))
} else if (field.allowSorting && "data" !== field.area) {
that._applyChanges([field], {
sortOrder: "desc" === field.sortOrder ? "asc" : "desc"
})
}
};
if (element) {
eventsEngine.on(element, clickEventName, ".dx-area-field.dx-area-box", func);
return
}
eventsEngine.on(that.$element(), clickEventName, ".dx-area-field.dx-area-box", func)
},
_initTemplates: noop,
addWidgetPrefix: function(className) {
return "dx-pivotgrid-" + className
}
});
registerComponent("dxPivotGridFieldChooserBase", FieldChooserBase);
export default FieldChooserBase;