数据组件

数据表格 AsamDataTable

管理请求、分页和跨页选择,并复用表格展示能力。

数据表格 ​

管理请求、分页和跨页选择,并复用表格展示能力。

基础用法 ​

示例使用本地异步函数、显式分页参数构造器和 Row 响应转换。分页改变会请求对应切片,列和工具栏与当前数据使用同一份源码。

本地分页与跨页选择

展开源码

请求与分页覆盖 ​

api 与 request 互斥;API 分支必须提供 buildPageParams,URL 分支使用 buildPageRequest 或 pageTarget。 完整说明。

选择、事件与实例 ​

selection-change 返回 { keys, rows } 的跨页快照,覆盖基础表格的行数组签名。 完整说明。

完整表格实例与树半选 ​

组件转发当前基础表格的完整公开实例,包括 getHalfSelectionRows、columns、tableId、ns、layout 和 store;方法保持真实实例接收者,观察值随挂载和当前表格变化更新。ns、layout、store 等对象只用于只读观察,不承诺其内部命令为稳定的公共接口。

getHalfSelectionRows 返回当前原生树选择列中的半选行。 完整说明。

原生实例与半选

展开源码

失败和重试 ​

error 返回 AsamDataError,success 返回 AsamPage。 完整说明。

本站继承关系 ​

  • AsamTable:适用的基础展示、交互与公开 API。
  • AsamPagination:适用的基础展示、交互与公开 API。

本页数据来源、模型、事件和实例的覆盖规则优先;本站链接不扩大本组件公开契约。尺寸使用基础组件的 ASAM 尺寸规则,示例使用 default。

跨页选择、陈旧恢复与取消 ​

完整示例返回严格 list/total 分页结构,buildPageParams 明确合并查询和分页输入,rowKey 从行生成稳定标识。 完整说明。

完整示例同时记录七个数据入口事件:update:currentPage/page-change 和 update:pageSize/page-size-change 保持数字;分页每页数量入口可在2/4之间切换。 完整说明。

跨页选择、陈旧恢复与取消

展开源码

独立分页状态与完整生命周期 ​

useAsamPagedData(config) 可供自定义表格消费同一分页协议。 完整说明。

配置 完整约束
api + buildPageParams builder 同步接收 query 与 { currentPage, pageSize };api 返回 Promise,并接收原始请求 context
request 默认将 query 与分页参数合并到 params;provider 的 pagination 可指定参数名
pageTarget: 'data' 适用于非 GET 请求;基础 target、query 和分页参数不得重名
buildPageRequest 同步构造完整 URL 请求,与 pageTarget、buildPageParams 互斥
transform 同步返回 { list, total },优先于 provider 的 adaptPage;自定义行类型必须提供 transform
queryKey 同步返回非空字符串,用于不能默认稳定序列化的 query;变化会重置页码并清空选择
cache false 或 { ttlMs, key? };TTL 为正安全整数,key 同步返回非空字符串
rowKey 默认 'id',也可使用字段名或同步函数;结果为字符串或有限数字,同页不得重复
defaultSelectedRowKeys 字符串/数字键保持类型区分,初次加载前可保留未知行键,后续遇到该行时补齐行快照
currentPage / pageSize 正安全整数;修改 pageSize 重置到第一页,受控值回显不重复请求

AsamApiPageSource<Q, P, R, T> 明确声明 api、query、分页参数 builder 与 transform。 完整说明。

状态 / 方法 行为
data, loading, error, stale, hasSucceeded, empty 只读 refs;失败保留最后成功数据并标记 stale;empty 仅在当前成功、非加载、无错误且非 stale 的空页成立
dataKey, requestKey, resolvedPage 分别标识成功数据与待执行参数;resolvedPage 保存实际成功的页码、页大小及 queryKey
currentPage, pageSize, selection 只读 refs;通过方法修改分页与选择
reload({ force? }) 返回 success / error / cancelled 闭合结果;force 跳过缓存并共享同一个强制请求
cancel() 结算当前等待为 cancelled;其他共享消费者可继续,晚到结果不得回写取消者
setCurrentPage(page), setPageSize(size) 自动模式发起请求,手动模式准备新参数并标记旧数据 stale
getSelection(), clearSelection() 返回冻结快照;清空重复调用不再次发出选择变更
toggleRowSelection(row, selected?), selectPage(rows) 当前页增选仅采用当前成功数据,保留其他页选择;stale 期间阻止增选和整页选择,仍可取消已选行

响应总数为零时页码归一到 1;页码超出末页时最多纠正并请求一次,第二次仍越界返回 response 错误。 完整说明。

onSuccess 接收冻结的标准化页,onError 接收结构化错误,onPageChange、 onPageSizeChange 接收数字,onSelectionChange 接收完整只读选择快照。回调不代替宿主 自己的受控数据更新。

通过实例方法管理当前页选择,并读取跨页选择键与已解析行。 完整说明。

当前页的原生展示用途 ​

完整示例在同一数据入口组合固定表头/列、两层分组表头、列模板/自定义表头、序号、当前行高亮、原生排序与列筛选、展开内容、汇总、状态样式、状态单元格合并及溢出提示。 完整说明。

高度按钮演示 maxHeight=150 的滚动区和 height=310/maxHeight=310 的固定高度;布局按钮切换 tableLayout 的 fixed/auto,请求计数用于确认这些展示操作不重新请求。 完整说明。

展示排序、筛选、展开与汇总

展开源码

回调按钮分别演示汇总与 tooltip 的文本/VNode 返回值、spanMethod 的数组/对象跨度,以及 rowClassName 的字符串/泛型函数。 完整说明。

原生树加载与行键边界 ​

currentRowKey、expandRowKeys 和 updateKeyChildren 使用 rowKey 生成的原始 ASAM 键;数字 1 与字符串 "1" 分别定位,不要求调用方填写内部类型前缀。 完整说明。

原生懒加载与数值/字符串行键

展开源码

工具栏插槽的 selection 保留完整原始键和业务行快照,loading/stale 为布尔值;分页示例提供明确持有/完成请求操作,可观察加载中、失败过期和恢复的状态。默认插槽没有载荷参数,直接放置 AsamTableColumn;列内的 row 作用域属于列组件。

行键读取的内部边界 ​

应用通过公开 rowKey 字段名或同步回调配置行键,由分页数据与表格完成读取和校验。 完整说明。

生命周期完整示例还可展开“公开分页行键边界”。 完整说明。

append 与 empty 都是零参数插槽,经 DataTable → AsamTable → 原生 Table 转交,不接收行、loading 或跨页 selection。 完整说明。

成功空页未提供 empty 插槽时,公开 emptyText 使用调用方文案;省略或传入 undefined 时保留默认“暂无数据”。未加载、加载中和错误状态保留数据表自有文案, empty 插槽仍优先于空文本。

生命周期示例的“默认列与 append/empty 插槽”可持有和完成空页、成员页及失败请求。未加载和成功空页显示自定义空内容;加载成员后隐藏空内容,附加说明继续显示。成功页随后失败时保留旧行,空内容不覆盖陈旧快照;恢复空页后重新显示。关闭自定义插槽可查看原生“暂无数据”文本,再打开可恢复自定义内容。

固定原生 2.14.7 的 append 顺序随布局变化:fixed 布局位于汇总之前,auto 布局位于表体内的汇总之后。 完整说明。

局部请求错误插槽 ​

可选 error 插槽仅在当前请求错误存在时调用,接收只读 { error, stale, retry }。 完整说明。

retry() 不接收参数,直接返回现有 reload({ force: true }) 的 Promise,结果为 AsamReloadResult<AsamPage<Row>> 的 success、error 或 cancelled 分支。 重试保留当前查询、分页与选择,不自动重置这些值。

提供该插槽时,自有内容替换整个默认局部错误区;返回空内容也表示主动替换。 未提供时继续显示原错误文字、过期提示和默认重试按钮。无 error 的单独 stale 状态 不调用此插槽;empty、loading 和其他基础插槽继续使用原作用域。基础表格的 empty 内容仍属于独立的空数据展示。

以下完整 TS/JS 示例先制造失败,再等待插槽 retry 的返回结果;成功后可再次制造 更新失败,观察旧结果与模型保留。每次挂载使用独立子 app 和本地 provider。

局部错误定制、等待重试与过期恢复

展开源码

API

属性 AsamDataTableProps

属性名说明类型默认值
data—undefined—
rowKey—string | ((row: T) => AsamRowKey) | undefined—
cache—false | AsamOptionsCache | undefinedfalse
query—Q | undefined—
queryKey—((query: Q) => string) | undefined—
immediate—boolean | undefinedtrue
currentPage—number | undefined—
pageSize—number | undefined—
defaultSelectedRowKeys—readonly AsamRowKey[] | undefined—
request—AsamRequestConfig | undefined—
api—undefined | AsamApiRequest<P, R>—
buildPageParams—undefined | (query: Q, page: AsamPageRequest) => P—
buildPageRequest—undefined | (query: Q, page: AsamPageRequest) => AsamRequestConfig—
pageTarget—enum"data" | "params"完整类型:"data" | "params" | undefined | undefined—
transform—((response: R) => AsamPage<T>) | ((response: R) => AsamPage<T>) | undefined—
currentRowKey以原始 ASAM 键高亮当前页行,不要求调用方使用内部编码键。AsamRowKey | undefined—
expandRowKeys以原始键展开当前页行;数字 1 与字符串 '1' 保持区分。readonly AsamRowKey[] | undefined—
selectable—boolean | undefinedfalse
pageSizes—number[] | undefined—
minWidth—string | undefined—
stripe是否为斑马纹 tableboolean | undefinedfalse
border是否带有纵向边框boolean | undefinedfalse
pagination分页外观继承 AsamPagination;分页值和禁用状态由数据层维护。Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined—
style—AsamDataTableProps<Q, P, R, T>["style"]false
className—string | undefined—
width—string | number | undefined—
size—enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—
heighttable 的高度。默认为自动高度。如果 height 为 number 类型,单位 px;如果 height 为 string 类型,则这个高度会设置为 Table 的 style.height 的值,Table 的高度会受控于外部样式。string | number | undefined—
maxHeighttable 的最大高度。合法的值为数字或者单位为 px 的高度。string | number | undefined—
fit列的宽度是否自撑开boolean | undefinedfalse
showHeader是否显示表头boolean | undefinedfalse
showSummary是否在表尾显示合计行boolean | undefinedfalse
sumText显示摘要行第一列的文本string | undefined—
summaryMethod自定义的合计计算方法AsamTableSummaryMethod<T> | undefined—
rowClassName行的 className 的回调方法,也可以使用字符串为所有行设置一个固定的 className。AsamTableColumnCls<T> | undefined—
rowStyle行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style。AsamTableColumnStyle<T> | undefined—
cellClassName单元格的 className 的回调方法,也可以使用字符串为所有单元格设置一个固定的 className。AsamTableCellCls<T> | undefined—
cellStyle单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有单元格设置一样的 Style。AsamTableCellStyle<T> | undefined—
headerRowClassName表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className。AsamTableColumnCls<T> | undefined—
headerRowStyle表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style。AsamTableColumnStyle<T> | undefined—
headerCellClassName表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className。AsamTableCellCls<T> | undefined—
headerCellStyle表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。AsamTableCellStyle<T> | undefined—
highlightCurrentRow是否要高亮当前行boolean | undefinedfalse
emptyText空数据时显示的文本内容,也可以通过 #empty 设置string | undefined—
defaultExpandAll是否默认展开所有行,当 Table 包含展开行存在或者为树形表格时有效boolean | undefinedfalse
rowExpandable启用可展开行,当表格具有 type="expand" 列时有效((row: T, index: number) => boolean) | undefined—
defaultSort默认的排序列的 prop 和顺序。它的 prop 属性指定默认的排序的列,order 指定默认排序的顺序AsamTableSort | undefined—
tooltipEffect溢出的 tooltip 的 effectstring | undefined—
tooltipOptions溢出提示配置,参阅提示组件参数。(AsamDataTableProps<Q, P, R, T>)["tooltipOptions"]—
spanMethod合并行或列的计算方法
查看完整类型((data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }) => number[] | { rowspan: number; colspan: number; } | undefined) | undefined
—
selectOnIndeterminate在多选表格中,当仅有部分行被选中时,点击表头的多选框时的行为。若为 true,则选中所有行;若为 false,则取消选择所有行boolean | undefinedfalse
indent展示树形数据时,树节点的缩进number | undefined—
treeProps渲染嵌套数据的配置选项(AsamDataTableProps<Q, P, R, T>)["treeProps"]—
lazy是否懒加载子节点数据boolean | undefinedfalse
load加载子节点数据的函数,lazy 为 true 时生效((row: T, treeNode: AsamTableTreeNode, resolve: (data: T[]) => void) => void) | undefined—
tableLayout原生自动或固定布局;追加内容和合计行顺序遵循原生表格。enum"auto" | "fixed"完整类型:("auto" | "fixed") | undefined—
scrollbarAlwaysOn总是显示滚动条boolean | undefinedfalse
flexible确保主轴的最小尺寸,以便不超过内容boolean | undefinedfalse
showOverflowTooltip是否隐藏溢出内容并在悬停单元格时显示提示,作用于全部列。(AsamDataTableProps<Q, P, R, T>)["showOverflowTooltip"]false
tooltipFormatter格式化单元格提示内容的函数,show-overflow-tooltip 为 true 时生效。AsamTableOverflowTooltipFormatter<T> | undefined—
appendFilterPanelTo—string | undefined—
scrollbarTabindex—string | number | undefined—
allowDragLastColumn是否允许拖动最后一列boolean | undefinedfalse
preserveExpandedContent在折叠后是否在DOM中保留展开行内容boolean | undefinedfalse
nativeScrollbar是否使用原生滚动条样式boolean | undefinedfalse
reserveSelection—boolean | undefinedfalse

事件 AsamDataTableEmits

属性名说明类型默认值
update:currentPage—[value: number]—
update:pageSize—[value: number]—
page-change—[value: number]—
page-size-change—[value: number]—
selection-change以现有跨页键和行快照覆盖基础行数组。[selection: AsamTableSelection<T>]—
success—[data: AsamPage<T>]—
error—[error: AsamDataError]—
select—(AsamDataTableEmits<T>)["select"]—
select-all—(AsamDataTableEmits<T>)["select-all"]—
cell-mouse-enter—(AsamDataTableEmits<T>)["cell-mouse-enter"]—
cell-mouse-leave—(AsamDataTableEmits<T>)["cell-mouse-leave"]—
cell-dblclick—(AsamDataTableEmits<T>)["cell-dblclick"]—
cell-contextmenu—(AsamDataTableEmits<T>)["cell-contextmenu"]—
cell-click—(AsamDataTableEmits<T>)["cell-click"]—
row-dblclick—(AsamDataTableEmits<T>)["row-dblclick"]—
row-click—(AsamDataTableEmits<T>)["row-click"]—
row-contextmenu—(AsamDataTableEmits<T>)["row-contextmenu"]—
header-click—(AsamDataTableEmits<T>)["header-click"]—
header-contextmenu—(AsamDataTableEmits<T>)["header-contextmenu"]—
sort-change—(AsamDataTableEmits<T>)["sort-change"]—
filter-change—[filters: Record<string, string[]>]—
current-change—(AsamDataTableEmits<T>)["current-change"]—
header-dragend—(AsamDataTableEmits<T>)["header-dragend"]—
expand-change—(AsamDataTableEmits<T>)["expand-change"]—
scroll—[position: { scrollLeft: number; scrollTop: number; }]—

插槽 AsamDataTableSlots

属性名说明类型默认值
default—(() => unknown) | undefined—
toolbar—((props: { selection: AsamTableSelection<T>; loading: boolean; stale: boolean; }) => unknown) | undefined—
empty—(() => unknown) | undefined—
append原生追加插槽;布局及合计行顺序遵循固定上游版本。(() => unknown) | undefined—
error替换本地错误区域;重试返回现有强制重新加载的 Promise。(AsamDataTableSlots<T>)["error"]—

实例方法与状态 AsamDataTableExpose

属性名说明类型默认值
clearSelection清空全部页面的 ASAM 选择快照,而非仅当前可见行。() => void—
getSelection返回跨页 ASAM 键及已知行快照。() => AsamTableSelection<T>—
toggleRowSelection选择当前已加载的行;过期页面拒绝新增选择。(row: T, selected?: boolean) => void—
getSelectionRows返回 ASAM 跨页快照中已知的行。() => T[]—
toggleAllSelection切换当前已加载页面的选择状态。() => void—
updateKeyChildren原生懒加载子节点替换接收原始键,而非内部编码键。(key: AsamRowKey, children: T[]) => void—
reload—(options?: { readonly force?: boolean; }) => Promise<AsamReloadResult<AsamPage<T>>>—
cancel—() => void—
sort手动排序表格。参数 prop 属性指定排序列,order 指定排序顺序。(prop: string, order: string) => void—
context—AsamTableContext<T>—
tableLayout—enum"auto" | "fixed"完整类型:"auto" | "fixed"—
allowDragLastColumn是否允许拖动最后一列boolean—
ns—(AsamDataTableExpose<T>)["ns"]—
layout—(AsamDataTableExpose<T>)["layout"]—
store—(AsamDataTableExpose<T>)["store"]—
columns—AsamTableColumnCtx<T>[]—
handleHeaderFooterMousewheel—(event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void—
handleMouseLeave—() => void—
tableId—string—
tableSize—enum"" | "large" | "default" | "small"完整类型:"" | "large" | "default" | "small"—
isHidden—boolean—
isEmpty—boolean—
renderExpanded—(AsamDataTableExpose<T>)["renderExpanded"]—
resizeProxyVisible—boolean—
resizeState—{ width: null | number; height: null | number; headerHeight: null | number; }—
isGroup—boolean—
bodyWidth—string—
tableBodyStyles—{ width: string; }—
emptyBlockStyle—{ width: string; height: string; } | undefined—
debouncedUpdateLayout—(AsamDataTableExpose<T>)["debouncedUpdateLayout"]—
setCurrentRow用于单选表格,设定某一行为选中行,如果调用时不加参数,则会取消目前高亮行的选中状态。(row?: T | undefined) => void—
getHalfSelectionRows返回当前半选中的行() => T[]—
clearFilter传入由columnKey 组成的数组以清除指定列的过滤条件。如果没有参数,清除所有过滤器(columnKeys?: string[] | string) => void—
toggleRowExpansion用于可扩展的表格或树表格,如果某行被扩展,则切换。使用第二个参数,您可以直接设置该行应该被扩展或折叠。(row: T, expanded?: boolean) => void—
clearSort用于清空排序条件,数据会恢复成未排序的状态() => void—
doLayout对 Table 进行重新布局。当表格可见性变化时,您可能需要调用此方法以获得正确的布局() => void—
t—AsamDataTableExpose<T>["t"]—
setDragVisible—(visible: boolean) => void—
computedSumText—string—
computedEmptyText—string—
computedTooltipEffect—string | undefined—
computedTooltipOptions—(AsamDataTableExpose<T>)["computedTooltipOptions"]—
scrollbarViewStyle—{ display: string; verticalAlign: string; }—
scrollbarStyle—{ height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; }—
scrollBarRef—(AsamDataTableExpose<T>)["scrollBarRef"]—
scrollTo滚动到一组特定坐标(options: ScrollToOptions | number, yCoord?: number) => void—
setScrollLeft设置水平滚动位置(left?: number) => void—
setScrollTop设置垂直滚动位置(top?: number) => void—

类型 AsamPagedInput

属性名说明类型默认值
data—undefined—
rowKey—string | ((row: T) => AsamRowKey) | undefined—
cache—false | AsamOptionsCache | undefined—
query—Q | undefined—
queryKey—((query: Q) => string) | undefined—
immediate—boolean | undefined—
currentPage—number | undefined—
pageSize—number | undefined—
defaultSelectedRowKeys—readonly AsamRowKey[] | undefined—
api—AsamApiRequest<P, R> | undefined—
buildPageParams—(query: Q, page: AsamPageRequest) => P | undefined—
request—undefined | AsamRequestConfig—
buildPageRequest—undefined | (query: Q, page: AsamPageRequest) => AsamRequestConfig—
pageTarget—enum"data" | "params"完整类型:undefined | "data" | "params" | undefined—
transform—((response: R) => AsamPage<T>) | ((response: R) => AsamPage<T>) | undefined—

用法与契约补充说明 ​

请求与分页覆盖 ​

api 与 request 互斥;API 分支必须提供 buildPageParams,URL 分支使用 buildPageRequest 或 pageTarget。具体 Row 类型必须提供 transform,将响应转换为 AsamPage。查询、页码、页长与选中键属于数据层;pagination 仅配置分页外观,不能覆盖 total、currentPage、pageSize 或 disabled。数据层拥有 data 与 loading,不能再传静态 data。

选择、事件与实例 ​

selection-change 返回 { keys, rows } 的跨页快照,覆盖基础表格的行数组签名。getSelection 返回同样的快照,getSelectionRows 返回已解析行,clearSelection 清空跨页选择。toolbar 插槽接收 selection、loading、stale;使用 selection.keys 统计选择,不能把它当作行数组。基础表格的适用事件、插槽与实例仍以本站基础 API 为准。

完整表格实例与树半选 ​

getHalfSelectionRows 返回当前原生树选择列中的半选行。下例使用 AsamTableColumn 的 selection 类型勾选一个子节点,读取父节点的半选状态。该原生选择列与 selectable 提供的 ASAM 跨页选择分别维护:getSelection、getSelectionRows、clearSelection、toggleRowSelection 和 toggleAllSelection 仍遵守本页跨页快照覆盖,不把原生半选数组伪装成跨页选中键。

失败和重试 ​

error 返回 AsamDataError,success 返回 AsamPage。组件显示错误与过期状态,过期时分页和选中操作受限;reload({ force: true }) 强制重载,cancel() 取消当前请求。reload 返回 success、error 或 cancelled 分支,调用方应按 status 处理。

跨页选择、陈旧恢复与取消 ​

完整示例返回严格 list/total 分页结构,buildPageParams 明确合并查询和分页输入,rowKey 从行生成稳定标识。selection-change 和 getSelection/getSelectionRows 返回跨页快照;原生 row-click、sort-change 和列插槽保持展示语义,sort() 仅排序当前原生表格展示。请求失败保留旧成功页、显示原页数和 total,陈旧时禁止新选择并隐藏分页;恢复后重新启用。cancel 返回 cancelled,不能当作成功。toolbar 提供 loading/stale 与快照,append/empty 交给基础表格。示例接口在本地运行。

跨页选择、陈旧恢复与取消 ​

完整示例同时记录七个数据入口事件:update:currentPage/page-change 和 update:pageSize/page-size-change 保持数字;分页每页数量入口可在2/4之间切换。selection-change 记录跨页 keys/rows 快照,success 保留严格 list/total,error 保留结构化错误种类与消息。原生 row/sort 事件仍单独记录;不能将 ASAM 选择快照当作原生行数组。

独立分页状态与完整生命周期 ​

useAsamPagedData(config) 可供自定义表格消费同一分页协议。config.source 接受普通配置、 ref、computed 或同步 getter;显式 runtime 与 app 的 provideAsamData(app, provider) 均可提供请求环境。immediate: false 仅准备参数与键,调用 reload() 后才执行请求。 生命周期示例中的“完整分页状态与生命周期”包含 TS/JS 两种同源实现,验证成功、空结果、 失败、取消、参数变化、跨页选择、缓存和实际 app 注入与卸载。

独立分页状态与完整生命周期 ​

AsamApiPageSource<Q, P, R, T> 明确声明 api、query、分页参数 builder 与 transform。 AsamPagedInput<Q, P, R, T> 进一步区分 API、默认 URL 合并和自定义 URL builder 三种合法 组合。AsamPagedInputBase 描述共有字段,消费完整配置时应使用 AsamPagedInput 约束组合。 AsamPage<T>.list、total 与 AsamTableSelection<T>.keys、rows 为只读数据;数字 1 与字符串 '1' 是两个独立行键。

独立分页状态与完整生命周期 ​

响应总数为零时页码归一到 1;页码超出末页时最多纠正并请求一次,第二次仍越界返回 response 错误。query 或源身份变化会取消旧请求、清空选择并从第一页开始;等价 wrapper 与受控回显 保持当前请求。runtime 的 scope/epoch 失效会取消请求,清空数据、成功页与选择并淘汰缓存。 卸载所属作用域后 reload 返回 cancelled。

当前页的原生展示用途 ​

完整示例在同一数据入口组合固定表头/列、两层分组表头、列模板/自定义表头、序号、当前行高亮、原生排序与列筛选、展开内容、汇总、状态样式、状态单元格合并及溢出提示。sort/clearSort、clearFilter、toggleRowExpansion、setCurrentRow 操作当前原生表格,事件保留 Row;它们不会替调用方改变服务器 query 或发起新的分页请求。此例只有三个本地行,合并规则针对相邻的前两行;动态分组、排序和筛选组合时应由业务按实际可见行计算 spanMethod,不能照搬固定行号。汇总使用当前展示行,不表示服务器全量总计。

当前页的原生展示用途 ​

高度按钮演示 maxHeight=150 的滚动区和 height=310/maxHeight=310 的固定高度;布局按钮切换 tableLayout 的 fixed/auto,请求计数用于确认这些展示操作不重新请求。固定原生 2.14.7 将已设置的 maxHeight 改为 undefined 时仍保留原内联上限,因此本例恢复时显式设置相同的高度和上限。原生组件在 maxHeight 有值时固定使用 fixed 布局,因此 auto 分支同时不提供 maxHeight。

当前页的原生展示用途 ​

回调按钮分别演示汇总与 tooltip 的文本/VNode 返回值、spanMethod 的数组/对象跨度,以及 rowClassName 的字符串/泛型函数。spanMethod 返回 undefined 时使用原生默认跨度,可恢复全部默认单元格,再恢复合并。showSummary 可动态关闭并恢复;高度可使用数字或 CSS 字符串,未设置 height 时由 maxHeight 约束实际滚动区。clearFilter 接受省略参数、单个键或键数组,固定原生源码的签名比原文档表格仅列出的数组更完整。setCurrentRow 省略行时清除高亮,toggleRowExpansion 省略第二参数时切换展开;传入具体 Row 保留行类型。这些本地展示操作保持同一次分页请求,不代表服务器筛选或排序。

原生树加载与行键边界 ​

currentRowKey、expandRowKeys 和 updateKeyChildren 使用 rowKey 生成的原始 ASAM 键;数字 1 与字符串 "1" 分别定位,不要求调用方填写内部类型前缀。updateKeyChildren 遵守原生条件:lazy=true、已加载的父节点及新子行;它只更新当前原生树展示,不重写分页来源或跨页选择快照。Table 的原生 lazy/load 行加载与 Remote/Dict Cascader、TreeSelect 的完整树来源不同;后两者仍排除逐节点数据加载。setCurrentRow、toggleRowExpansion 使用当前实例的 Row;示例从 success.list/列插槽取得已规范化行,不能假定原 API 对象与实例行同一引用。

行键读取的内部边界 ​

应用通过公开 rowKey 字段名或同步回调配置行键,由分页数据与表格完成读取和校验。asamRowKey 的函数声明只通过根入口的 export type * 提供类型查询,不是根入口可调用的函数;import type 配合 typeof 可以描述其签名,不能据此发出运行时导入。内部读取要求自有字符串键或有限数字,拒绝异步/thenable 回调结果;这项内部校验不能代替应用正确配置 rowKey。包未开放内部 paging 模块的深路径导入。

行键读取的内部边界 ​

生命周期完整示例还可展开“公开分页行键边界”。通过真实 useAsamPagedData 验证自有空字符串、零、负数、有限小数和同步字符串/数字回调;布尔值、null、对象、缺失或继承键、NaN、Infinity 及重复键产生 response 错误,不发布成功页。async Promise、返回拒绝 Promise 及成功/拒绝 thenable 都必须被同步回调守卫拒绝,拒绝 Promise 不额外泄漏未处理异常。当前页选择的 toggleRowSelection/selectPage 使用相同守卫;非法异步结果不改变选择,恢复同步回调后可以重新选中。运行期非法输入仅用于展示拒绝边界,正常 TS 应按公开同步签名提供 rowKey。

行键读取的内部边界 ​

append 与 empty 都是零参数插槽,经 DataTable → AsamTable → 原生 Table 转交,不接收行、loading 或跨页 selection。append 位于表体行之后;empty 在没有当前可展示行时显示,覆盖原生空文本。默认插槽直接放置列,行作用域由 AsamTableColumn 提供。

行键读取的内部边界 ​

固定原生 2.14.7 的 append 顺序随布局变化:fixed 布局位于汇总之前,auto 布局位于表体内的汇总之后。DataTable 与基础表格都通过原生公开插槽委托,不统一重排这一原生差异。生命周期示例保留布局切换,并覆盖空页、成员页、失败保留旧行、恢复空页及移除/恢复自定义插槽。旧候选曾通过的统一顺序依赖私有派生补丁,其原件仅作旧契约历史,不证明当前原生透传契约合格。

局部请求错误插槽 ​

可选 error 插槽仅在当前请求错误存在时调用,接收只读 { error, stale, retry }。 error 与本实例 error 事件中的 AsamDataError 为同一对象,保留 cause、kind、 message 与 notified;渲染插槽不会再次通知 provider。stale 表示保留的数据已过期。

更多参数与事件说明 ​

独立分页状态与完整生命周期 ​

实例控制按钮通过 success.list 中的当前行调用 toggleRowSelection(row, true/false),省略第二参数时切换这一行;toggleAllSelection() 只切换当前已加载页,保留其他页的选择。读取按钮分别调用 getSelection() 和 getSelectionRows(),比较跨页键与已解析行。陈旧页拒绝新增选择和当前页全选切换,仍允许取消已有选择及 clearSelection() 全局清空;恢复后重新启用新增选择。cancel() 只取消请求,保留调用方可见的原成功页和选择,reload 的 cancelled 返回值单独处理。

继承能力

本入口的独有 API 见上表,基础能力见本站对应页面。

参数与事件补充说明

组合契约按分支生效;请同时查看公开类型。

参数与事件说明

data

必填:否;声明来源:数据 / provider 协议。

rowKey

必填:否;声明来源:数据 / provider 协议。

rowKey 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T): AsamRowKey

cache

必填:否;声明来源:数据 / provider 协议。

cache 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

  • cache.ttlMs: number — 数据 / provider 协议
  • cache.key: ((requestInput: unknown) => string) | undefined — 数据 / provider 协议

    事件参数:(requestInput: unknown): string

默认值与来源
false(隐式 Boolean 默认;已安装组件)
query

必填:否;声明来源:数据 / provider 协议。

queryKey

必填:否;声明来源:数据 / provider 协议。

queryKey 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q): string

immediate

必填:否;声明来源:数据 / provider 协议。

immediate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(源码表达式;ASAM 声明)
currentPage

必填:否;声明来源:数据 / provider 协议。

pageSize

必填:否;声明来源:数据 / provider 协议。

defaultSelectedRowKeys

必填:否;声明来源:数据 / provider 协议。

request

必填:否;声明来源:数据 / provider 协议。

request 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • request.url: string — 数据 / provider 协议
  • request.method: "delete" | "get" | "post" | "put" | undefined — 数据 / provider 协议

    枚举:"delete" / "get" / "post" / "put"

  • request.params: Readonly<Record<string, unknown>> | undefined — 数据 / provider 协议
  • request.data: unknown — 数据 / provider 协议
api

必填:否;声明来源:数据 / provider 协议。

api 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(params: P, context: AsamRequestContext): Promise<R>

buildPageParams

必填:否;声明来源:数据 / provider 协议。

buildPageParams 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q, page: AsamPageRequest): P

buildPageRequest

必填:否;声明来源:数据 / provider 协议。

buildPageRequest 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q, page: AsamPageRequest): AsamRequestConfig

pageTarget

必填:否;声明来源:数据 / provider 协议。

pageTarget 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"data" / "params"

transform

必填:否;声明来源:数据 / provider 协议。

transform 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(response: R): AsamPage<T>

事件参数:(response: R): AsamPage<T>

currentRowKey

必填:否;声明来源:ASAM 声明。

expandRowKeys

必填:否;声明来源:ASAM 声明。

selectable

必填:否;声明来源:ASAM 声明。

selectable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
pageSizes

必填:否;声明来源:ASAM 声明。

minWidth

必填:否;声明来源:ASAM 声明。

stripe

必填:否;声明来源:ASAM 声明。

stripe 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
border

必填:否;声明来源:ASAM 声明。

border 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
pagination

必填:否;声明来源:ASAM 声明。

pagination 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • pagination.small: boolean | undefined — 上游声明

    枚举:false / true

  • pagination.popperClass: PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "popperClass"> — 上游声明

    枚举:false

  • pagination.popperStyle: AsamDataTableProps<Q, P, R, T>["style"] — 上游声明

    枚举:false

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • pagination.teleported: PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "teleported"> — 上游声明

    枚举:false / true

  • pagination.size: AsamControlSize | undefined — ASAM 声明

    枚举:"large" / "big" / "default" / "small"

  • pagination.layout: string | undefined — 上游声明
  • pagination.defaultPageSize: number | undefined — 上游声明
  • pagination.pageCount: number | undefined — 上游声明
  • pagination.pagerCount: number | undefined — 上游声明
  • pagination.defaultCurrentPage: number | undefined — 上游声明
  • pagination.pageSizes: number[] | undefined — 上游声明
  • pagination.prevText: string | undefined — 上游声明
  • pagination.prevIcon: PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "prevIcon"> — 上游声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "prevIcon">>, (...args: never[]) => unknown>>[1]): any

    • pagination.prevIcon.__isFragment: undefined — 依赖声明
    • pagination.prevIcon.__isTeleport: undefined — 依赖声明
    • pagination.prevIcon.__isSuspense: undefined — 依赖声明
  • pagination.nextText: string | undefined — 上游声明
  • pagination.nextIcon: PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "nextIcon"> — 上游声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<Omit<AsamPaginationProps, "disabled" | "total" | "currentPage" | "pageSize"> | undefined>, "nextIcon">>, (...args: never[]) => unknown>>[1]): any

    • pagination.nextIcon.__isFragment: undefined — 依赖声明
    • pagination.nextIcon.__isTeleport: undefined — 依赖声明
    • pagination.nextIcon.__isSuspense: undefined — 依赖声明
  • pagination.background: boolean | undefined — 上游声明

    枚举:false / true

  • pagination.hideOnSinglePage: boolean | undefined — 上游声明

    枚举:false / true

  • pagination.appendSizeTo: string | undefined — 上游声明
style

必填:否;声明来源:上游声明。

style 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游源码工厂(未执行):() => ({})(2.14.7;源码事实,未作为 ASAM 运行实测)

className

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:''(2.14.7;源码事实,未作为 ASAM 运行实测)

width

必填:否;声明来源:上游声明。

size

必填:否;声明来源:ASAM 声明。

size 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"large" / "big" / "default" / "small"

height

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

maxHeight

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

fit

必填:否;声明来源:上游声明。

fit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

showHeader

必填:否;声明来源:上游声明。

showHeader 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

showSummary

必填:否;声明来源:上游声明。

showSummary 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

sumText

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:Sum(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

summaryMethod

必填:否;声明来源:上游声明。

summaryMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { columns: AsamTableColumnCtx<T>[]; data: T[]; }): (string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>)[]

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

rowClassName

必填:否;声明来源:上游声明。

rowClassName 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; }): string

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

rowStyle

必填:否;声明来源:上游声明。

rowStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number /** Override the base row array with the existing cross-page keys/rows snapshot. */; }): CSSProperties

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

cellClassName

必填:否;声明来源:上游声明。

cellClassName 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }): string

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

cellStyle

必填:否;声明来源:上游声明。

cellStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }): CSSProperties

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

headerRowClassName

必填:否;声明来源:上游声明。

headerRowClassName 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; }): string

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

headerRowStyle

必填:否;声明来源:上游声明。

headerRowStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number /** Override the base row array with the existing cross-page keys/rows snapshot. */; }): CSSProperties

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

headerCellClassName

必填:否;声明来源:上游声明。

headerCellClassName 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }): string

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

headerCellStyle

必填:否;声明来源:上游声明。

headerCellStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }): CSSProperties

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

highlightCurrentRow

必填:否;声明来源:上游声明。

highlightCurrentRow 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

emptyText

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:No Data(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

defaultExpandAll

必填:否;声明来源:上游声明。

defaultExpandAll 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

rowExpandable

必填:否;声明来源:上游声明。

rowExpandable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, index: number): boolean

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

defaultSort

必填:否;声明来源:上游声明。

defaultSort 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • defaultSort.prop: string — 上游声明

    用作初始排序列的属性。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • defaultSort.order: PublicMember<NonNullable<AsamTableSort | undefined>, "order"> — 上游声明

    初始排序方向;只有提供 prop 且省略 order 时,默认使用升序。

    固定上游文档默认:ascending;条件:已提供 prop,且省略 order。(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:"ascending" / "descending"

  • defaultSort.init: any — 上游声明
  • defaultSort.silent: any — 上游声明
默认值与来源
未知 / 未声明

固定上游文档默认:if `prop` is set, and `order` is not set, then `order` is default to ascending(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

tooltipEffect

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:dark(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

tooltipOptions

必填:否;声明来源:上游声明。

tooltipOptions 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:^[object]`{ enterable: true, placement: 'top', showArrow: true, hideAfter: 200, popperOptions: { strategy: 'fixed' } }`(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

spanMethod

必填:否;声明来源:上游声明。

spanMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; rowIndex: number; column: AsamTableColumnCtx<T>; columnIndex: number; }): number[] | { rowspan: number; colspan: number; } | undefined

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

selectOnIndeterminate

必填:否;声明来源:上游声明。

selectOnIndeterminate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

indent

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:16(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:16(2.14.7;源码事实,未作为 ASAM 运行实测)

treeProps

必填:否;声明来源:上游声明。

treeProps 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • treeProps.hasChildren: string | undefined — 上游声明

    表示存在懒加载子项的行字段名。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    固定上游源码工厂中的字面字段(未执行):'hasChildren'(2.14.7;源码事实,未作为 ASAM 运行实测)

  • treeProps.children: string | undefined — 上游声明

    包含嵌套子数据的行字段名。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    固定上游源码工厂中的字面字段(未执行):'children'(2.14.7;源码事实,未作为 ASAM 运行实测)

  • treeProps.checkStrictly: boolean | undefined — 上游声明

    为 true 时父子选择相互独立;为 false 时父子选择关联。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    固定上游源码工厂中的字面字段(未执行):false(2.14.7;源码事实,未作为 ASAM 运行实测)

    枚举:false / true

默认值与来源
未知 / 未声明

固定上游文档默认:^[object]`{ hasChildren: 'hasChildren', children: 'children', checkStrictly: false }`(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码工厂(未执行):() => { return { hasChildren: 'hasChildren', children: 'children', checkStrictly: false, } }(2.14.7;源码事实,未作为 ASAM 运行实测)

lazy

必填:否;声明来源:上游声明。

lazy 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

load

必填:否;声明来源:上游声明。

load 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, treeNode: AsamTableTreeNode, resolve: (data: T[]) => void): void

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

tableLayout

必填:否;声明来源:ASAM 声明。

tableLayout 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"auto" / "fixed"

默认值与来源
未知 / 未声明

固定上游文档默认:fixed(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'fixed'(2.14.7;源码事实,未作为 ASAM 运行实测)

scrollbarAlwaysOn

必填:否;声明来源:上游声明。

scrollbarAlwaysOn 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

flexible

必填:否;声明来源:上游声明。

flexible 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

showOverflowTooltip

必填:否;声明来源:上游声明。

showOverflowTooltip 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:undefined(2.14.7;源码事实,未作为 ASAM 运行实测)

tooltipFormatter

必填:否;声明来源:上游声明。

tooltipFormatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; column: AsamTableColumnCtx<T>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

appendFilterPanelTo

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

scrollbarTabindex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:undefined(2.14.7;源码事实,未作为 ASAM 运行实测)

allowDragLastColumn

必填:否;声明来源:ASAM 声明。

allowDragLastColumn 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
preserveExpandedContent

必填:否;声明来源:ASAM 声明。

preserveExpandedContent 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
nativeScrollbar

必填:否;声明来源:上游声明。

nativeScrollbar 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

reserveSelection

必填:否;声明来源:ASAM 声明。

reserveSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
AsamDataTableProps 公开类型视图
ts
import type { Attrs, VNode, CSSProperties } from 'vue';
import type { AsamDataTableProps, AsamRecord, AsamRowKey, AsamOptionsCache, AsamRequestConfig, AsamPage, AsamPaginationProps, AsamControlSize, AsamTableSummaryMethod, AsamTableColumnCtx, AsamTableColumnCls, AsamTableColumnStyle, AsamTableCellCls, AsamTableCellStyle, AsamTableSort, AsamTableTreeNode, AsamTableOverflowTooltipFormatter, AsamApiRequest, AsamRequestContext, AsamPageRequest } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamDataTableProps
type PublicContract<Q = AsamRecord, P = unknown, R = unknown, T extends object = AsamRecord> = AsamDataTableProps<Q, P, R, T>;

参数与事件说明

update:currentPage

必填:是;声明来源:ASAM 声明。

update:pageSize

必填:是;声明来源:ASAM 声明。

page-change

必填:是;声明来源:ASAM 声明。

page-size-change

必填:是;声明来源:ASAM 声明。

selection-change

必填:是;声明来源:ASAM 声明。

success

必填:是;声明来源:ASAM 声明。

error

必填:是;声明来源:ASAM 声明。

select

必填:是;声明来源:ASAM 声明。

select-all

必填:是;声明来源:ASAM 声明。

cell-mouse-enter

必填:是;声明来源:ASAM 声明。

cell-mouse-leave

必填:是;声明来源:ASAM 声明。

cell-dblclick

必填:是;声明来源:ASAM 声明。

cell-contextmenu

必填:是;声明来源:ASAM 声明。

cell-click

必填:是;声明来源:ASAM 声明。

row-dblclick

必填:是;声明来源:ASAM 声明。

row-click

必填:是;声明来源:ASAM 声明。

row-contextmenu

必填:是;声明来源:ASAM 声明。

header-click

必填:是;声明来源:ASAM 声明。

header-contextmenu

必填:是;声明来源:ASAM 声明。

sort-change

必填:是;声明来源:ASAM 声明。

filter-change

必填:是;声明来源:ASAM 声明。

current-change

必填:是;声明来源:ASAM 声明。

header-dragend

必填:是;声明来源:ASAM 声明。

expand-change

必填:是;声明来源:ASAM 声明。

scroll

必填:是;声明来源:ASAM 声明。

AsamDataTableEmits 公开类型视图
ts
import type { AsamDataTableEmits, AsamTableSelection, AsamPage, AsamDataError, AsamTableColumnCtx } from '@asam-ui/ui';

// AsamDataTableEmits
type PublicContract<T extends object> = {
	"update:currentPage": [value: number];
	"update:pageSize": [value: number];
	"page-change": [value: number];
	"page-size-change": [value: number];
	"selection-change": [selection: AsamTableSelection<T>];
	"success": [data: AsamPage<T>];
	"error": [error: AsamDataError];
	"select": (AsamDataTableEmits<T>)["select"];
	"select-all": (AsamDataTableEmits<T>)["select-all"];
	"cell-mouse-enter": (AsamDataTableEmits<T>)["cell-mouse-enter"];
	"cell-mouse-leave": (AsamDataTableEmits<T>)["cell-mouse-leave"];
	"cell-dblclick": (AsamDataTableEmits<T>)["cell-dblclick"];
	"cell-contextmenu": (AsamDataTableEmits<T>)["cell-contextmenu"];
	"cell-click": (AsamDataTableEmits<T>)["cell-click"];
	"row-dblclick": (AsamDataTableEmits<T>)["row-dblclick"];
	"row-click": (AsamDataTableEmits<T>)["row-click"];
	"row-contextmenu": (AsamDataTableEmits<T>)["row-contextmenu"];
	"header-click": (AsamDataTableEmits<T>)["header-click"];
	"header-contextmenu": (AsamDataTableEmits<T>)["header-contextmenu"];
	"sort-change": (AsamDataTableEmits<T>)["sort-change"];
	"filter-change": [filters: Record<string, string[]>];
	"current-change": (AsamDataTableEmits<T>)["current-change"];
	"header-dragend": (AsamDataTableEmits<T>)["header-dragend"];
	"expand-change": (AsamDataTableEmits<T>)["expand-change"];
	"scroll": [position: { scrollLeft: number; scrollTop: number; }];
};

参数与事件说明

default

必填:否;声明来源:ASAM 声明。

default 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

toolbar

必填:否;声明来源:ASAM 声明。

toolbar 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: { selection: AsamTableSelection<T>; loading: boolean; stale: boolean; }): unknown

empty

必填:否;声明来源:ASAM 声明。

empty 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

append

必填:否;声明来源:ASAM 声明。

append 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

error

必填:否;声明来源:数据 / provider 协议。

error 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: Parameters<Extract<NonNullable<(AsamDataTableSlots<T>)["error"]>, (...args: never[]) => unknown>>[0]): unknown

AsamDataTableSlots 公开类型视图
ts
import type { AsamDataTableSlots, AsamTableSelection, AsamDataError, AsamPage, AsamReloadResult } from '@asam-ui/ui';

// AsamDataTableSlots
type PublicContract<T extends object> = {
	"default"?: (() => unknown) | undefined;
	"toolbar"?: ((props: { selection: AsamTableSelection<T>; loading: boolean; stale: boolean; }) => unknown) | undefined;
	"empty"?: (() => unknown) | undefined;
	"append"?: (() => unknown) | undefined;
	"error"?: (AsamDataTableSlots<T>)["error"];
};

参数与事件说明

clearSelection

必填:是;声明来源:ASAM 声明。

clearSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

getSelection

必填:是;声明来源:ASAM 声明。

getSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): AsamTableSelection<T>

toggleRowSelection

必填:是;声明来源:ASAM 声明。

toggleRowSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, selected?: boolean | undefined): void

getSelectionRows

必填:是;声明来源:ASAM 声明。

getSelectionRows 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): T[]

toggleAllSelection

必填:是;声明来源:ASAM 声明。

toggleAllSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

updateKeyChildren

必填:是;声明来源:ASAM 声明。

updateKeyChildren 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(key: AsamRowKey, children: T[]): void

reload

必填:是;声明来源:数据 / provider 协议。

reload 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: { readonly force?: boolean; } | undefined): Promise<AsamReloadResult<AsamPage<T>>>

cancel

必填:是;声明来源:数据 / provider 协议。

cancel 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

sort

必填:是;声明来源:上游声明。

sort 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(prop: string, order: string): void

context

必填:是;声明来源:上游声明。

context 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • context.$ready: boolean — 上游声明

    枚举:false / true

  • context.hoverState: (NonNullable<AsamTableContext<T>>)["hoverState"] — 上游声明
    • context.hoverState.cell: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.hoverState.column: AsamTableColumnCtx<T> — 上游声明

      嵌套展开边界:大型实例类型;完整类型见公开类型视图。

    • context.hoverState.row: T — 上游声明
  • context.renderExpanded: (NonNullable<AsamTableContext<T>>)["renderExpanded"] — 上游声明

    事件参数:(__0: Parameters<Extract<NonNullable<(NonNullable<AsamTableContext<T>>)["renderExpanded"]>, (...args: never[]) => unknown>>[0]): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[] | undefined

  • context.store: (NonNullable<AsamTableContext<T>>)["store"] — 上游声明

    嵌套展开边界:大型实例类型;完整类型见公开类型视图。

  • context.layout: AsamDataTableExpose<T>["layout"] — 上游声明
    • context.layout.observers: (NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["observers"] — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.table: AsamTableContext<T> — 上游声明

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • context.layout.store: (NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["store"] — 上游声明

      嵌套展开边界:大型实例类型;完整类型见公开类型视图。

    • context.layout.columns: AsamTableColumnCtx<T>[] — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.fit: boolean — 上游声明

      枚举:false / true

    • context.layout.showHeader: boolean — 上游声明

      枚举:false / true

    • context.layout.heightMap: Record<string, string | number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.height: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.scrollX: Ref<boolean, boolean> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.scrollY: Ref<boolean, boolean> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.bodyWidth: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.fixedWidth: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.rightFixedWidth: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.tableHeight: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.headerHeight: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.appendHeight: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.footerHeight: Ref<number | null, number | null> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.layout.gutterWidth: number — 上游声明
    • context.layout.updateScrollY: () => boolean — 上游声明

      事件参数:(): boolean

    • context.layout.setHeight: (value: string | number | null, prop?: string) => void — 上游声明

      事件参数:(value: string | number | null, prop?: string | undefined): void

    • context.layout.setMaxHeight: (value: string | number | null) => void — 上游声明

      事件参数:(value: string | number | null): void

    • context.layout.getFlattenColumns: () => AsamTableColumnCtx<T>[] — 上游声明

      事件参数:(): AsamTableColumnCtx<T>[]

    • context.layout.updateElsHeight: () => void — 上游声明

      事件参数:(): void

    • context.layout.headerDisplayNone: (elm: HTMLElement) => boolean — 上游声明

      事件参数:(elm: HTMLElement): boolean

    • context.layout.updateColumnsWidth: () => void — 上游声明

      事件参数:(): void

    • context.layout.addObserver: (NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["addObserver"] — 上游声明

      事件参数:(observer: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["addObserver"]>, (...args: never[]) => unknown>>[0]): void

    • context.layout.removeObserver: (NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["removeObserver"] — 上游声明

      事件参数:(observer: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamTableContext<T>>)["layout"]>)["removeObserver"]>, (...args: never[]) => unknown>>[0]): void

    • context.layout.notifyObservers: (event: string) => void — 上游声明

      事件参数:(event: string): void

  • context.refs: AsamTableRefs — 上游声明
    • context.refs.tableWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.headerWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.footerWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.fixedBodyWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.rightFixedBodyWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.bodyWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.refs.appendWrapper: HTMLElement — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.tableId: string — 上游声明
  • context.state: (NonNullable<AsamTableContext<T>>)["state"] — 上游声明
    • context.state.isGroup: Ref<boolean, boolean> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.state.resizeState: Ref<{ width: any; height: any; }, { width: any; height: any; }> — 上游声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.state.doLayout: () => void — 上游声明

      事件参数:(): void

    • context.state.debouncedUpdateLayout: () => void — 上游声明

      事件参数:(): void

  • context.emit: AsamTableNativeEmits<T> — 上游声明

    事件参数:(e: "select", selection: T[], row: T): void

    事件参数:(e: "select-all", selection: T[]): void

    事件参数:(e: "selection-change", newSelection: T[]): void

    事件参数:(e: "cell-mouse-enter" | "cell-mouse-leave" | "cell-dblclick", row: T, column: AsamTableColumnCtx<T>, cell: HTMLTableCellElement, event: MouseEvent): void

    事件参数:(e: "cell-contextmenu" | "cell-click", row: T, column: AsamTableColumnCtx<T>, cell: HTMLTableCellElement, event: PointerEvent): void

    事件参数:(e: "row-dblclick", row: T, column: AsamTableColumnCtx<T> | null, event: MouseEvent): void

    事件参数:(e: "row-click" | "row-contextmenu", row: T, column: AsamTableColumnCtx<T> | null, event: PointerEvent): void

    事件参数:(e: "header-click" | "header-contextmenu", column: AsamTableColumnCtx<T>, event: PointerEvent): void

    事件参数完整签名见公开类型视图。

    事件参数:(e: "filter-change", newFilters: Record<string, string[]>): void

    事件参数:(e: "current-change", currentRow: T | null, oldCurrentRow: T | null): void

    事件参数:(e: "header-dragend", newWidth: number, oldWidth: number, column: AsamTableColumnCtx<T>, event: MouseEvent): void

    事件参数:(e: "expand-change", row: T, expandedRows: T[]): void

    事件参数:(e: "expand-change", row: T, expanded: boolean): void

    事件参数:(e: "scroll", data: { scrollLeft: number; scrollTop: number; }): void

  • context.effect: ReactiveEffect<any> — 依赖声明

    渲染副作用实例。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.data: (NonNullable<AsamTableContext<T>>)["data"] — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.uid: number — 依赖声明
  • context.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

    事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<(NonNullable<AsamTableContext<T>>)["type"]>, (...args: never[]) => unknown>>[1]): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.parent: ComponentInternalInstance | null — 依赖声明
    • context.parent.uid: number — 依赖声明
    • context.parent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "type">>, (...args: never[]) => unknown>>[1]): any

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.parent: ComponentInternalInstance | null — 依赖声明

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • context.parent.root: ComponentInternalInstance — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.appContext: AppContext — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.job: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • context.parent.exposed: Record<string, any> | null — 依赖声明
    • context.parent.exposeProxy: Record<string, any> | null — 依赖声明
    • context.parent.data: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "data"> — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.props: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "props"> — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.attrs: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "attrs"> — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.slots: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "slots"> — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.refs: PublicMember<NonNullable<(NonNullable<AsamTableContext<T>>)["parent"]>, "refs"> — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.emit: (event: string, ...args: any[]) => void — 依赖声明

      事件参数:(event: string, ...args: any[]): void

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • context.parent.isMounted: boolean — 依赖声明

      枚举:false / true

    • context.parent.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • context.parent.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • context.root: ComponentInternalInstance — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.appContext: AppContext — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    父虚拟 DOM 中代表当前组件的 VNode。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    当前组件自身虚拟 DOM 树的根 VNode。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.update: () => void — 依赖声明

    强制更新渲染副作用。

    事件参数:(): void

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.job: (NonNullable<AsamTableContext<T>>)["job"] — 依赖声明

    交给调度器的渲染任务,会检查是否需要更新。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
  • context.exposed: Record<string, any> | null — 依赖声明
  • context.exposeProxy: Record<string, any> | null — 依赖声明
  • context.props: (NonNullable<AsamTableContext<T>>)["props"] — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.attrs: (NonNullable<AsamTableContext<T>>)["attrs"] — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.slots: (NonNullable<AsamTableContext<T>>)["slots"] — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • context.isMounted: boolean — 依赖声明

    枚举:false / true

  • context.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • context.isDeactivated: boolean — 依赖声明

    枚举:false / true

tableLayout

必填:是;声明来源:上游声明。

tableLayout 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"auto" / "fixed"

allowDragLastColumn

必填:是;声明来源:上游声明。

allowDragLastColumn 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

ns

必填:是;声明来源:上游声明。

ns 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • ns.namespace: (NonNullable<(AsamDataTableExpose<T>)["ns"]>)["namespace"] — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • ns.b: (blockSuffix?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined): string

  • ns.e: (element?: string) => string — 上游声明

    事件参数:(element?: string | undefined): string

  • ns.m: (modifier?: string) => string — 上游声明

    事件参数:(modifier?: string | undefined): string

  • ns.be: (blockSuffix?: string, element?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined): string

  • ns.em: (element?: string, modifier?: string) => string — 上游声明

    事件参数:(element?: string | undefined, modifier?: string | undefined): string

  • ns.bm: (blockSuffix?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, modifier?: string | undefined): string

  • ns.bem: (blockSuffix?: string, element?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined): string

  • ns.is: { (name: string, state: boolean | undefined): string; (name: string): string; } — 上游声明

    事件参数:(name: string, state: boolean | undefined): string

    事件参数:(name: string): string

  • ns.cssVar: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • ns.cssVarName: (name: string) => string — 上游声明

    事件参数:(name: string): string

  • ns.cssVarBlock: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • ns.cssVarBlockName: (name: string) => string — 上游声明

    事件参数:(name: string): string

layout

必填:是;声明来源:上游声明。

layout 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • layout.observers: (NonNullable<(AsamDataTableExpose<T>)["layout"]>)["observers"] — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.table: AsamTableContext<T> — 上游声明
    • layout.table.$ready: boolean — 上游声明

      枚举:false / true

    • layout.table.hoverState: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["hoverState"] — 上游声明
      • layout.table.hoverState.cell: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.hoverState.column: AsamTableColumnCtx<T> — 上游声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.hoverState.row: T — 上游声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • layout.table.renderExpanded: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["renderExpanded"] — 上游声明

      事件参数:(__0: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["renderExpanded"]>, (...args: never[]) => unknown>>[0]): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[] | undefined

    • layout.table.store: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["store"] — 上游声明

      嵌套展开边界:大型实例类型;完整类型见公开类型视图。

    • layout.table.layout: AsamDataTableExpose<T>["layout"] — 上游声明

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • layout.table.refs: AsamTableRefs — 上游声明
      • layout.table.refs.tableWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.headerWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.footerWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.fixedBodyWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.rightFixedBodyWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.bodyWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.refs.appendWrapper: HTMLElement — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.tableId: string — 上游声明
    • layout.table.state: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["state"] — 上游声明
      • layout.table.state.isGroup: Ref<boolean, boolean> — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.state.resizeState: Ref<{ width: any; height: any; }, { width: any; height: any; }> — 上游声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.state.doLayout: () => void — 上游声明

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.state.debouncedUpdateLayout: () => void — 上游声明

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • layout.table.emit: AsamTableNativeEmits<T> — 上游声明

      事件参数:(e: "select", selection: T[], row: T): void

      事件参数:(e: "select-all", selection: T[]): void

      事件参数:(e: "selection-change", newSelection: T[]): void

      事件参数:(e: "cell-mouse-enter" | "cell-mouse-leave" | "cell-dblclick", row: T, column: AsamTableColumnCtx<T>, cell: HTMLTableCellElement, event: MouseEvent): void

      事件参数:(e: "cell-contextmenu" | "cell-click", row: T, column: AsamTableColumnCtx<T>, cell: HTMLTableCellElement, event: PointerEvent): void

      事件参数:(e: "row-dblclick", row: T, column: AsamTableColumnCtx<T> | null, event: MouseEvent): void

      事件参数:(e: "row-click" | "row-contextmenu", row: T, column: AsamTableColumnCtx<T> | null, event: PointerEvent): void

      事件参数:(e: "header-click" | "header-contextmenu", column: AsamTableColumnCtx<T>, event: PointerEvent): void

      事件参数完整签名见公开类型视图。

      事件参数:(e: "filter-change", newFilters: Record<string, string[]>): void

      事件参数:(e: "current-change", currentRow: T | null, oldCurrentRow: T | null): void

      事件参数:(e: "header-dragend", newWidth: number, oldWidth: number, column: AsamTableColumnCtx<T>, event: MouseEvent): void

      事件参数:(e: "expand-change", row: T, expandedRows: T[]): void

      事件参数:(e: "expand-change", row: T, expanded: boolean): void

      事件参数:(e: "scroll", data: { scrollLeft: number; scrollTop: number; }): void

    • layout.table.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.data: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["data"] — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.uid: number — 依赖声明
    • layout.table.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["type"]>, (...args: never[]) => unknown>>[1]): any

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.parent: ComponentInternalInstance | null — 依赖声明
      • layout.table.parent.uid: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "type">>, (...args: never[]) => unknown>>[1]): any

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.parent: ComponentInternalInstance | null — 依赖声明

        嵌套展开边界:递归引用;完整类型见公开类型视图。

      • layout.table.parent.root: ComponentInternalInstance — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.appContext: AppContext — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.job: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.exposed: Record<string, any> | null — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.exposeProxy: Record<string, any> | null — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.data: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "data"> — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.props: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "props"> — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.attrs: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "attrs"> — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.slots: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "slots"> — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.refs: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["parent"]>, "refs"> — 依赖声明

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.emit: (event: string, ...args: any[]) => void — 依赖声明

        事件参数:(event: string, ...args: any[]): void

        嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

      • layout.table.parent.isMounted: boolean — 依赖声明

        枚举:false / true

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.isUnmounted: boolean — 依赖声明

        枚举:false / true

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • layout.table.parent.isDeactivated: boolean — 依赖声明

        枚举:false / true

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • layout.table.root: ComponentInternalInstance — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.appContext: AppContext — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.job: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["job"] — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • layout.table.exposed: Record<string, any> | null — 依赖声明
    • layout.table.exposeProxy: Record<string, any> | null — 依赖声明
    • layout.table.props: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["props"] — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.attrs: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["attrs"] — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.slots: (NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["table"]>)["slots"] — 依赖声明

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • layout.table.isMounted: boolean — 依赖声明

      枚举:false / true

    • layout.table.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • layout.table.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • layout.store: (NonNullable<(AsamDataTableExpose<T>)["layout"]>)["store"] — 上游声明

    嵌套展开边界:大型实例类型;完整类型见公开类型视图。

  • layout.columns: AsamTableColumnCtx<T>[] — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.fit: boolean — 上游声明

    枚举:false / true

  • layout.showHeader: boolean — 上游声明

    枚举:false / true

  • layout.heightMap: Record<string, string | number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.height: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.scrollX: Ref<boolean, boolean> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.scrollY: Ref<boolean, boolean> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.bodyWidth: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.fixedWidth: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.rightFixedWidth: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.tableHeight: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.headerHeight: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.appendHeight: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.footerHeight: Ref<number | null, number | null> — 上游声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • layout.gutterWidth: number — 上游声明
  • layout.updateScrollY: () => boolean — 上游声明

    事件参数:(): boolean

  • layout.setHeight: (value: string | number | null, prop?: string) => void — 上游声明

    事件参数:(value: string | number | null, prop?: string | undefined): void

  • layout.setMaxHeight: (value: string | number | null) => void — 上游声明

    事件参数:(value: string | number | null): void

  • layout.getFlattenColumns: () => AsamTableColumnCtx<T>[] — 上游声明

    事件参数:(): AsamTableColumnCtx<T>[]

  • layout.updateElsHeight: () => void — 上游声明

    事件参数:(): void

  • layout.headerDisplayNone: (elm: HTMLElement) => boolean — 上游声明

    事件参数:(elm: HTMLElement): boolean

  • layout.updateColumnsWidth: () => void — 上游声明

    事件参数:(): void

  • layout.addObserver: (NonNullable<(AsamDataTableExpose<T>)["layout"]>)["addObserver"] — 上游声明

    事件参数:(observer: Parameters<Extract<NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["addObserver"]>, (...args: never[]) => unknown>>[0]): void

  • layout.removeObserver: (NonNullable<(AsamDataTableExpose<T>)["layout"]>)["removeObserver"] — 上游声明

    事件参数:(observer: Parameters<Extract<NonNullable<(NonNullable<(AsamDataTableExpose<T>)["layout"]>)["removeObserver"]>, (...args: never[]) => unknown>>[0]): void

  • layout.notifyObservers: (event: string) => void — 上游声明

    事件参数:(event: string): void

store

必填:是;声明来源:上游声明。

store 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

columns

必填:是;声明来源:上游声明。

columns 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

handleHeaderFooterMousewheel

必填:是;声明来源:ASAM 声明。

handleHeaderFooterMousewheel 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: WheelEvent, delta: { pixelX: number; pixelY: number; }): void

handleMouseLeave

必填:是;声明来源:上游声明。

handleMouseLeave 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

tableId

必填:是;声明来源:上游声明。

tableSize

必填:是;声明来源:上游声明。

tableSize 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "large" / "default" / "small"

isHidden

必填:是;声明来源:上游声明。

isHidden 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

isEmpty

必填:是;声明来源:上游声明。

isEmpty 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

renderExpanded

必填:是;声明来源:上游声明。

renderExpanded 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(__0: Parameters<Extract<NonNullable<(AsamDataTableExpose<T>)["renderExpanded"]>, (...args: never[]) => unknown>>[0]): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[] | undefined

resizeProxyVisible

必填:是;声明来源:上游声明。

resizeProxyVisible 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

resizeState

必填:是;声明来源:上游声明。

resizeState 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • resizeState.width: number | null — 上游声明
  • resizeState.height: number | null — 上游声明
  • resizeState.headerHeight: number | null — 上游声明
isGroup

必填:是;声明来源:上游声明。

isGroup 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

bodyWidth

必填:是;声明来源:上游声明。

tableBodyStyles

必填:是;声明来源:上游声明。

tableBodyStyles 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • tableBodyStyles.width: string — 上游声明
emptyBlockStyle

必填:是;声明来源:上游声明。

emptyBlockStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • emptyBlockStyle.width: string — 上游声明
  • emptyBlockStyle.height: string — 上游声明
debouncedUpdateLayout

必填:是;声明来源:上游声明。

debouncedUpdateLayout 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(...args: Parameters<Extract<NonNullable<(AsamDataTableExpose<T>)["debouncedUpdateLayout"]>, (...args: never[]) => unknown>> extends [...infer Rest] ? Rest : never): void | undefined

setCurrentRow

必填:是;声明来源:上游声明。

setCurrentRow 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row?: T | undefined): void

getHalfSelectionRows

必填:是;声明来源:上游声明。

getHalfSelectionRows 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): T[]

clearFilter

必填:是;声明来源:上游声明。

clearFilter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(columnKeys?: string | string[] | undefined): void

toggleRowExpansion

必填:是;声明来源:上游声明。

toggleRowExpansion 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, expanded?: boolean | undefined): void

clearSort

必填:是;声明来源:上游声明。

clearSort 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

doLayout

必填:是;声明来源:上游声明。

doLayout 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

t

必填:是;声明来源:上游声明。

t 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(path: Parameters<Extract<NonNullable<AsamDataTableExpose<T>["t"]>, (...args: never[]) => unknown>>[0], option?: Parameters<Extract<NonNullable<AsamDataTableExpose<T>["t"]>, (...args: never[]) => unknown>>[1]): string

setDragVisible

必填:是;声明来源:上游声明。

setDragVisible 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(visible: boolean): void

computedSumText

必填:是;声明来源:上游声明。

computedEmptyText

必填:是;声明来源:上游声明。

computedTooltipEffect

必填:是;声明来源:上游声明。

computedTooltipOptions

必填:是;声明来源:上游声明。

computedTooltipOptions 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

scrollbarViewStyle

必填:是;声明来源:上游声明。

scrollbarViewStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • scrollbarViewStyle.display: string — 上游声明
  • scrollbarViewStyle.verticalAlign: string — 上游声明
scrollbarStyle

必填:是;声明来源:上游声明。

scrollbarStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • scrollbarStyle.height: string — 上游声明
  • scrollbarStyle.maxHeight: undefined — 上游声明
  • scrollbarStyle.maxHeight: string — 上游声明
  • scrollbarStyle.height: undefined — 上游声明
scrollBarRef

必填:是;声明来源:ASAM 声明。

scrollBarRef 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:复杂类型;完整类型见公开类型视图。

scrollTo

必填:是;声明来源:上游声明。

scrollTo 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options: number | ScrollToOptions, yCoord?: number | undefined): void

setScrollLeft

必填:是;声明来源:上游声明。

setScrollLeft 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(left?: number | undefined): void

setScrollTop

必填:是;声明来源:上游声明。

setScrollTop 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(top?: number | undefined): void

AsamDataTableExpose 公开类型视图
ts
import type { VNode, Ref, ReactiveEffect, ConcreteComponent, ComputedOptions, MethodOptions, Attrs, ComponentInternalInstance, AppContext, RendererNode, RendererElement, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
import type { AsamDataTableExpose, AsamRecord, AsamTableSelection, AsamRowKey, AsamPage, AsamReloadResult, AsamTableContext, AsamTableColumnCtx, AsamTableRefs, AsamTableNativeEmits, AsamTableSort, AsamTableFilter, AsamScrollbarDirection } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamDataTableExpose
type PublicContract<T extends object = AsamRecord> = {
	"clearSelection": () => void;
	"getSelection": () => AsamTableSelection<T>;
	"toggleRowSelection": (row: T, selected?: boolean) => void;
	"getSelectionRows": () => T[];
	"toggleAllSelection": () => void;
	"updateKeyChildren": (key: AsamRowKey, children: T[]) => void;
	readonly "reload": (options?: { readonly force?: boolean; }) => Promise<AsamReloadResult<AsamPage<T>>>;
	readonly "cancel": () => void;
	readonly "sort": (prop: string, order: string) => void;
	readonly "context": AsamTableContext<T>;
	readonly "tableLayout": "auto" | "fixed";
	readonly "allowDragLastColumn": boolean;
	readonly "ns": (AsamDataTableExpose<T>)["ns"];
	readonly "layout": (AsamDataTableExpose<T>)["layout"];
	readonly "store": (AsamDataTableExpose<T>)["store"];
	readonly "columns": AsamTableColumnCtx<T>[];
	readonly "handleHeaderFooterMousewheel": (event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void;
	readonly "handleMouseLeave": () => void;
	readonly "tableId": string;
	readonly "tableSize": "" | "large" | "default" | "small";
	readonly "isHidden": boolean;
	readonly "isEmpty": boolean;
	readonly "renderExpanded": (AsamDataTableExpose<T>)["renderExpanded"];
	readonly "resizeProxyVisible": boolean;
	readonly "resizeState": { width: null | number; height: null | number; headerHeight: null | number; };
	readonly "isGroup": boolean;
	readonly "bodyWidth": string;
	readonly "tableBodyStyles": { width: string; };
	readonly "emptyBlockStyle": { width: string; height: string; } | undefined;
	readonly "debouncedUpdateLayout": (AsamDataTableExpose<T>)["debouncedUpdateLayout"];
	readonly "setCurrentRow": (row?: T | undefined) => void;
	readonly "getHalfSelectionRows": () => T[];
	readonly "clearFilter": (columnKeys?: string[] | string) => void;
	readonly "toggleRowExpansion": (row: T, expanded?: boolean) => void;
	readonly "clearSort": () => void;
	readonly "doLayout": () => void;
	readonly "t": AsamDataTableExpose<T>["t"];
	readonly "setDragVisible": (visible: boolean) => void;
	readonly "computedSumText": string;
	readonly "computedEmptyText": string;
	readonly "computedTooltipEffect": string | undefined;
	readonly "computedTooltipOptions": (AsamDataTableExpose<T>)["computedTooltipOptions"];
	readonly "scrollbarViewStyle": { display: string; verticalAlign: string; };
	readonly "scrollbarStyle": { height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; };
	readonly "scrollBarRef": (AsamDataTableExpose<T>)["scrollBarRef"];
	readonly "scrollTo": (options: ScrollToOptions | number, yCoord?: number) => void;
	readonly "setScrollLeft": (left?: number) => void;
	readonly "setScrollTop": (top?: number) => void;
};

组合契约按分支生效;请同时查看公开类型。

参数与事件说明

data

必填:否;声明来源:数据 / provider 协议。

rowKey

必填:否;声明来源:数据 / provider 协议。

rowKey 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T): AsamRowKey

cache

必填:否;声明来源:数据 / provider 协议。

cache 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

  • cache.ttlMs: number — 数据 / provider 协议
  • cache.key: ((requestInput: unknown) => string) | undefined — 数据 / provider 协议

    事件参数:(requestInput: unknown): string

query

必填:否;声明来源:数据 / provider 协议。

queryKey

必填:否;声明来源:数据 / provider 协议。

queryKey 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q): string

immediate

必填:否;声明来源:数据 / provider 协议。

immediate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

currentPage

必填:否;声明来源:数据 / provider 协议。

pageSize

必填:否;声明来源:数据 / provider 协议。

defaultSelectedRowKeys

必填:否;声明来源:数据 / provider 协议。

api

必填:否;声明来源:数据 / provider 协议。

api 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(params: P, context: AsamRequestContext): Promise<R>

buildPageParams

必填:否;声明来源:数据 / provider 协议。

buildPageParams 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q, page: AsamPageRequest): P

request

必填:否;声明来源:数据 / provider 协议。

request 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • request.url: string — 数据 / provider 协议
  • request.method: "delete" | "get" | "post" | "put" | undefined — 数据 / provider 协议

    枚举:"delete" / "get" / "post" / "put"

  • request.params: Readonly<Record<string, unknown>> | undefined — 数据 / provider 协议
  • request.data: unknown — 数据 / provider 协议
buildPageRequest

必填:否;声明来源:数据 / provider 协议。

buildPageRequest 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(query: Q, page: AsamPageRequest): AsamRequestConfig

pageTarget

必填:否;声明来源:数据 / provider 协议。

pageTarget 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"data" / "params"

transform

必填:否;声明来源:数据 / provider 协议。

transform 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(response: R): AsamPage<T>

事件参数:(response: R): AsamPage<T>

AsamPagedInput 公开类型视图
ts
import type { AsamPagedInput, AsamRecord, AsamRowKey, AsamOptionsCache, AsamApiRequest, AsamRequestContext, AsamPageRequest, AsamPage, AsamRequestConfig } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamPagedInput
type PublicContract<Q = AsamRecord, P = unknown, R = unknown, T extends object = AsamRecord> = AsamPagedInput<Q, P, R, T>;

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭