WTableDyn

Props

Name Type Default value Required? Description
pathItems Array ['base:w-table-vue'] No 輸入w-table-vue組件js檔案位置字串陣列,w-aggrid-vue與ag-grid皆已打包於w-table-vue內故無須另行載入,預設['base:w-table-vue']
language String 'en' No 輸入指定語系字串,可選'en'、'zh-tw'、'zh-cn',可被opt.language複寫,預設為'en'
enableInfor Boolean true No 輸入是否使用資訊區(資料名稱name與資料描述description)布林值,預設為true
name String '' No 輸入資料名稱字串,預設''
description String '' No 輸入資料描述字串,預設''
inforPaddingStyle Object {v:0,h:0} No 輸入資訊區(資料名稱name與資料描述description)內寬距離物件,可用鍵值為v、h、left、right、top、bottom,v代表同時設定top與bottom,h代表設定left與right,若有重複設定時後面鍵值會覆蓋前面,各鍵值為寬度數字,單位為px,預設{v:0,h:0}
enableMenu Boolean true No 輸入是否使用選單按鈕區布林值,預設為true
menuPaddingStyle Object {v:3,h:3} No 輸入選單按鈕區內寬距離物件,可用鍵值為v、h、left、right、top、bottom,v代表同時設定top與bottom,h代表設定left與right,若有重複設定時後面鍵值會覆蓋前面,各鍵值為寬度數字,單位為px,預設{v:3,h:3}
menuBackgroundColor String 'transparent' No 輸入選單按鈕區背景顏色字串,預設'transparent'
sortColIds String|Array '' No 輸入初始化時自動排序數據的欄位,為字串或陣列,若輸入陣列時則依照順序排序,故最末者代表最終排序。預設''
hideIds String|Array '' No 輸入欲隱藏欄位字串或陣列,可被opt.kpHeadHide複寫,預設''
fixIds String|Array '' No 輸入欲固定於左側欄位字串或陣列,可被opt.kpHeadFixLeft複寫,預設''
checkId String '' No 輸入欲使用核選方塊欄位字串,可被opt.kpHeadCheckBox複寫,預設''
removeIdsWhenDownload String|Array '' No 輸入下載Excel檔案時欲移除的欄位字串或陣列,作用於下載數據與下載過濾後數據,移除後無任何欄位時觸發error事件且不產生檔案,預設''
funGetLtdtHookWhenDownload function null No 輸入下載Excel檔案時針對ltdt數據階段的攔截處理函數,輸入為各列數據陣列(為副本,值已依useCellFormatWhenDownload格式化),無數據列時輸入為空陣列,須同步回傳處理後之數據陣列(不支援Promise)且各列皆為非空物件,回傳空陣列時只輸出表頭列,回傳不合約定或函數拋錯時觸發error事件且不產生檔案,預設為null
funGetMatHookWhenDownload function null No 輸入下載Excel檔案時針對mat數據階段的攔截處理函數,輸入為首列為表頭之二維陣列(已經funGetLtdtHookWhenDownload處理),須同步回傳處理後之二維陣列(不支援Promise)且至少一列非空,無數據列且funGetLtdtHookWhenDownload未加入數據時只含表頭1列,回傳不合約定或函數拋錯時觸發error事件且不產生檔案,預設為null
useHeadWhenDownload Boolean false No 輸入下載Excel檔案時是否將欄位鍵值轉換成head布林值,此需提供opt.kpHead物件,若欲將下載之檔案填寫後上傳回來,須以opt.kpConvertKeysWhenUploadData將表頭名稱對回欄位鍵值,且opt.kpHead之名稱須非空且不重複,預設為false
useCellFormatWhenDownload Boolean true No 輸入下載Excel檔案時是否依opt.kpCellFormat格式化各欄值布林值,true時下載內容與畫面一致(有格式化函數之欄為格式化後字串),false時下載原值,無opt.kpCellFormat時無作用,轉發至w-table-vue(對應w-aggrid-vue之downloadData與downloadDisplayData之useFormat),預設為true
fileNameWhenDownload String 'data.xlsx' No 輸入下載Excel檔案時儲存檔名稱字串,無副檔名時自動補'.xlsx',預設'data.xlsx'
sheetNameWhenDownload String 'data' No 輸入下載Excel檔案時sheet名稱字串,須符合Excel分頁名稱規則(至多31字且表情符號等計2字、不含[ ] : * ? / \、首尾非單引號、非History),不符時改用'data',預設'data'
editable Boolean false No 輸入是否可編輯布林值,可被opt.defCellEditable複寫,預設為false
textLabelDataName String 'Data name:' No 輸入數據名稱字串,預設'Data name:'
textPlaceholderDataName String 'Please enter data name' No 輸入數據名稱placeholder字串,預設'Please enter data name'
textLabelDataDescription String 'Data description:' No 輸入數據說明字串,預設'Data description:'
textPlaceholderDataDescription String 'Please enter data description' No 輸入數據說明placeholder字串,預設'Please enter data description'
tooltipAddRow String 'add new row' No 輸入新增數據按鈕tooltip字串,預設'add new row'
tooltipDeleteSelectedRows String 'delete selected rows' No 輸入刪除選擇數據按鈕tooltip字串,預設'delete selected rows'
tooltipDownloadExcelFile String 'download data to Excel file' No 輸入下載數據成為Excel檔案按鈕tooltip字串,預設'download data to Excel file'
tooltipDownloadExcelFileForDisplay String 'download filtered data to Excel file' No 輸入下載過濾後數據成為Excel檔案按鈕tooltip字串,預設'download filtered data to Excel file'
tooltipDownloadExcelFileForHead String 'download headers to Excel file' No 輸入無數據列時下載數據按鈕之tooltip字串,下載數據按鈕於編輯與顯示模式皆一律顯示,無數據列(表格主數據列為0列,即opt.rows為空陣列或數據列已全部刪除,不含置頂置底列)時按下載只有表頭1列之Excel檔案,表頭依opt.keys之順序並套用removeIdsWhenDownload與useHeadWhenDownload,與有數據時所下載檔案之第1列相同,可供使用者填寫後上傳,此時改用本提示文字;不影響下載過濾後數據按鈕;給予空字串則不顯示tooltip,已自訂tooltipDownloadExcelFile語系之呼叫端應一併給予,轉發至w-table-vue,預設'download headers to Excel file'
tooltipUploadExcelFile String 'upload data to Excel file' No 輸入上傳Excel數據檔案按鈕tooltip字串,預設'upload data to Excel file'
successMsgFromAddRow String 'add row successfully' No 輸入新增數據成功事件訊息字串,預設'add row successfully'
errorMsgFromAddRow String 'can not add row' No 輸入無法新增數據事件訊息字串,預設'can not add row'
errorMsgFromRemoveRow String 'can not remove selected rows' No 輸入移除數據失敗事件訊息字串,預設'can not remove selected rows'
successMsgFromUploadData String 'upload data successfully' No 輸入上傳數據成功事件訊息字串,預設'upload data successfully'
errorMsgFromUploadData String 'can not upload data' No 輸入無法上傳數據事件訊息字串,例如非Excel檔案、指定之sheet不存在、opt.optForUploadData.beforeUpload拋錯或回傳不合約定(原因記錄於console),此時不變動表格數據,預設'can not upload data'
errorMsgFromUploadEmptyData String 'no effective data' No 輸入上傳檔案中無有效數據事件訊息字串,即上傳處理後無數據列,或各列於表格欄位之值皆為空(含檔案表頭與表格欄位不符),此時不變動表格數據,預設'no effective data'
successMsgFromDownloadData String 'download data successfully' No 輸入下載檔案成功事件訊息字串,預設'download data successfully'
errorMsgFromDownloadData String 'can not download data' No 輸入無法下載檔案事件訊息字串,例如移除後無任何欄位、下載掛鉤回傳不合約定或拋錯(原因記錄於console),此時不產生檔案,預設'can not download data'
errorMsgFromNoName String 'no data name' No 輸入未輸入數據名稱事件訊息字串,預設'no data name'
errorMsgFromNoData String 'no data' No 輸入未給予有效數據事件訊息字串,預設'no data'
uploadModeTitle String 'Choose mode of upload:' No 輸入選擇上傳模式彈窗標題字串,opt.optForUploadData.uploadMode有預先指定時不顯示此彈窗,預設'Choose mode of upload:'
uploadModeTextForReplace String 'Replace' No 輸入取代上傳模式文字字串,預設'Replace'
uploadModeTextForAppend String 'Append' No 輸入插入於最後上傳模式文字字串,預設'Append'
labelContentForUpload String null No 輸入針對上傳模式之popup彈窗teleport至body內之內容div所給予之wtlp屬性值字串,供查找使用,預設null
cmpZIndex Number 3000 No 輸入彈窗使用z-index數字,供嵌於高z-index彈窗內時提高層級,預設3000
opt Object null No 輸入w-aggrid-vue設定物件,預設null
opt.keys Array - No 輸入資料各欄位keys
opt.rows Array - No 輸入資料列,各列為物件,內含各欄位keys之值,例[{},{},...,{}]
opt.kpHead Object {} No 輸入key對應head物件,預設各key值為本身key值
opt.defHeadAlignH String 'center' No 輸入head預設之左右對齊字串,預設為'center'
opt.kpHeadAlignH Object {} No 輸入key對應head之左右對齊字串物件,預設各key值為defHeadAlignH
opt.defHeadSort Boolean true No 輸入head預設之是否允許排序布林值,預設為true
opt.kpHeadSort Object {} No 輸入key對應head之是否允許排序物件,預設各key值為defHeadSort
opt.defHeadSortMethod function|String null No 輸入head預設之排序方式函數或字串,若需自行定義則給予函數,若需使用內建的自動轉型判斷方式則給予'auto'字串,預設為null
opt.kpHeadSortMethod Object {} No 輸入key對應head之排序方式函數或字串,若需自行定義則給予函數,若需使用內建的自動轉型判斷方式則給予'auto'字串,預設各key值為defHeadSortMethod
opt.kpHeadFixLeft Object {} No 輸入key對應head之是否固定於左側物件,預設各key值為false
opt.defHeadFilter Boolean true No 輸入head預設之是否允許過濾布林值,預設為true
opt.kpHeadFilter Object {} No 輸入key對應head之是否允許過濾物件,預設各key值為defHeadFilter
opt.defHeadFilterType String 'num' No 輸入head預設過濾器字串,可選'num'、'text'、'time'、'set',預設為'num'
opt.kpHeadFilterType Object {} No 輸入key對應head之過濾器物件,可使用'num'、'text'、'time'、'set',預設各key值為'num'
opt.defHeadDrag Boolean true No 輸入head預設之是否允許拖曳布林值,預設為true
opt.kpHeadDrag Object {} No 輸入key對應head之是否允許拖曳物件,預設各key值為defHeadDrag
opt.kpHeadCheckBox Object {} No 輸入key對應head與key的各列是否使用核選方塊物件,預設各key值為false
opt.kpHeadFocusHighlight Object {} No 輸入key對應key的各列於獲得焦點時是否高亮顯示物件,預設各key值為true
opt.kpHeadHide Object {} No 輸入key對應head是否隱藏物件,預設各key值為false
opt.kpRowStyle Object {} No 輸入key對應row style之物件,可設定各key欄之函數,函數給予cell值需回傳之row style,預設各key值為undefined
opt.kpRowDrag Object {} No 輸入key對應col之是否能拖曳排序物件,預設各key值為false
opt.genRowsPinnTop function null No 輸入產生置頂rows函數,輸入為表內全部數據,預設為null
opt.genRowsPinnBottom function null No 輸入產生置底rows函數,輸入為表內全部數據,預設為null
opt.kpColStyle Object {} No 輸入key對應col style之物件,可設定各key欄之col style,預設各key值為undefined
opt.kpColSpan Object {} No 輸入key對應col span之物件,可設定各key欄之col span,預設各key值為undefined
opt.defHeadMinWidth Number null No 輸入cell預設最小寬度數字,預設為null
opt.defHeadMaxWidth Number null No 輸入cell預設最大寬度數字,預設為null
opt.kpHeadWidth Object {} No 輸入key對應cell之寬度物件,預設各key值為undefined
opt.defCellAlignH String 'center' No 輸入cell預設之左右對齊字串,預設為'center'
opt.kpCellAlignH Object {} No 輸入key對應cell之左右對齊字串物件,預設各key值為defCellAlignH
opt.defCellEditable Boolean false No 輸入cell預設之是否可編輯布林值,由組件editable複寫,預設為false
opt.kpCellEditable Object {} No 輸入key對應cell之是否可編輯物件,預設各key值為defCellEditable
opt.kpCellFormat Object {} No 輸入key對應cell之值格式化函數物件,函數簽名為(value, key, row, params),回傳顯示字串,回傳null或undefined代表不格式化維持原值;所有原值(含null、undefined、空字串)皆原樣傳入,編輯模式新增列之各欄為空字串,故函數內須自行處理空值(如回傳null);作用於顯示與下載(下載時row同為該列完整數據、params為null,可由組件useCellFormatWhenDownload關閉),排序、過濾、編輯與save回傳之rows仍為原值;與cell-render slot可並用,預設各key值為undefined
opt.kpConvertKeysWhenUploadData Object {} No 輸入上傳Excel檔案時將檔案表頭名稱轉為欄位key之對照物件,例如{ '製造商': 'make' },於opt.optForUploadData.beforeUpload之前套用,轉換後與檔案既有表頭同名時依欄序後者覆蓋,預設{}
opt.rowsChange function function(){} No 輸入rows change之觸發事件,預設為function(){}
opt.rowClick function function(){} No 輸入row click之觸發事件,預設為function(){}
opt.rowDbClick function function(){} No 輸入row double click之觸發事件,預設為function(){}
opt.rowChange function function(){} No 輸入row change之觸發事件,預設為function(){}
opt.rowChecked function function(){} No 輸入row checked之觸發事件,需使用kpHeadCheckBox開啟指定key的head與對應rows使用checkbox,預設為function(){}
opt.rowMouseEnter function function(){} No 輸入row mouseenter之觸發事件,預設為function(){}
opt.rowMouseLeave function function(){} No 輸入row mouseleave之觸發事件,預設為function(){}
opt.cellClick function function(){} No 輸入cell click之觸發事件,預設為function(){}
opt.cellDbClick function function(){} No 輸入cell double click之觸發事件,預設為function(){}
opt.cellChange function function(){} No 輸入cell change之觸發事件,預設為function(){}
opt.cellMouseEnter function function(){} No 輸入cell mouseenter之觸發事件,預設為function(){}
opt.cellMouseLeave function function(){} No 輸入cell mouseleave之觸發事件,預設為function(){}
opt.filterChange function function(){} No 輸入filter change之觸發事件,於掛載時與表頭過濾變更時各觸發1次,傳入{ from, filterall, flts, isFilter },isFilter為是否過濾中(組件據此顯示下載過濾後數據按鈕),其餘鍵值見w-aggrid-vue之opt.filterChange,預設為function(){}
opt.autoFitColumn Boolean false No 輸入當表格尺寸變更時自動調整欄寬布林值,預設false
opt.language String 'en' No 輸入指定語系字串,可選'en'、'zh-tw'、'zh-cn',預設同組件language
opt.beforeAddRow function - No 輸入編輯模式新增數據前之修改新列事件,輸入newRow,輸出newRow,預設為undefined
opt.optForUploadData Object {} No 輸入呼叫組件uploadData上傳檔案時用的設定物件,內部調用wsemi的getDataFromExcelFileU8Arr讀取Excel檔案,物件可給予鍵值:uploadMode代表上傳模式字串(可選'replace'、'append',有給予時點擊上傳按鈕不顯示模式選擇彈窗而直接開啟選檔視窗,未給予或非前述值時由彈窗選擇),beforeUpload代表上傳前的處理數據函數(輸入讀取所得之數據陣列(已依opt.kpConvertKeysWhenUploadData轉換表頭),回傳處理後之數據陣列或Promise,各列須為物件,未給予時自動去除於表格各欄位之值皆為空的無效數據;處理後無數據列或各列於表格欄位皆無值時觸發error事件(errorMsgFromUploadEmptyData),拋錯或回傳非陣列等不合約定時觸發error事件(errorMsgFromUploadData),皆不變動表格數據),parseSheetInd代表提取Excel檔案的第幾個sheet之非負整數或整數字串(依活頁簿分頁順序且含隱藏分頁,預設為0),組件不會修改此物件,optForUploadData預設{}
opt.modifyDataWhenSave function - No 輸入當儲存時修改儲存數據事件,輸入rows,輸出rows,預設為undefined
opt.checkNoDataWhenSave Boolean false No 輸入當儲存時是否檢核無數據布林值,預設false

Events

Name Payload Type Description
save Array 指調用組件的method,無輸入,會回傳當前的name、description、rows所構成的物件
success String 當新增數據、上傳數據、下載數據成功時觸發,回傳對應成功訊息字串
error String 當新增數據、移除數據、上傳數據、下載數據失敗時觸發,回傳對應錯誤訊息字串;使用者於上傳選檔視窗取消時不觸發

Description:

Props

Name Type Default value Required? Description
pathItems Array ['base:w-table-vue'] No 輸入w-table-vue組件js檔案位置字串陣列,w-aggrid-vue與ag-grid皆已打包於w-table-vue內故無須另行載入,預設['base:w-table-vue']
language String 'en' No 輸入指定語系字串,可選'en'、'zh-tw'、'zh-cn',可被opt.language複寫,預設為'en'
enableInfor Boolean true No 輸入是否使用資訊區(資料名稱name與資料描述description)布林值,預設為true
name String '' No 輸入資料名稱字串,預設''
description String '' No 輸入資料描述字串,預設''
inforPaddingStyle Object {v:0,h:0} No 輸入資訊區(資料名稱name與資料描述description)內寬距離物件,可用鍵值為v、h、left、right、top、bottom,v代表同時設定top與bottom,h代表設定left與right,若有重複設定時後面鍵值會覆蓋前面,各鍵值為寬度數字,單位為px,預設{v:0,h:0}
enableMenu Boolean true No 輸入是否使用選單按鈕區布林值,預設為true
menuPaddingStyle Object {v:3,h:3} No 輸入選單按鈕區內寬距離物件,可用鍵值為v、h、left、right、top、bottom,v代表同時設定top與bottom,h代表設定left與right,若有重複設定時後面鍵值會覆蓋前面,各鍵值為寬度數字,單位為px,預設{v:3,h:3}
menuBackgroundColor String 'transparent' No 輸入選單按鈕區背景顏色字串,預設'transparent'
sortColIds String|Array '' No 輸入初始化時自動排序數據的欄位,為字串或陣列,若輸入陣列時則依照順序排序,故最末者代表最終排序。預設''
hideIds String|Array '' No 輸入欲隱藏欄位字串或陣列,可被opt.kpHeadHide複寫,預設''
fixIds String|Array '' No 輸入欲固定於左側欄位字串或陣列,可被opt.kpHeadFixLeft複寫,預設''
checkId String '' No 輸入欲使用核選方塊欄位字串,可被opt.kpHeadCheckBox複寫,預設''
removeIdsWhenDownload String|Array '' No 輸入下載Excel檔案時欲移除的欄位字串或陣列,作用於下載數據與下載過濾後數據,移除後無任何欄位時觸發error事件且不產生檔案,預設''
funGetLtdtHookWhenDownload function null No 輸入下載Excel檔案時針對ltdt數據階段的攔截處理函數,輸入為各列數據陣列(為副本,值已依useCellFormatWhenDownload格式化),無數據列時輸入為空陣列,須同步回傳處理後之數據陣列(不支援Promise)且各列皆為非空物件,回傳空陣列時只輸出表頭列,回傳不合約定或函數拋錯時觸發error事件且不產生檔案,預設為null
funGetMatHookWhenDownload function null No 輸入下載Excel檔案時針對mat數據階段的攔截處理函數,輸入為首列為表頭之二維陣列(已經funGetLtdtHookWhenDownload處理),須同步回傳處理後之二維陣列(不支援Promise)且至少一列非空,無數據列且funGetLtdtHookWhenDownload未加入數據時只含表頭1列,回傳不合約定或函數拋錯時觸發error事件且不產生檔案,預設為null
useHeadWhenDownload Boolean false No 輸入下載Excel檔案時是否將欄位鍵值轉換成head布林值,此需提供opt.kpHead物件,若欲將下載之檔案填寫後上傳回來,須以opt.kpConvertKeysWhenUploadData將表頭名稱對回欄位鍵值,且opt.kpHead之名稱須非空且不重複,預設為false
useCellFormatWhenDownload Boolean true No 輸入下載Excel檔案時是否依opt.kpCellFormat格式化各欄值布林值,true時下載內容與畫面一致(有格式化函數之欄為格式化後字串),false時下載原值,無opt.kpCellFormat時無作用,轉發至w-table-vue(對應w-aggrid-vue之downloadData與downloadDisplayData之useFormat),預設為true
fileNameWhenDownload String 'data.xlsx' No 輸入下載Excel檔案時儲存檔名稱字串,無副檔名時自動補'.xlsx',預設'data.xlsx'
sheetNameWhenDownload String 'data' No 輸入下載Excel檔案時sheet名稱字串,須符合Excel分頁名稱規則(至多31字且表情符號等計2字、不含[ ] : * ? / \、首尾非單引號、非History),不符時改用'data',預設'data'
editable Boolean false No 輸入是否可編輯布林值,可被opt.defCellEditable複寫,預設為false
textLabelDataName String 'Data name:' No 輸入數據名稱字串,預設'Data name:'
textPlaceholderDataName String 'Please enter data name' No 輸入數據名稱placeholder字串,預設'Please enter data name'
textLabelDataDescription String 'Data description:' No 輸入數據說明字串,預設'Data description:'
textPlaceholderDataDescription String 'Please enter data description' No 輸入數據說明placeholder字串,預設'Please enter data description'
tooltipAddRow String 'add new row' No 輸入新增數據按鈕tooltip字串,預設'add new row'
tooltipDeleteSelectedRows String 'delete selected rows' No 輸入刪除選擇數據按鈕tooltip字串,預設'delete selected rows'
tooltipDownloadExcelFile String 'download data to Excel file' No 輸入下載數據成為Excel檔案按鈕tooltip字串,預設'download data to Excel file'
tooltipDownloadExcelFileForDisplay String 'download filtered data to Excel file' No 輸入下載過濾後數據成為Excel檔案按鈕tooltip字串,預設'download filtered data to Excel file'
tooltipDownloadExcelFileForHead String 'download headers to Excel file' No 輸入無數據列時下載數據按鈕之tooltip字串,下載數據按鈕於編輯與顯示模式皆一律顯示,無數據列(表格主數據列為0列,即opt.rows為空陣列或數據列已全部刪除,不含置頂置底列)時按下載只有表頭1列之Excel檔案,表頭依opt.keys之順序並套用removeIdsWhenDownload與useHeadWhenDownload,與有數據時所下載檔案之第1列相同,可供使用者填寫後上傳,此時改用本提示文字;不影響下載過濾後數據按鈕;給予空字串則不顯示tooltip,已自訂tooltipDownloadExcelFile語系之呼叫端應一併給予,轉發至w-table-vue,預設'download headers to Excel file'
tooltipUploadExcelFile String 'upload data to Excel file' No 輸入上傳Excel數據檔案按鈕tooltip字串,預設'upload data to Excel file'
successMsgFromAddRow String 'add row successfully' No 輸入新增數據成功事件訊息字串,預設'add row successfully'
errorMsgFromAddRow String 'can not add row' No 輸入無法新增數據事件訊息字串,預設'can not add row'
errorMsgFromRemoveRow String 'can not remove selected rows' No 輸入移除數據失敗事件訊息字串,預設'can not remove selected rows'
successMsgFromUploadData String 'upload data successfully' No 輸入上傳數據成功事件訊息字串,預設'upload data successfully'
errorMsgFromUploadData String 'can not upload data' No 輸入無法上傳數據事件訊息字串,例如非Excel檔案、指定之sheet不存在、opt.optForUploadData.beforeUpload拋錯或回傳不合約定(原因記錄於console),此時不變動表格數據,預設'can not upload data'
errorMsgFromUploadEmptyData String 'no effective data' No 輸入上傳檔案中無有效數據事件訊息字串,即上傳處理後無數據列,或各列於表格欄位之值皆為空(含檔案表頭與表格欄位不符),此時不變動表格數據,預設'no effective data'
successMsgFromDownloadData String 'download data successfully' No 輸入下載檔案成功事件訊息字串,預設'download data successfully'
errorMsgFromDownloadData String 'can not download data' No 輸入無法下載檔案事件訊息字串,例如移除後無任何欄位、下載掛鉤回傳不合約定或拋錯(原因記錄於console),此時不產生檔案,預設'can not download data'
errorMsgFromNoName String 'no data name' No 輸入未輸入數據名稱事件訊息字串,預設'no data name'
errorMsgFromNoData String 'no data' No 輸入未給予有效數據事件訊息字串,預設'no data'
uploadModeTitle String 'Choose mode of upload:' No 輸入選擇上傳模式彈窗標題字串,opt.optForUploadData.uploadMode有預先指定時不顯示此彈窗,預設'Choose mode of upload:'
uploadModeTextForReplace String 'Replace' No 輸入取代上傳模式文字字串,預設'Replace'
uploadModeTextForAppend String 'Append' No 輸入插入於最後上傳模式文字字串,預設'Append'
labelContentForUpload String null No 輸入針對上傳模式之popup彈窗teleport至body內之內容div所給予之wtlp屬性值字串,供查找使用,預設null
cmpZIndex Number 3000 No 輸入彈窗使用z-index數字,供嵌於高z-index彈窗內時提高層級,預設3000
opt Object null No 輸入w-aggrid-vue設定物件,預設null
opt.keys Array - No 輸入資料各欄位keys
opt.rows Array - No 輸入資料列,各列為物件,內含各欄位keys之值,例[{},{},...,{}]
opt.kpHead Object {} No 輸入key對應head物件,預設各key值為本身key值
opt.defHeadAlignH String 'center' No 輸入head預設之左右對齊字串,預設為'center'
opt.kpHeadAlignH Object {} No 輸入key對應head之左右對齊字串物件,預設各key值為defHeadAlignH
opt.defHeadSort Boolean true No 輸入head預設之是否允許排序布林值,預設為true
opt.kpHeadSort Object {} No 輸入key對應head之是否允許排序物件,預設各key值為defHeadSort
opt.defHeadSortMethod function|String null No 輸入head預設之排序方式函數或字串,若需自行定義則給予函數,若需使用內建的自動轉型判斷方式則給予'auto'字串,預設為null
opt.kpHeadSortMethod Object {} No 輸入key對應head之排序方式函數或字串,若需自行定義則給予函數,若需使用內建的自動轉型判斷方式則給予'auto'字串,預設各key值為defHeadSortMethod
opt.kpHeadFixLeft Object {} No 輸入key對應head之是否固定於左側物件,預設各key值為false
opt.defHeadFilter Boolean true No 輸入head預設之是否允許過濾布林值,預設為true
opt.kpHeadFilter Object {} No 輸入key對應head之是否允許過濾物件,預設各key值為defHeadFilter
opt.defHeadFilterType String 'num' No 輸入head預設過濾器字串,可選'num'、'text'、'time'、'set',預設為'num'
opt.kpHeadFilterType Object {} No 輸入key對應head之過濾器物件,可使用'num'、'text'、'time'、'set',預設各key值為'num'
opt.defHeadDrag Boolean true No 輸入head預設之是否允許拖曳布林值,預設為true
opt.kpHeadDrag Object {} No 輸入key對應head之是否允許拖曳物件,預設各key值為defHeadDrag
opt.kpHeadCheckBox Object {} No 輸入key對應head與key的各列是否使用核選方塊物件,預設各key值為false
opt.kpHeadFocusHighlight Object {} No 輸入key對應key的各列於獲得焦點時是否高亮顯示物件,預設各key值為true
opt.kpHeadHide Object {} No 輸入key對應head是否隱藏物件,預設各key值為false
opt.kpRowStyle Object {} No 輸入key對應row style之物件,可設定各key欄之函數,函數給予cell值需回傳之row style,預設各key值為undefined
opt.kpRowDrag Object {} No 輸入key對應col之是否能拖曳排序物件,預設各key值為false
opt.genRowsPinnTop function null No 輸入產生置頂rows函數,輸入為表內全部數據,預設為null
opt.genRowsPinnBottom function null No 輸入產生置底rows函數,輸入為表內全部數據,預設為null
opt.kpColStyle Object {} No 輸入key對應col style之物件,可設定各key欄之col style,預設各key值為undefined
opt.kpColSpan Object {} No 輸入key對應col span之物件,可設定各key欄之col span,預設各key值為undefined
opt.defHeadMinWidth Number null No 輸入cell預設最小寬度數字,預設為null
opt.defHeadMaxWidth Number null No 輸入cell預設最大寬度數字,預設為null
opt.kpHeadWidth Object {} No 輸入key對應cell之寬度物件,預設各key值為undefined
opt.defCellAlignH String 'center' No 輸入cell預設之左右對齊字串,預設為'center'
opt.kpCellAlignH Object {} No 輸入key對應cell之左右對齊字串物件,預設各key值為defCellAlignH
opt.defCellEditable Boolean false No 輸入cell預設之是否可編輯布林值,由組件editable複寫,預設為false
opt.kpCellEditable Object {} No 輸入key對應cell之是否可編輯物件,預設各key值為defCellEditable
opt.kpCellFormat Object {} No 輸入key對應cell之值格式化函數物件,函數簽名為(value, key, row, params),回傳顯示字串,回傳null或undefined代表不格式化維持原值;所有原值(含null、undefined、空字串)皆原樣傳入,編輯模式新增列之各欄為空字串,故函數內須自行處理空值(如回傳null);作用於顯示與下載(下載時row同為該列完整數據、params為null,可由組件useCellFormatWhenDownload關閉),排序、過濾、編輯與save回傳之rows仍為原值;與cell-render slot可並用,預設各key值為undefined
opt.kpConvertKeysWhenUploadData Object {} No 輸入上傳Excel檔案時將檔案表頭名稱轉為欄位key之對照物件,例如{ '製造商': 'make' },於opt.optForUploadData.beforeUpload之前套用,轉換後與檔案既有表頭同名時依欄序後者覆蓋,預設{}
opt.rowsChange function function(){} No 輸入rows change之觸發事件,預設為function(){}
opt.rowClick function function(){} No 輸入row click之觸發事件,預設為function(){}
opt.rowDbClick function function(){} No 輸入row double click之觸發事件,預設為function(){}
opt.rowChange function function(){} No 輸入row change之觸發事件,預設為function(){}
opt.rowChecked function function(){} No 輸入row checked之觸發事件,需使用kpHeadCheckBox開啟指定key的head與對應rows使用checkbox,預設為function(){}
opt.rowMouseEnter function function(){} No 輸入row mouseenter之觸發事件,預設為function(){}
opt.rowMouseLeave function function(){} No 輸入row mouseleave之觸發事件,預設為function(){}
opt.cellClick function function(){} No 輸入cell click之觸發事件,預設為function(){}
opt.cellDbClick function function(){} No 輸入cell double click之觸發事件,預設為function(){}
opt.cellChange function function(){} No 輸入cell change之觸發事件,預設為function(){}
opt.cellMouseEnter function function(){} No 輸入cell mouseenter之觸發事件,預設為function(){}
opt.cellMouseLeave function function(){} No 輸入cell mouseleave之觸發事件,預設為function(){}
opt.filterChange function function(){} No 輸入filter change之觸發事件,於掛載時與表頭過濾變更時各觸發1次,傳入{ from, filterall, flts, isFilter },isFilter為是否過濾中(組件據此顯示下載過濾後數據按鈕),其餘鍵值見w-aggrid-vue之opt.filterChange,預設為function(){}
opt.autoFitColumn Boolean false No 輸入當表格尺寸變更時自動調整欄寬布林值,預設false
opt.language String 'en' No 輸入指定語系字串,可選'en'、'zh-tw'、'zh-cn',預設同組件language
opt.beforeAddRow function - No 輸入編輯模式新增數據前之修改新列事件,輸入newRow,輸出newRow,預設為undefined
opt.optForUploadData Object {} No 輸入呼叫組件uploadData上傳檔案時用的設定物件,內部調用wsemi的getDataFromExcelFileU8Arr讀取Excel檔案,物件可給予鍵值:uploadMode代表上傳模式字串(可選'replace'、'append',有給予時點擊上傳按鈕不顯示模式選擇彈窗而直接開啟選檔視窗,未給予或非前述值時由彈窗選擇),beforeUpload代表上傳前的處理數據函數(輸入讀取所得之數據陣列(已依opt.kpConvertKeysWhenUploadData轉換表頭),回傳處理後之數據陣列或Promise,各列須為物件,未給予時自動去除於表格各欄位之值皆為空的無效數據;處理後無數據列或各列於表格欄位皆無值時觸發error事件(errorMsgFromUploadEmptyData),拋錯或回傳非陣列等不合約定時觸發error事件(errorMsgFromUploadData),皆不變動表格數據),parseSheetInd代表提取Excel檔案的第幾個sheet之非負整數或整數字串(依活頁簿分頁順序且含隱藏分頁,預設為0),組件不會修改此物件,optForUploadData預設{}
opt.modifyDataWhenSave function - No 輸入當儲存時修改儲存數據事件,輸入rows,輸出rows,預設為undefined
opt.checkNoDataWhenSave Boolean false No 輸入當儲存時是否檢核無數據布林值,預設false

Events

Name Payload Type Description
save Array 指調用組件的method,無輸入,會回傳當前的name、description、rows所構成的物件
success String 當新增數據、上傳數據、下載數據成功時觸發,回傳對應成功訊息字串
error String 當新增數據、移除數據、上傳數據、下載數據失敗時觸發,回傳對應錯誤訊息字串;使用者於上傳選檔視窗取消時不觸發