opt |
Object |
- |
Yes |
輸入資料設定物件 |
opt.keys |
Array |
- |
Yes |
輸入資料各欄位keys |
opt.rows |
Array |
- |
Yes |
輸入資料列，各列為物件，內含各欄位keys之值，例[{},{},...,{}] |
opt.kpHead |
Object |
{} |
No |
輸入key對應head物件，預設各key值為本身key值 |
opt.defHeadMinWidth |
Number |
null |
No |
輸入cell預設最小寬度數字，預設為null |
opt.defHeadMaxWidth |
Number |
null |
No |
輸入cell預設最大寬度數字，預設為null |
opt.kpHeadWidth |
Object |
{} |
No |
輸入key對應cell之寬度物件，預設各key值為undefined |
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.rows，各列保留全部欄位(含不在opt.keys內者，例如供kpCellEditable函數判斷之旗標)；回呼rowDragEnd、rowDragLeave、rowDragChange收到之row為被拖曳之整列，rows為依opt.keys提取之新列序數據副本(同getNowData，就地修改不影響表格與opt.rows) |
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.defCellAlignH |
String |
'center' |
No |
輸入cell預設之左右對齊字串，預設為'center' |
opt.kpCellAlignH |
Object |
{} |
No |
輸入key對應cell之左右對齊字串物件，預設各key值為defCellAlignH |
opt.defCellEditable |
Boolean |
false |
No |
輸入cell預設之是否可編輯布林值，預設為false |
opt.kpCellEditable |
Object |
{} |
No |
輸入key對應cell之是否可編輯物件，各key值可為布林值或函數，預設各key值為defCellEditable；值原樣指給ag-grid之colDef.editable，故語意同ag-grid：布林值代表整欄是否可編輯，函數簽名為(params)=>boolean，params同ag-grid之EditableCallbackParams(含node、data、column、colDef、api、context)，對每個儲存格逐列求值，回傳true代表該儲存格可編輯(可據以做到逐列唯讀)，其他型態(非布林值非函數)視為不可編輯；ag-grid之雙擊、F2、鍵入編輯與元件之貼上(Ctrl+V、pasteText)皆依同一判斷，貼上時唯讀之儲存格略過不寫入(其餘儲存格照寫，欄位索引照常遞增)，各儲存格之判斷皆於元件寫入前完成(同一次貼上先寫入之儲存格不影響後面儲存格之判斷)，函數須無副作用；貼上時函數若拋錯，該儲存格視為不可編輯並略過(不使整批貼上失敗)，同一次貼上同一欄於console以`[w-aggrid-vue] pasteText: kpCellEditable[key] threw, ...`說明一次；以鍵盤Ctrl+V自編輯器開啟中之儲存格貼上時，編輯器會先提交瀏覽器原生貼入之文字，函數看到的是提交後之資料 |
opt.kpCellFormat |
Object |
{} |
No |
輸入key對應cell之值格式化函數物件，函數簽名為(value, key, row, params)，回傳顯示字串，回傳值不經套件轉換直接使用，回傳null或undefined代表不格式化維持原值；所有原值(含null、undefined、空字串)皆原樣傳入，空值之呈現由呼叫端於函數內自行決定；作用於顯示與下載(下載時row同為該列完整數據、params為null)，排序與過濾仍依原值；與cell-render slot可並用，slot props之value為原值、valueFormatted為格式化值，預設各key值為undefined |
opt.kpConvertKeysWhenUploadData |
Object |
{} |
No |
輸入上傳Excel檔案時將檔案表頭名稱轉為欄位key之對照物件，例如{ '製造商': 'make' }，於uploadData之beforeUpload之前套用，轉換後與檔案既有表頭同名時依欄序後者覆蓋，預設{} |
opt.rowsChange |
function |
()=>{} |
No |
輸入rows change之觸發事件，預設為()=>{} |
opt.rowClick |
function |
()=>{} |
No |
輸入row click之觸發事件，預設為()=>{} |
opt.rowDbClick |
function |
()=>{} |
No |
輸入row double click之觸發事件，預設為()=>{} |
opt.rowChange |
function |
()=>{} |
No |
輸入row change之觸發事件，預設為()=>{} |
opt.rowChecked |
function |
()=>{} |
No |
輸入row checked之觸發事件，需使用kpHeadCheckBox開啟指定key的head與對應rows使用checkbox，預設為()=>{} |
opt.rowMouseEnter |
function |
()=>{} |
No |
輸入row mouseenter之觸發事件，預設為()=>{} |
opt.rowMouseLeave |
function |
()=>{} |
No |
輸入row mouseleave之觸發事件，預設為()=>{} |
opt.cellClick |
function |
()=>{} |
No |
輸入cell click之觸發事件，預設為()=>{} |
opt.cellDbClick |
function |
()=>{} |
No |
輸入cell double click之觸發事件，預設為()=>{} |
opt.cellChange |
function |
()=>{} |
No |
輸入cell change之觸發事件，預設為()=>{} |
opt.cellMouseEnter |
function |
()=>{} |
No |
輸入cell mouseenter之觸發事件，預設為()=>{} |
opt.cellMouseLeave |
function |
()=>{} |
No |
輸入cell mouseleave之觸發事件，預設為()=>{} |
opt.filterChange |
function |
()=>{} |
No |
輸入filter change之觸發事件，於掛載與filterall變更時(from為'filterall')、表頭過濾變更時(含setHeadFilter、clearHeadFilter、clearHeadFilterAll，from為'heads')各觸發1次，傳入{ from, filterall, flts, isFilter }，flts為觸發後讀取當下之生效中過濾模型陣列(依opt.keys之順序，含隱藏欄)，元件或ag-grid已銷毀後不觸發，預設為()=>{} |
opt.autoFitColumn |
Boolean |
false |
No |
輸入當表格尺寸變更時自動調整欄寬布林值，預設false |
opt.language |
String |
'en' |
No |
輸入指定語系字串，可選'en'、'zh-tw'、'zh-cn'，預設為'en' |
height |
Number |
300 |
No |
表格高度，單位為px，預設300 |
filterall |
String |
'' |
No |
輸入對全表數據進行過濾之字串，預設為'' |