cloudpivot-sheet-filter 1.0.0

package/README.md

@@ -0,0 +1,228 @@
+# cloudpivot-sheet-filter
+
+子表筛选工具，支持多字段、多条件、不同逻辑的筛选操作。
+
+## 适用云枢版本
+
+云枢版本 6.14，应该6版本都兼容。其他版本需自行测试。
+
+## 安装
+
+### 通过 CDN 使用
+
+#### ES 模块方式
+```javascript
+import sheetFilter, { FilterOperators } from 'https://cdn.example.com/cloudpivot-sheet-filter/dist/index.esm.js';
+```
+
+#### IIFE 方式
+```html
+<script src="https://cdn.example.com/cloudpivot-sheet-filter/dist/index.iife.js"></script>
+<script>
+  // 使用全局变量 sheetFilter 和 sheetFilter.FilterOperators
+</script>
+```
+
+## 基本使用
+
+```javascript
+// 导入模块
+import sheetFilter, { FilterOperators } from 'cloudpivot-sheet-filter';
+
+// 子表筛选定义
+var sheetF = null;
+
+// 子表筛选类实例化
+sheetF = new sheetFilter();
+
+// 添加筛选条件：检结果等于NG
+// 第一个参数 'Radio1719304490857' 是子表内的控件的编码
+sheetF.addFilter('Radio1719304490857', FilterOperators.EQ, 'NG');
+
+// 启用筛选
+// 第一个参数 this.Sheet1719303475853 是子表的对象
+sheetF.filter(this.Sheet1719303475853, true);
+
+// 关闭筛选
+// sheetF.filter(this.Sheet1719303475853, false);
+```
+
+## 高级用法
+
+### 预筛选与应用筛选
+
+使用预筛选方法可以在不修改子表的情况下检查筛选结果，适合用于控制UI元素的显示状态。
+
+```javascript
+// 添加筛选条件
+sheetF.addFilter('Radio1719304490857', FilterOperators.EQ, 'NG');
+
+// 预筛选，获取筛选结果但不修改子表
+const previewResult = sheetF.previewFilter(this.Sheet1719303475853);
+
+// 根据预筛选结果控制switch开关的可见性
+if (previewResult !== null) {
+  // 有筛选结果，显示switch开关
+  showFilterSwitch(true);
+  
+  // 用户点击switch开关时应用筛选
+  applyFilterButton.onclick = () => {
+    sheetF.applyFilter(this.Sheet1719303475853, previewResult);
+  };
+} else {
+  // 无筛选结果，隐藏switch开关或禁用
+  showFilterSwitch(false);
+  alert('当前筛选条件无匹配结果，无法进行筛选操作');
+}
+```
+
+### 多条件筛选
+
+```javascript
+// 链式调用添加多个筛选条件
+// 每个 addFilter 的第一个参数都是子表内的控件的编码
+sheetF
+  .addFilter('Radio1719304490857', FilterOperators.EQ, 'NG')  // 控件编码：Radio1719304490857
+  .addFilter('Number1719304500123', FilterOperators.GT, 100)  // 控件编码：Number1719304500123
+  .addFilter('Date1719304510456', FilterOperators.LTE, new Date());  // 控件编码：Date1719304510456
+```
+
+### 设置筛选逻辑
+
+```javascript
+// 设置 AND 逻辑（默认）
+sheetF.setAndLogic();
+
+// 设置 OR 逻辑
+sheetF.setOrLogic();
+
+// 获取当前筛选逻辑
+const logic = sheetF.getLogic();
+console.log('当前筛选逻辑:', logic); // 'AND' 或 'OR'
+```
+
+### 清除筛选条件
+
+```javascript
+// 清除所有筛选条件
+sheetF.clearFilters();
+```
+
+### 检查筛选状态
+
+```javascript
+// 检查是否已筛选
+const isFiltered = sheetF.isFiltered();
+console.log('是否已筛选:', isFiltered); // true 或 false
+```
+
+## 操作符说明
+
+| 操作符 | 描述 | 值 |
+|-------|------|----|
+| FilterOperators.EQ | 等于 | 'eq' |
+| FilterOperators.NEQ | 不等于 | 'neq' |
+| FilterOperators.LT | 小于 | 'lt' |
+| FilterOperators.LTE | 小于等于 | 'lte' |
+| FilterOperators.GT | 大于 | 'gt' |
+| FilterOperators.GTE | 大于等于 | 'gte' |
+
+## API 文档
+
+### sheetFilter 类
+
+#### 构造函数
+```javascript
+const sheetF = new sheetFilter();
+```
+
+#### 方法
+
+##### setAndLogic()
+设置筛选逻辑为 AND（默认）。
+
+##### setOrLogic()
+设置筛选逻辑为 OR。
+
+##### getLogic()
+返回当前筛选逻辑，'AND' 或 'OR'。
+
+##### isFiltered()
+返回筛选状态，true 表示已筛选，false 表示未筛选。
+
+##### clearFilters()
+清除所有筛选条件。
+
+##### addFilter(columnKey, operator, value)
+添加筛选条件。
+- `columnKey`: 子表内的控件的编码（字符串）
+- `operator`: 操作符（字符串或 FilterOperators 常量）
+- `value`: 筛选值（任意类型）
+- 返回值：当前实例，支持链式调用
+
+##### filter(key, enable)
+执行筛选操作。
+- `key`: 子表的对象
+- `enable`: true 启用筛选，false 关闭筛选
+
+##### previewFilter(key)
+预筛选子表，获取筛选结果但不修改子表对象。
+- `key`: 子表的对象
+- 返回值：筛选结果 `{ index: [], value: [] }` 或 `null`（无匹配结果）
+
+##### applyFilter(key, filteredList)
+应用筛选，根据预筛选结果修改子表对象。
+- `key`: 子表的对象
+- `filteredList`: 预筛选结果（可选，如果不提供则自动执行预筛选）
+- 返回值：`true` 成功应用筛选，`false` 筛选失败
+
+##### cancelFilter(key)
+取消筛选，恢复原始子表数据。
+- `key`: 子表的对象
+- 返回值：`true` 成功取消筛选，`false` 取消失败
+
+## 完整示例
+
+```javascript
+// 导入模块
+import sheetFilter, { FilterOperators } from 'cloudpivot-sheet-filter';
+
+// 实例化
+const sheetF = new sheetFilter();
+
+// 设置筛选逻辑为 OR
+sheetF.setOrLogic();
+
+// 添加多个筛选条件
+// 第一个参数都是子表内的控件的编码
+sheetF
+  .addFilter('Radio1719304490857', FilterOperators.EQ, 'NG')  // 控件编码：Radio1719304490857
+  .addFilter('Number1719304500123', FilterOperators.GT, 100);  // 控件编码：Number1719304500123
+
+// 启用筛选
+// 第一个参数 this.Sheet1719303475853 是子表的对象
+sheetF.filter(this.Sheet1719303475853, true);
+
+// 检查筛选状态
+console.log('是否已筛选:', sheetF.isFiltered());
+
+// 稍后关闭筛选
+setTimeout(() => {
+  // 第一个参数 this.Sheet1719303475853 是子表的对象
+  sheetF.filter(this.Sheet1719303475853, false);
+  console.log('筛选已关闭');
+}, 5000);
+```
+
+## 注意事项
+
+1. 筛选操作会修改原始子表数据，关闭筛选时会恢复原始数据。
+2. 支持的数据类型包括字符串、数字、日期等。
+3. 操作符大小写敏感，但建议使用 FilterOperators 常量以确保正确性。
+4. 当筛选逻辑为 AND 时，所有条件必须同时满足；当筛选逻辑为 OR 时，只要满足任一条件即可。
+
+## 浏览器兼容性
+
+- 支持所有现代浏览器
+- 支持 ES6+ 环境
+- 支持通过 CDN 直接使用

package/dist/index.cjs

@@ -0,0 +1 @@
+var n=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var g=Object.getOwnPropertyNames;var v=Object.prototype.hasOwnProperty;var d=(o,e)=>{for(var t in e)n(o,t,{get:e[t],enumerable:!0})},p=(o,e,t,l)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of g(e))!v.call(o,s)&&s!==t&&n(o,s,{get:()=>e[s],enumerable:!(l=c(e,s))||l.enumerable});return o};var b=o=>p(n({},"__esModule",{value:!0}),o);var L={};d(L,{FilterOperators:()=>w,default:()=>F});module.exports=b(L);var f=class{#t;#e;#l;#i;#s;constructor(){this.#t=[],this.#e={index:[],value:[]},this.#l=[],this.setAndLogic(),this.#s=!1}setAndLogic(){this.#i="AND"}setOrLogic(){this.#i="OR"}getLogic(){return this.#i}isFiltered(){return this.#s}clearFilters(){this.#l=[]}addFilter(e,t,l){return this.#l.push({columnKey:e,operator:t,value:l}),this}#r(e){let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!0;for(let h=0;h<this.#l.length;h++){let{columnKey:r,operator:u,value:a}=this.#l[h];switch(u){case"eq":s[r]!=a&&(i=!1);break;case"neq":s[r]==a&&(i=!1);break;case"lt":s[r]<a||(i=!1);break;case"lte":s[r]<=a||(i=!1);break;case"gt":s[r]>a||(i=!1);break;case"gte":s[r]>=a||(i=!1);break;default:throw new Error(`Unsupported operator: ${u}`)}if(!i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}#a(e){console.log("filterOr");let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!1;for(let h=0;h<this.#l.length;h++){let{columnKey:r,operator:u,value:a}=this.#l[h];switch(u){case"eq":s[r]==a&&(i=!0);break;case"neq":s[r]!=a&&(i=!0);break;case"lt":s[r]<a&&(i=!0);break;case"lte":s[r]<=a&&(i=!0);break;case"gt":s[r]>a&&(i=!0);break;case"gte":s[r]>=a&&(i=!0);break;default:throw new Error(`Unsupported operator: ${u}`)}if(i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}previewFilter(e){return this.getLogic()=="AND"?this.#r(e):this.#a(e)}applyFilter(e,t=null){return this.isFiltered()||(t===null&&(t=this.previewFilter(e)),t===null)?!1:(console.log("applyFilter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=t,console.log("this.#filteredList",this.#e),e.removeAllRow(),e.value=this.#e.value,this.#s=!0,console.log("key.value",e.value),!0)}cancelFilter(e){if(!this.isFiltered())return!1;if(this.#e.value.length>0){console.log("cancelFilter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let t=this.sheetValueSafeCopy(e.value);for(let l=0;l<t.length;l++)l+1<=this.#e.value.length?this.#t[this.#e.index[l]]=t[l]:this.#t.push(t[l]);return e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value),!0}return!1}filter(e,t){debugger;if(t){if(this.isFiltered())return;console.log("filter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=this.getLogic()=="AND"?this.#r(e):this.#a(e),console.log("this.#filteredList",this.#e),this.#e!=null&&(e.removeAllRow(),e.value=this.#e.value,this.#s=!0),console.log("key.value",e.value)}else{if(!this.isFiltered())return;if(this.#e.value.length>0){console.log("filter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let l=this.sheetValueSafeCopy(e.value);for(let s=0;s<l.length;s++)s+1<=this.#e.value.length?this.#t[this.#e.index[s]]=l[s]:this.#t.push(l[s]);e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value)}}}sheetValueSafeCopy(e){let t=e;for(let l=0;l<t.length;l++)delete t[l].rowStatus,delete t[l].id;return t}},w={EQ:"eq",NEQ:"neq",LT:"lt",LTE:"lte",GT:"gt",GTE:"gte"},F=f;

package/dist/index.esm.js

@@ -0,0 +1 @@
+var u=class{#t;#e;#l;#i;#s;constructor(){this.#t=[],this.#e={index:[],value:[]},this.#l=[],this.setAndLogic(),this.#s=!1}setAndLogic(){this.#i="AND"}setOrLogic(){this.#i="OR"}getLogic(){return this.#i}isFiltered(){return this.#s}clearFilters(){this.#l=[]}addFilter(e,t,l){return this.#l.push({columnKey:e,operator:t,value:l}),this}#r(e){let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!0;for(let o=0;o<this.#l.length;o++){let{columnKey:r,operator:h,value:a}=this.#l[o];switch(h){case"eq":s[r]!=a&&(i=!1);break;case"neq":s[r]==a&&(i=!1);break;case"lt":s[r]<a||(i=!1);break;case"lte":s[r]<=a||(i=!1);break;case"gt":s[r]>a||(i=!1);break;case"gte":s[r]>=a||(i=!1);break;default:throw new Error(`Unsupported operator: ${h}`)}if(!i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}#a(e){console.log("filterOr");let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!1;for(let o=0;o<this.#l.length;o++){let{columnKey:r,operator:h,value:a}=this.#l[o];switch(h){case"eq":s[r]==a&&(i=!0);break;case"neq":s[r]!=a&&(i=!0);break;case"lt":s[r]<a&&(i=!0);break;case"lte":s[r]<=a&&(i=!0);break;case"gt":s[r]>a&&(i=!0);break;case"gte":s[r]>=a&&(i=!0);break;default:throw new Error(`Unsupported operator: ${h}`)}if(i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}previewFilter(e){return this.getLogic()=="AND"?this.#r(e):this.#a(e)}applyFilter(e,t=null){return this.isFiltered()||(t===null&&(t=this.previewFilter(e)),t===null)?!1:(console.log("applyFilter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=t,console.log("this.#filteredList",this.#e),e.removeAllRow(),e.value=this.#e.value,this.#s=!0,console.log("key.value",e.value),!0)}cancelFilter(e){if(!this.isFiltered())return!1;if(this.#e.value.length>0){console.log("cancelFilter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let t=this.sheetValueSafeCopy(e.value);for(let l=0;l<t.length;l++)l+1<=this.#e.value.length?this.#t[this.#e.index[l]]=t[l]:this.#t.push(t[l]);return e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value),!0}return!1}filter(e,t){debugger;if(t){if(this.isFiltered())return;console.log("filter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=this.getLogic()=="AND"?this.#r(e):this.#a(e),console.log("this.#filteredList",this.#e),this.#e!=null&&(e.removeAllRow(),e.value=this.#e.value,this.#s=!0),console.log("key.value",e.value)}else{if(!this.isFiltered())return;if(this.#e.value.length>0){console.log("filter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let l=this.sheetValueSafeCopy(e.value);for(let s=0;s<l.length;s++)s+1<=this.#e.value.length?this.#t[this.#e.index[s]]=l[s]:this.#t.push(l[s]);e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value)}}}sheetValueSafeCopy(e){let t=e;for(let l=0;l<t.length;l++)delete t[l].rowStatus,delete t[l].id;return t}},f={EQ:"eq",NEQ:"neq",LT:"lt",LTE:"lte",GT:"gt",GTE:"gte"},c=u;export{f as FilterOperators,c as default};

package/dist/index.iife.js

@@ -0,0 +1 @@
+var sheetFilter=(()=>{var n=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var g=Object.getOwnPropertyNames;var v=Object.prototype.hasOwnProperty;var d=(o,e)=>{for(var t in e)n(o,t,{get:e[t],enumerable:!0})},p=(o,e,t,l)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of g(e))!v.call(o,s)&&s!==t&&n(o,s,{get:()=>e[s],enumerable:!(l=c(e,s))||l.enumerable});return o};var b=o=>p(n({},"__esModule",{value:!0}),o);var L={};d(L,{FilterOperators:()=>w,default:()=>F});var f=class{#t;#e;#l;#i;#s;constructor(){this.#t=[],this.#e={index:[],value:[]},this.#l=[],this.setAndLogic(),this.#s=!1}setAndLogic(){this.#i="AND"}setOrLogic(){this.#i="OR"}getLogic(){return this.#i}isFiltered(){return this.#s}clearFilters(){this.#l=[]}addFilter(e,t,l){return this.#l.push({columnKey:e,operator:t,value:l}),this}#r(e){let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!0;for(let h=0;h<this.#l.length;h++){let{columnKey:r,operator:u,value:a}=this.#l[h];switch(u){case"eq":s[r]!=a&&(i=!1);break;case"neq":s[r]==a&&(i=!1);break;case"lt":s[r]<a||(i=!1);break;case"lte":s[r]<=a||(i=!1);break;case"gt":s[r]>a||(i=!1);break;case"gte":s[r]>=a||(i=!1);break;default:throw new Error(`Unsupported operator: ${u}`)}if(!i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}#a(e){console.log("filterOr");let t={index:[],value:[]};for(let l=0;l<e.value.length;l++){let s=e.rows[l].value,i=!1;for(let h=0;h<this.#l.length;h++){let{columnKey:r,operator:u,value:a}=this.#l[h];switch(u){case"eq":s[r]==a&&(i=!0);break;case"neq":s[r]!=a&&(i=!0);break;case"lt":s[r]<a&&(i=!0);break;case"lte":s[r]<=a&&(i=!0);break;case"gt":s[r]>a&&(i=!0);break;case"gte":s[r]>=a&&(i=!0);break;default:throw new Error(`Unsupported operator: ${u}`)}if(i)break}i&&(t.index.push(l),t.value.push(s))}return t.value.length>0?t:null}previewFilter(e){return this.getLogic()=="AND"?this.#r(e):this.#a(e)}applyFilter(e,t=null){return this.isFiltered()||(t===null&&(t=this.previewFilter(e)),t===null)?!1:(console.log("applyFilter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=t,console.log("this.#filteredList",this.#e),e.removeAllRow(),e.value=this.#e.value,this.#s=!0,console.log("key.value",e.value),!0)}cancelFilter(e){if(!this.isFiltered())return!1;if(this.#e.value.length>0){console.log("cancelFilter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let t=this.sheetValueSafeCopy(e.value);for(let l=0;l<t.length;l++)l+1<=this.#e.value.length?this.#t[this.#e.index[l]]=t[l]:this.#t.push(t[l]);return e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value),!0}return!1}filter(e,t){debugger;if(t){if(this.isFiltered())return;console.log("filter enable"),this.#t=this.sheetValueSafeCopy(e.value),console.log("this.#beforeList",this.#t),this.#e=this.getLogic()=="AND"?this.#r(e):this.#a(e),console.log("this.#filteredList",this.#e),this.#e!=null&&(e.removeAllRow(),e.value=this.#e.value,this.#s=!0),console.log("key.value",e.value)}else{if(!this.isFiltered())return;if(this.#e.value.length>0){console.log("filter disable"),console.log("this.#beforeList",this.#t),console.log("before key.value",e.value);let l=this.sheetValueSafeCopy(e.value);for(let s=0;s<l.length;s++)s+1<=this.#e.value.length?this.#t[this.#e.index[s]]=l[s]:this.#t.push(l[s]);e.removeAllRow(),e.value=this.#t,this.#s=!1,console.log("after key.value",e.value)}}}sheetValueSafeCopy(e){let t=e;for(let l=0;l<t.length;l++)delete t[l].rowStatus,delete t[l].id;return t}},w={EQ:"eq",NEQ:"neq",LT:"lt",LTE:"lte",GT:"gt",GTE:"gte"},F=f;return b(L);})();

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "cloudpivot-sheet-filter",
+  "version": "1.0.0",
+  "description": "子表筛选工具 - Cloudpivot子表筛选解决方案",
+  "main": "dist/index.cjs",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.esm.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "esbuild src/index.js --bundle --outfile=dist/index.cjs --format=cjs --minify && esbuild src/index.js --bundle --outfile=dist/index.esm.js --format=esm --minify && esbuild src/index.js --bundle --outfile=dist/index.iife.js --format=iife --global-name=sheetFilter --minify",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["cloudpivot", "sheet", "filter", "esm"],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "esbuild": "^0.20.0"
+  }
+}