数据展示

表格 AsamTable

展示已经获得的结构化行数据,并管理选择、排序和本地加载呈现。

使用场景 ​

展示已经获得的结构化行数据,并管理选择、排序和本地加载呈现。

契约与组合 ​

行数据由 data 提供,row-key 支持字段路径或函数。 完整说明。

getSelectionRows 返回全选行,getHalfSelectionRows 返回 checkStrictly=false 的真实半选父行;getSelection 是 ASAM 当前选择快照。 完整说明。

列的 prop 可以使用嵌套字段路径。 完整说明。

固定列、固定表头、分组表头、展开详情、树与懒加载、排序、筛选、合并及汇总都使用真实 Table / TableColumn 入口。 完整说明。

完整实例公开面 ​

ref 的顶层值采用 Vue 浅解包:直接读取 isEmpty / columns / tableLayout,不再读取 .value。 完整说明。

字段/方法 值与调用契约
ns 原生 namespace 视图,可读取 b / e / m 等类名函数。
layout 原生布局对象的只读借用视图;观察布局结果。
store 原生选择、列与树状态的只读借用视图;不承诺任意私有子命令。
columns 当前表头第一层的 TableColumnCtx<Row>[] 计算视图。
handleHeaderFooterMousewheel (event: WheelEvent, delta: { pixelX: number; pixelY: number });处理已归一化的表头/表尾滚轮。
handleMouseLeave () => void;清除行悬停状态及原生 hover 记录。
tableId 原生实例的 string 标识。
tableSize 原生有效密度:空字符串 / large / default / small;ASAM 的 big 映射由尺寸作用域负责。
isHidden boolean;原生布局初始化隐藏状态。
isEmpty boolean;当前原生数据是否为空。
renderExpanded 原生显式 expose 的展开渲染器引用:函数或 null。2.14.7 的列实际写入 context.renderExpanded,因此展开正文可正常渲染而该独立引用仍为 null;不要据此判断是否存在展开列。
resizeProxyVisible boolean;表头调整列宽代理是否显示。
resizeState width / height / headerHeight 为 number 或 null 的测量视图。
isGroup boolean;是否存在分组表头。
bodyWidth string;原生表体布局宽度。
tableBodyStyles { width: string };表体的计算样式。
emptyBlockStyle { width: string; height: string } 或 undefined;空数据块的计算样式。
debouncedUpdateLayout 可调用的延迟布局更新函数,同时保留 cancel() 与 flush()。
setCurrentRow (row?: Row) => void;设置当前行,无参数清除。
getSelectionRows () => Row[];返回全选行。
getHalfSelectionRows () => Row[];checkStrictly=false 时返回半选父行。
toggleRowSelection (row: Row, selected?: boolean, ignoreSelectable?: boolean) => void;切换或明确设定行选择。
clearSelection () => void;清除选择并抑制当前 ASAM 默认选择意图。
clearFilter (columnKeys?: string | string[]) => void;按列键或全部清除筛选。
toggleAllSelection () => void;切换全部行选择。
toggleRowExpansion (row: Row, expanded?: boolean) => void;切换详情/树展开。
clearSort () => void;清除排序。
doLayout () => void;重算原生布局。
sort (prop: string, order: string) => void;按公开列字段与原生排序顺序更新。
updateKeyChildren (key: string, children: Row[]) => void;更新已懒加载的子节点,并继续应用未被用户清除的默认子节点意图。
t 原生 Translator;按 locale 键和可选命名参数翻译。
setDragVisible (visible: boolean) => void;设置列宽拖动代理可见性。
context 原生 Table<Row> 上下文的只读借用视图;可观察当前原生上下文,私有子命令不作为稳定的业务 API。
computedSumText string;有效汇总标题。
computedEmptyText string;有效空数据文案。
computedTooltipEffect 有效 tooltip effect 或 undefined。
computedTooltipOptions 有效原生 tooltip options 对象或 undefined。
tableLayout auto / fixed;当前有效表格布局。
scrollbarViewStyle 原生滚动内容样式对象。
scrollbarStyle 随 height / maxHeight 与表头表尾高度计算的滚动视窗样式对象。
scrollBarRef 实际滚动条实例或 undefined(挂载前/卸载后);支持 Scrollbar 公开方法和 DOM wrapRef。
scrollTo 原生 scrollTo 数字坐标或 ScrollToOptions 签名;滚动表体。
setScrollLeft (left?: number) => void;设置水平滚动位置。
setScrollTop (top?: number) => void;设置垂直滚动位置。
allowDragLastColumn boolean;原生显式 expose 的初始 prop 快照,不承诺响应式跟随后续 prop 改变。

默认选择支持树形后代与行键;懒加载后继续应用选择意图。 完整说明。

模板与预览边界 ​

TS 列插槽需要显式 Row 时,使用列前的 @vue-generic 注释;完整 usage-custom-column 与 basic 示例可直接运行。 完整说明。

基础用法与状态 ​

基础用法与状态

展开源码

树后代与懒加载默认选择 ​

树后代与懒加载默认选择

展开源码

基础表格 ​

基础表格

展开源码

可选择的树形数据 ​

可选择的树形数据

展开源码

自定义列模板 ​

自定义列模板

展开源码

自定义表头 ​

自定义表头

展开源码

自定义索引 ​

自定义索引

展开源码

展开行 ​

展开行

展开源码

筛选 ​

筛选

展开源码

固定列 ​

固定列

展开源码

固定表头 ​

固定表头

展开源码

固定列和表头 ​

固定列和表头

展开源码

固定表头 ​

固定表头

展开源码

流体高度 ​

流体高度

展开源码

多级表头 ​

多级表头

展开源码

多选 ​

多选

展开源码

合并行或列 ​

合并行或列

展开源码

显示溢出工具提示的表格 ​

显示溢出工具提示的表格

展开源码

单选 ​

单选

展开源码

排序 ​

排序

展开源码

带斑马纹表格 ​

带斑马纹表格

展开源码

表尾合计行 ​

表尾合计行

展开源码

追加内容与汇总行 ​

append 用于最后一条数据之后的操作区域。 完整说明。

追加内容与汇总行

展开源码

表格布局 ​

表格布局

展开源码

提示内容格式化 ​

提示内容格式化

展开源码

树形数据与懒加载 ​

树形数据与懒加载

展开源码

带边框表格 ​

带边框表格

展开源码

带状态表格 ​

带状态表格

展开源码

实例、类型与边界 ​

公开 API 与下列完整 SFC 来自同一组件入口。TS 和 JS 演示分别提供所有本地依赖文件;类型约束只出现在 TS 中。远程请求与业务持久化由宿主承担。

API

类型 AsamTableRow

类型 AsamTableRowKey

类型 AsamTableRowKeyGetter

ts
(row: Row): AsamTableRowKey

属性 AsamTableProps

属性名说明类型默认值
data表数据Row[] | undefined() => []
tableLayout原生自动或固定布局;追加内容和合计行顺序遵循原生表格。enum"auto" | "fixed"完整类型:("auto" | "fixed") | undefined—
selectable—boolean | undefinedfalse
rowKey行数据的 Key,用来优化 Table 的渲染;在使用reserve-selection功能与显示树形数据时,该属性是必填的。 详情string | AsamTableRowKeyGetter<Row> | undefined'id'
defaultSelectedRowKeys—AsamTableRowKey[] | undefined() => []
reserveSelection—boolean | undefinedtrue
loading—boolean | undefinedfalse
minWidth—string | undefined'100%'
pagination—AsamPaginationProps | undefined—
allowDragLastColumn是否允许拖动最后一列boolean | undefinedfalse
preserveExpandedContent在折叠后是否在DOM中保留展开行内容boolean | undefinedfalse
style—AsamTableProps<Row>["style"]false
className—string | undefined—
width—string | number | undefined—
heighttable 的高度。默认为自动高度。如果 height 为 number 类型,单位 px;如果 height 为 string 类型,则这个高度会设置为 Table 的 style.height 的值,Table 的高度会受控于外部样式。string | number | undefined—
maxHeighttable 的最大高度。合法的值为数字或者单位为 px 的高度。string | number | undefined—
fit列的宽度是否自撑开boolean | undefinedfalse
stripe是否为斑马纹 tableboolean | undefinedfalse
border是否带有纵向边框boolean | undefinedfalse
showHeader是否显示表头boolean | undefinedfalse
showSummary是否在表尾显示合计行boolean | undefinedfalse
sumText显示摘要行第一列的文本string | undefined—
summaryMethod自定义的合计计算方法(AsamTableProps<Row>)["summaryMethod"]—
rowClassName行的 className 的回调方法,也可以使用字符串为所有行设置一个固定的 className。(AsamTableProps<Row>)["rowClassName"]—
rowStyle行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style。(AsamTableProps<Row>)["rowStyle"]—
cellClassName单元格的 className 的回调方法,也可以使用字符串为所有单元格设置一个固定的 className。(AsamTableProps<Row>)["cellClassName"]—
cellStyle单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有单元格设置一样的 Style。(AsamTableProps<Row>)["cellStyle"]—
headerRowClassName表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className。(AsamTableProps<Row>)["headerRowClassName"]—
headerRowStyle表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style。(AsamTableProps<Row>)["headerRowStyle"]—
headerCellClassName表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className。(AsamTableProps<Row>)["headerCellClassName"]—
headerCellStyle表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。(AsamTableProps<Row>)["headerCellStyle"]—
highlightCurrentRow是否要高亮当前行boolean | undefinedfalse
currentRowKey当前行的 key,只写属性string | number | undefined—
emptyText空数据时显示的文本内容,也可以通过 #empty 设置string | undefined'暂无数据'
expandRowKeys可以通过该属性设置 Table 目前的展开行,需要设置 row-key 属性才能使用,该属性为展开行的 keys 数组。string[] | undefined—
defaultExpandAll是否默认展开所有行,当 Table 包含展开行存在或者为树形表格时有效boolean | undefinedfalse
rowExpandable启用可展开行,当表格具有 type="expand" 列时有效(AsamTableProps<Row>)["rowExpandable"]—
defaultSort默认的排序列的 prop 和顺序。它的 prop 属性指定默认的排序的列,order 指定默认排序的顺序AsamTableSort | undefined—
tooltipEffect溢出的 tooltip 的 effectstring | undefined—
tooltipOptions溢出提示配置,参阅提示组件参数。(AsamTableProps<Row>)["tooltipOptions"]—
spanMethod合并行或列的计算方法(AsamTableProps<Row>)["spanMethod"]—
selectOnIndeterminate在多选表格中,当仅有部分行被选中时,点击表头的多选框时的行为。若为 true,则选中所有行;若为 false,则取消选择所有行boolean | undefinedfalse
indent展示树形数据时,树节点的缩进number | undefined—
treeProps渲染嵌套数据的配置选项(AsamTableProps<Row>)["treeProps"]—
lazy是否懒加载子节点数据boolean | undefinedfalse
load加载子节点数据的函数,lazy 为 true 时生效(AsamTableProps<Row>)["load"]—
scrollbarAlwaysOn总是显示滚动条boolean | undefinedfalse
flexible确保主轴的最小尺寸,以便不超过内容boolean | undefinedfalse
showOverflowTooltip是否隐藏溢出内容并在悬停单元格时显示提示,作用于全部列。(AsamTableProps<Row>)["showOverflowTooltip"]false
tooltipFormatter格式化单元格提示内容的函数,show-overflow-tooltip 为 true 时生效。(AsamTableProps<Row>)["tooltipFormatter"]—
appendFilterPanelTo挂载到哪个 DOM 元素string | undefined—
scrollbarTabindexbody 的滚动条的包裹容器 tabindexstring | number | undefined—
nativeScrollbar是否使用原生滚动条样式boolean | undefinedfalse
sizeTable 的尺寸enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—

事件 AsamTableEmits

属性名说明类型默认值
select—[selection: Row[], row: Row]—
select-all—[selection: Row[]]—
selection-change—[selection: Row[]]—
cell-mouse-enter—[row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent]—
cell-mouse-leave—[row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent]—
cell-contextmenu—[row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: PointerEvent]—
cell-click—[row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: PointerEvent]—
cell-dblclick—[row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent]—
row-click—[row: Row, column: AsamTableColumnCtx<Row> | null, event: PointerEvent]—
row-contextmenu—[row: Row, column: AsamTableColumnCtx<Row> | null, event: PointerEvent]—
row-dblclick—[row: Row, column: AsamTableColumnCtx<Row> | null, event: MouseEvent]—
header-click—[column: AsamTableColumnCtx<Row>, event: PointerEvent]—
header-contextmenu—[column: AsamTableColumnCtx<Row>, event: PointerEvent]—
sort-change—[sort: { column: AsamTableColumnCtx<Row>; prop: string | null; order: "ascending" | "descending" | null; }]—
filter-change—[filters: Record<string, string[]>]—
current-change—[currentRow: Row | null, oldCurrentRow: Row | null]—
header-dragend—[newWidth: number, oldWidth: number, column: AsamTableColumnCtx<Row>, event: MouseEvent]—
expand-change—[row: Row, expanded: boolean | Row[]]—
scroll—[position: { scrollLeft: number; scrollTop: number; }]—
page-change—[page: number]—
page-size-change—[pageSize: number]—

插槽 AsamTableSlots

属性名说明类型默认值
default—(() => unknown) | undefined—
append原生追加插槽;布局及合计行顺序遵循固定上游版本。(() => unknown) | undefined—
empty—(() => unknown) | undefined—
toolbar—((props: { selection: Row[]; }) => unknown) | undefined—

实例方法与状态 AsamTableExpose

属性名说明类型默认值
sort手动排序表格。参数 prop 属性指定排序列,order 指定排序顺序。(prop: string, order: string) => void—
context—(AsamTableExpose<Row>)["context"]—
tableLayout—enum"auto" | "fixed"完整类型:"auto" | "fixed"—
allowDragLastColumn是否允许拖动最后一列boolean—
ns—(AsamTableExpose<Row>)["ns"]—
layout—(AsamTableExpose<Row>)["layout"]—
store—(AsamTableExpose<Row>)["store"]—
columns—(AsamTableExpose<Row>)["columns"]—
handleMouseLeave—() => void—
tableId—string—
tableSize—enum"" | "large" | "default" | "small"完整类型:"" | "large" | "default" | "small"—
isHidden—boolean—
isEmpty—boolean—
renderExpanded—(AsamTableExpose<Row>)["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—(AsamTableExpose<Row>)["debouncedUpdateLayout"]—
setCurrentRow用于单选表格,设定某一行为选中行,如果调用时不加参数,则会取消目前高亮行的选中状态。(AsamTableExpose<Row>)["setCurrentRow"]—
getSelectionRows返回当前选中的行(AsamTableExpose<Row>)["getSelectionRows"]—
getHalfSelectionRows返回当前半选中的行(AsamTableExpose<Row>)["getHalfSelectionRows"]—
toggleRowSelection用于多选表格,切换某一行的选中状态,如果使用了第二个参数,则可直接设置这一行选中与否(AsamTableExpose<Row>)["toggleRowSelection"]—
clearSelection用于多选表格,清空用户的选择() => void—
clearFilter传入由columnKey 组成的数组以清除指定列的过滤条件。如果没有参数,清除所有过滤器(columnKeys?: string[] | string) => void—
toggleAllSelection用于多选表格,切换全选和全不选() => void—
toggleRowExpansion用于可扩展的表格或树表格,如果某行被扩展,则切换。使用第二个参数,您可以直接设置该行应该被扩展或折叠。(AsamTableExpose<Row>)["toggleRowExpansion"]—
clearSort用于清空排序条件,数据会恢复成未排序的状态() => void—
doLayout对 Table 进行重新布局。当表格可见性变化时,您可能需要调用此方法以获得正确的布局() => void—
updateKeyChildren适用于 lazy Table, 需要设置 rowKey, 更新 key children(AsamTableExpose<Row>)["updateKeyChildren"]—
t—AsamTableExpose<Row>["t"]—
setDragVisible—(visible: boolean) => void—
computedSumText—string—
computedEmptyText—string—
computedTooltipEffect—string | undefined—
computedTooltipOptions—(AsamTableExpose<Row>)["computedTooltipOptions"]—
scrollbarViewStyle—{ display: string; verticalAlign: string; }—
scrollbarStyle—{ height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; }—
scrollTo滚动到一组特定坐标(options: ScrollToOptions | number, yCoord?: number) => void—
setScrollLeft设置水平滚动位置(left?: number) => void—
setScrollTop设置垂直滚动位置(top?: number) => void—
scrollBarRef—(AsamTableExpose<Row>)["scrollBarRef"]—
handleHeaderFooterMousewheel—(event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void—
getSelection—() => Row[]—

类型 AsamTableInstance

属性名说明类型默认值
sort手动排序表格。参数 prop 属性指定排序列,order 指定排序顺序。(prop: string, order: string) => void—
context—(AsamTableInstance<Row>)["context"]—
tableLayout—enum"auto" | "fixed"完整类型:"auto" | "fixed"—
allowDragLastColumn是否允许拖动最后一列boolean—
ns—(AsamTableInstance<Row>)["ns"]—
layout—(AsamTableInstance<Row>)["layout"]—
store—(AsamTableInstance<Row>)["store"]—
columns—(AsamTableInstance<Row>)["columns"]—
handleMouseLeave—() => void—
tableId—string—
tableSize—enum"" | "large" | "default" | "small"完整类型:"" | "large" | "default" | "small"—
isHidden—boolean—
isEmpty—boolean—
renderExpanded—(AsamTableInstance<Row>)["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—(AsamTableInstance<Row>)["debouncedUpdateLayout"]—
setCurrentRow用于单选表格,设定某一行为选中行,如果调用时不加参数,则会取消目前高亮行的选中状态。(AsamTableInstance<Row>)["setCurrentRow"]—
getSelectionRows返回当前选中的行(AsamTableInstance<Row>)["getSelectionRows"]—
getHalfSelectionRows返回当前半选中的行(AsamTableInstance<Row>)["getHalfSelectionRows"]—
toggleRowSelection用于多选表格,切换某一行的选中状态,如果使用了第二个参数,则可直接设置这一行选中与否(AsamTableInstance<Row>)["toggleRowSelection"]—
clearSelection用于多选表格,清空用户的选择() => void—
clearFilter传入由columnKey 组成的数组以清除指定列的过滤条件。如果没有参数,清除所有过滤器(columnKeys?: string[] | string) => void—
toggleAllSelection用于多选表格,切换全选和全不选() => void—
toggleRowExpansion用于可扩展的表格或树表格,如果某行被扩展,则切换。使用第二个参数,您可以直接设置该行应该被扩展或折叠。(AsamTableInstance<Row>)["toggleRowExpansion"]—
clearSort用于清空排序条件,数据会恢复成未排序的状态() => void—
doLayout对 Table 进行重新布局。当表格可见性变化时,您可能需要调用此方法以获得正确的布局() => void—
updateKeyChildren适用于 lazy Table, 需要设置 rowKey, 更新 key children(AsamTableInstance<Row>)["updateKeyChildren"]—
t—AsamTableInstance<Row>["t"]—
setDragVisible—(visible: boolean) => void—
computedSumText—string—
computedEmptyText—string—
computedTooltipEffect—string | undefined—
computedTooltipOptions—(AsamTableInstance<Row>)["computedTooltipOptions"]—
scrollbarViewStyle—{ display: string; verticalAlign: string; }—
scrollbarStyle—{ height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; }—
scrollTo滚动到一组特定坐标(options: ScrollToOptions | number, yCoord?: number) => void—
setScrollLeft设置水平滚动位置(left?: number) => void—
setScrollTop设置垂直滚动位置(top?: number) => void—
scrollBarRef—(AsamTableInstance<Row>)["scrollBarRef"]—
handleHeaderFooterMousewheel—(event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void—
getSelection—() => Row[]—

类型 AsamTableCellCls

类型 AsamTableCellStyle

类型 AsamTableColumnCls

类型 AsamTableColumnStyle

类型 AsamTableFilter

属性名说明类型默认值
column—AsamTableColumnCtx<T>—
values—string[]—
silent—any—

类型 AsamTableRenderRowData

属性名说明类型默认值
store—(AsamTableRenderRowData<T>)["store"]—
_self—AsamTableContext<T>—
column—AsamTableColumnCtx<T>—
row—T—
$index—number—
cellIndex—number—
treeNode—AsamTableTreeNode | undefined—
expanded—boolean—

类型 AsamTableSort

属性名说明类型默认值
prop—string—
order—enum"ascending" | "descending"完整类型:AsamTableSort["order"]—
init—any—
silent—any—

类型 AsamTableSummaryMethod

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

类型 AsamTableContext

属性名说明类型默认值
$ready—boolean—
hoverState—(AsamTableContext<T>)["hoverState"]—
renderExpanded—(AsamTableContext<T>)["renderExpanded"]—
store—(AsamTableContext<T>)["store"]—
layout—(AsamTableContext<T>)["layout"]—
refs—AsamTableRefs—
tableId—string—
state—AsamTableContext<T>["state"]—
emit—AsamTableNativeEmits<T>—
effect渲染副作用实例。ReactiveEffect<any>—
data—AsamTableV2Expose["$refs"]—
uid—number—
type—ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any>—
parent—AsamTableV2Expose["$"] | null—
root—AsamTableV2Expose["$"]—
appContext—AsamTableContext<T>["appContext"]—
vnode父虚拟 DOM 中代表当前组件的 VNode。VNode<RendererNode, RendererElement, { [key: string]: any; }>—
subTree当前组件自身虚拟 DOM 树的根 VNode。VNode<RendererNode, RendererElement, { [key: string]: any; }>—
update强制更新渲染副作用。() => void—
job交给调度器的渲染任务,会检查是否需要更新。AsamTableContext<T>["job"]—
proxy—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
exposed—Record<string, any> | null—
exposeProxy—Record<string, any> | null—
props—AsamTableV2Expose["$refs"]—
attrs—AsamTableV2Expose["$refs"]—
slots—AsamTableContext<T>["slots"]—
isMounted—boolean—
isUnmounted—boolean—
isDeactivated—boolean—

类型 AsamTableColumnCtx

属性名说明类型默认值
id—string—
realWidth—number | null—
type—string—
label—string—
className—string—
labelClassName—string—
property—string—
prop—string—
width—string | number | undefined—
minWidth—string | number—
renderHeader—(AsamTableColumnCtx<T>)["renderHeader"]—
sortable—string | boolean—
sortMethod—(a: T, b: T) => number—
sortBy—string | string[] | ((row: T, index: number, array?: T[]) => string)—
resizable—boolean—
columnKey—string—
rawColumnKey—string—
align—string—
headerAlign—string—
showOverflowTooltip—(AsamTableColumnCtx<T>)["showOverflowTooltip"]—
tooltipFormatter—AsamTableOverflowTooltipFormatter<T> | undefined—
fixed—string | boolean—
formatter—(row: T, column: AsamTableColumnCtx<T>, cellValue: any, index: number) => VNode | string—
selectable—(row: T, index: number) => boolean—
reserveSelection—boolean—
filterMethod—(AsamTableColumnCtx<T>)["filterMethod"]—
filteredValue—string[]—
filters—AsamTableColumnCtx<T>["filters"]—
filterPlacement—string—
filterMultiple—boolean—
filterClassName—string—
index—number | ((index: number) => number)—
sortOrders—(AsamTableSort["order"] | null)[]—
renderCell—(data: any) => VNode | VNode[]—
colSpan—number—
rowSpan—number—
children—AsamTableColumnCtx<T>[] | undefined—
level—number—
filterable—(AsamTableColumnCtx<T>)["filterable"]—
order—enum"ascending" | "descending"完整类型:AsamTableSort["order"] | null—
isColumnGroup—boolean—
isSubColumn—boolean—
columns—AsamTableColumnCtx<T>[]—
getColumnIndex—() => number—
no—number—
filterOpened—boolean | undefined—
renderFilterIcon—((scope: any) => VNode) | undefined—
renderExpand—((scope: any) => VNode) | undefined—

类型 AsamTableConfigContext

属性名说明类型默认值
showOverflowTooltip—(AsamTableConfigContext)["showOverflowTooltip"]—
tooltipEffect—string | undefined—
tooltipOptions—(AsamTableConfigContext)["tooltipOptions"]—
tooltipFormatter—AsamTableOverflowTooltipFormatter<any> | undefined—

类型 AsamTableRefs

属性名说明类型默认值
tableWrapper—AsamTableRefs["tableWrapper"]—
headerWrapper—AsamTableRefs["tableWrapper"]—
footerWrapper—AsamTableRefs["tableWrapper"]—
fixedBodyWrapper—AsamTableRefs["tableWrapper"]—
rightFixedBodyWrapper—AsamTableRefs["tableWrapper"]—
bodyWrapper—AsamTableRefs["tableWrapper"]—
appendWrapper—AsamTableRefs["tableWrapper"]—

类型 AsamTableTooltipData

属性名说明类型默认值
row—T—
column—AsamTableColumnCtx<T>—
cellValue—any—

类型 AsamTableTreeNode

属性名说明类型默认值
expanded—boolean | undefined—
loading—boolean | undefined—
noLazyChildren—boolean | undefined—
indent—number | undefined—
level—number | undefined—
display—boolean | undefined—

用法与契约补充说明 ​

契约与组合 ​

行数据由 data 提供,row-key 支持字段路径或函数。原生表格 props、事件与实例方法保留 Row 泛型;ASAM 增加四档 size(控件密度)、loading、默认选中键、跨数据刷新选择保留、工具栏和分页。密度使用 large / big / default / small;行高由内容和行密度决定。使用 selectable 生成选择列,或自行放置 type="selection" 的列,两种方式任选其一。defaultSelectedRowKeys 是默认选择意图;用户清除或取消后的选择不会因无关刷新反复恢复。

契约与组合 ​

getSelectionRows 返回全选行,getHalfSelectionRows 返回 checkStrictly=false 的真实半选父行;getSelection 是 ASAM 当前选择快照。实例参数及返回值保留具体 Row,类型示例同时拒绝错误字段。row-click / row-contextmenu / row-dblclick 的 column 可能为 null,清空排序时 sort-change.prop 可能为 null。

契约与组合 ​

列的 prop 可以使用嵌套字段路径。父 Table 的 Row 不会自动成为所有子列的模板类型;TS 作用域插槽在对应列前添加 <!-- @vue-generic {Row} -->,或用 const RowColumn = AsamTableColumn<Row>。JS 使用普通数据对象。tooltipFormatter 支持字符串和 VNode,Table 的默认格式可以被某一列覆盖。

契约与组合 ​

固定列、固定表头、分组表头、展开详情、树与懒加载、排序、筛选、合并及汇总都使用真实 Table / TableColumn 入口。懒加载 resolve 在 Table 卸载后被忽略,避免迟到数据改变已销毁实例;宿主定时器或请求仍由宿主在卸载时取消。filteredValue 属于父状态,确认面板筛选不会原地修改传入数组。

完整实例公开面 ​

ref 的顶层值采用 Vue 浅解包:直接读取 isEmpty / columns / tableLayout,不再读取 .value。全部45项对齐固定2.14.7的显式 defineExpose;对象视图只读借用,不直接修改,业务动作优先使用具名公开方法。具体类型由 AsamTableExpose<Row> 保留;ASAM 另加 getSelection(): Row[] 当前选择快照。

模板与预览边界 ​

TS 列插槽需要显式 Row 时,使用列前的 @vue-generic 注释;完整 usage-custom-column 与 basic 示例可直接运行。图片可以作为列的 default 内容;预览由 AsamImage 提供,设置其 previewTeleported 为 true 将预览层传送到外部,避免表格固定列或滚动层的裁剪。表格负责承载普通插槽内容,图片及预览能力以该组件文档为准。直接写在 HTML DOM 中的组件必须使用完整闭合标签;SFC 编译支持自闭合,但浏览器 HTML 解析器不会将自定义标签当作 input/img。

追加内容与汇总行 ​

append 用于最后一条数据之后的操作区域。开启 show-summary 时,追加内容显示在汇总行上方;table-layout="auto" 与 fixed 均遵守这个顺序。固定高度的表格保留汇总行的原生吸底行为,滚动到底部可见追加操作。summary-method 仍可返回字符串或 VNode,自定义空表插槽位于追加内容之前。

更多参数与事件说明 ​

完整实例公开面 ​

默认选中遍历 treeProps.children(默认 children)的所有后代,支持嵌套字符串与函数 row-key;懒加载 resolve 后继续应用默认意图,公开 updateKeyChildren 更新已记录子节点。用户清除、单行取消、全选清除或关联父行取消后,无关数据刷新不会恢复被取消的默认后代。完整 tree-defaults 示例包含自定义 nodes、静态后代与延迟解析子节点,宿主取消自有计时器。

参数与事件补充说明
AsamTableRow 公开类型视图
ts
import type { AsamTableRow } from '@asam-ui/ui';

// AsamTableRow
type PublicContract = AsamTableRow;

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

AsamTableRowKey 公开类型视图
ts
import type { AsamTableRowKey } from '@asam-ui/ui';

// AsamTableRowKey
type PublicContract = AsamTableRowKey;
AsamTableRowKeyGetter 公开类型视图
ts
import type { AsamTableRowKeyGetter, AsamTableRowKey } from '@asam-ui/ui';

// AsamTableRowKeyGetter
type PublicContract<Row extends object = object> = {
	(row: Row): AsamTableRowKey;
};

完整表格契约,并保留 ASAM 选择、页脚与加载扩展。

参数与事件说明

data

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

默认值与来源
() => [](源码表达式;ASAM 声明)
tableLayout

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

tableLayout 参数与事件数据

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

枚举:"auto" / "fixed"

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

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

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

selectable

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

selectable 参数与事件数据

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

枚举:false / true

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

行数据的 Key,用来优化 Table 的渲染;在使用reserve-selection功能与显示树形数据时,该属性是必填的。类型为 String 时,支持多层访问:user.info.id,但不支持 user.info[0].id,此种情况请使用 Function。

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

rowKey 参数与事件数据

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

事件参数:(row: Row): AsamTableRowKey

默认值与来源
'id'(源码表达式;ASAM 声明)
defaultSelectedRowKeys

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

默认值与来源
() => [](源码表达式;ASAM 声明)
reserveSelection

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

reserveSelection 参数与事件数据

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

枚举:false / true

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

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

loading 参数与事件数据

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

枚举:false / true

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

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

默认值与来源
'100%'(源码表达式;ASAM 声明)
pagination

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

pagination 参数与事件数据

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

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

    枚举:false / true

  • pagination.popperClass: AsamTableOverflowTooltipOptions["className"] — 上游声明

    枚举:false

  • pagination.popperStyle: AsamTableProps<Row>["style"] — 上游声明

    枚举:false

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

  • pagination.teleported: PublicMember<NonNullable<AsamPaginationProps | undefined>, "teleported"> — 上游声明

    枚举:false / true

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

    枚举:false / true

  • pagination.layout: string | undefined — 上游声明
  • pagination.total: number | undefined — 上游声明
  • pagination.currentPage: number | undefined — 上游声明
  • pagination.pageSize: number | 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<AsamPaginationProps | undefined>, "prevIcon"> — 上游声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamPaginationProps | 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<AsamPaginationProps | undefined>, "nextIcon"> — 上游声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamPaginationProps | 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 — 上游声明
  • pagination.size: AsamControlSize | undefined — ASAM 声明

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

allowDragLastColumn

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

allowDragLastColumn 参数与事件数据

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

枚举:false / true

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

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

preserveExpandedContent 参数与事件数据

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

枚举:false / true

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

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

style 参数与事件数据

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

枚举:false

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

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

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

className

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

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

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

width

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

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 运行实测)

stripe

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

stripe 参数与事件数据

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

枚举:false / true

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

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

border

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

border 参数与事件数据

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

枚举:false / true

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

固定上游文档默认:false(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: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["summaryMethod"]>, (...args: never[]) => unknown>>[0]): (string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>)[]

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

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

rowClassName

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

rowClassName 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["rowClassName"]>, (...args: never[]) => unknown>>[0]): string

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

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

rowStyle

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

rowStyle 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["rowStyle"]>, (...args: never[]) => unknown>>[0]): AsamTableV2HeaderCellSlotProps["style"]

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

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

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

cellClassName

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

cellClassName 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["cellClassName"]>, (...args: never[]) => unknown>>[0]): string

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

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

cellStyle

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

cellStyle 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["cellStyle"]>, (...args: never[]) => unknown>>[0]): AsamTableV2HeaderCellSlotProps["style"]

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

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

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

headerRowClassName

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

headerRowClassName 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["headerRowClassName"]>, (...args: never[]) => unknown>>[0]): string

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

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

headerRowStyle

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

headerRowStyle 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["headerRowStyle"]>, (...args: never[]) => unknown>>[0]): AsamTableV2HeaderCellSlotProps["style"]

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

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

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

headerCellClassName

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

headerCellClassName 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["headerCellClassName"]>, (...args: never[]) => unknown>>[0]): string

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

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

headerCellStyle

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

headerCellStyle 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["headerCellStyle"]>, (...args: never[]) => unknown>>[0]): AsamTableV2HeaderCellSlotProps["style"]

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

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

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

highlightCurrentRow

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

highlightCurrentRow 参数与事件数据

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

枚举:false / true

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

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

currentRowKey

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

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

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

emptyText

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

默认值与来源
'暂无数据'(源码表达式;ASAM 声明)

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

expandRowKeys

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

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

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

defaultExpandAll

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

defaultExpandAll 参数与事件数据

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

枚举:false / true

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

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

rowExpandable

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

rowExpandable 参数与事件数据

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

事件参数:(row: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["rowExpandable"]>, (...args: never[]) => unknown>>[0], index: number): boolean

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

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

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

defaultSort

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

defaultSort 参数与事件数据

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

  • defaultSort.prop: string — 上游声明

    用作初始排序列的属性。

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

  • defaultSort.order: AsamTableSort["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: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["spanMethod"]>, (...args: never[]) => unknown>>[0]): 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: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["load"]>, (...args: never[]) => unknown>>[0], treeNode: AsamTableTreeNode, resolve: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["load"]>, (...args: never[]) => unknown>>[2]): void

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

固定上游文档默认:未声明(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: Parameters<Extract<NonNullable<(AsamTableProps<Row>)["tooltipFormatter"]>, (...args: never[]) => unknown>>[0]): 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 运行实测)

nativeScrollbar

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

nativeScrollbar 参数与事件数据

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

枚举:false / true

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

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

size

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

size 参数与事件数据

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

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

AsamTableProps 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamTableProps, AsamTableRowKeyGetter, AsamTableRowKey, AsamPaginationProps, AsamTableOverflowTooltipOptions, AsamTableV2Props, AsamTableV2Expose, AsamControlSize, AsamTableSummaryMethod, AsamTableColumnCtx, AsamTableColumnCls, AsamTableColumnStyle, AsamTableV2HeaderCellSlotProps, AsamTableCellCls, AsamTableCellStyle, AsamTableSort, AsamTableTreeNode, AsamTableOverflowTooltipFormatter } from '@asam-ui/ui';

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

// AsamTableProps
type PublicContract<Row extends object = object> = {
	"data"?: Row[] | undefined;
	"tableLayout"?: ("auto" | "fixed") | undefined;
	"selectable"?: boolean | undefined;
	"rowKey"?: string | AsamTableRowKeyGetter<Row> | undefined;
	"defaultSelectedRowKeys"?: AsamTableRowKey[] | undefined;
	"reserveSelection"?: boolean | undefined;
	"loading"?: boolean | undefined;
	"minWidth"?: string | undefined;
	"pagination"?: AsamPaginationProps | undefined;
	"allowDragLastColumn"?: boolean | undefined;
	"preserveExpandedContent"?: boolean | undefined;
	"style"?: AsamTableProps<Row>["style"];
	"className"?: string | undefined;
	"width"?: string | number | undefined;
	"height"?: string | number | undefined;
	"maxHeight"?: string | number | undefined;
	"fit"?: boolean | undefined;
	"stripe"?: boolean | undefined;
	"border"?: boolean | undefined;
	"showHeader"?: boolean | undefined;
	"showSummary"?: boolean | undefined;
	"sumText"?: string | undefined;
	"summaryMethod"?: (AsamTableProps<Row>)["summaryMethod"];
	"rowClassName"?: (AsamTableProps<Row>)["rowClassName"];
	"rowStyle"?: (AsamTableProps<Row>)["rowStyle"];
	"cellClassName"?: (AsamTableProps<Row>)["cellClassName"];
	"cellStyle"?: (AsamTableProps<Row>)["cellStyle"];
	"headerRowClassName"?: (AsamTableProps<Row>)["headerRowClassName"];
	"headerRowStyle"?: (AsamTableProps<Row>)["headerRowStyle"];
	"headerCellClassName"?: (AsamTableProps<Row>)["headerCellClassName"];
	"headerCellStyle"?: (AsamTableProps<Row>)["headerCellStyle"];
	"highlightCurrentRow"?: boolean | undefined;
	"currentRowKey"?: string | number | undefined;
	"emptyText"?: string | undefined;
	"expandRowKeys"?: string[] | undefined;
	"defaultExpandAll"?: boolean | undefined;
	"rowExpandable"?: (AsamTableProps<Row>)["rowExpandable"];
	"defaultSort"?: AsamTableSort | undefined;
	"tooltipEffect"?: string | undefined;
	"tooltipOptions"?: (AsamTableProps<Row>)["tooltipOptions"];
	"spanMethod"?: (AsamTableProps<Row>)["spanMethod"];
	"selectOnIndeterminate"?: boolean | undefined;
	"indent"?: number | undefined;
	"treeProps"?: (AsamTableProps<Row>)["treeProps"];
	"lazy"?: boolean | undefined;
	"load"?: (AsamTableProps<Row>)["load"];
	"scrollbarAlwaysOn"?: boolean | undefined;
	"flexible"?: boolean | undefined;
	"showOverflowTooltip"?: (AsamTableProps<Row>)["showOverflowTooltip"];
	"tooltipFormatter"?: (AsamTableProps<Row>)["tooltipFormatter"];
	"appendFilterPanelTo"?: string | undefined;
	"scrollbarTabindex"?: string | number | undefined;
	"nativeScrollbar"?: boolean | undefined;
	"size"?: AsamControlSize | undefined;
};

参数与事件说明

select

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

select-all

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

selection-change

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

cell-mouse-enter

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

cell-mouse-leave

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

cell-contextmenu

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

cell-click

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

cell-dblclick

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

row-click

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

row-contextmenu

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

row-dblclick

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

header-click

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

header-contextmenu

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

sort-change

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

filter-change

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

current-change

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

header-dragend

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

expand-change

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

scroll

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

page-change

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

page-size-change

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

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

// AsamTableEmits
type PublicContract<Row extends object = object> = {
	"select": [selection: Row[], row: Row];
	"select-all": [selection: Row[]];
	"selection-change": [selection: Row[]];
	"cell-mouse-enter": [row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent];
	"cell-mouse-leave": [row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent];
	"cell-contextmenu": [row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: PointerEvent];
	"cell-click": [row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: PointerEvent];
	"cell-dblclick": [row: Row, column: AsamTableColumnCtx<Row>, cell: HTMLTableCellElement, event: MouseEvent];
	"row-click": [row: Row, column: AsamTableColumnCtx<Row> | null, event: PointerEvent];
	"row-contextmenu": [row: Row, column: AsamTableColumnCtx<Row> | null, event: PointerEvent];
	"row-dblclick": [row: Row, column: AsamTableColumnCtx<Row> | null, event: MouseEvent];
	"header-click": [column: AsamTableColumnCtx<Row>, event: PointerEvent];
	"header-contextmenu": [column: AsamTableColumnCtx<Row>, event: PointerEvent];
	"sort-change": [sort: { column: AsamTableColumnCtx<Row>; prop: string | null; order: "ascending" | "descending" | null; }];
	"filter-change": [filters: Record<string, string[]>];
	"current-change": [currentRow: Row | null, oldCurrentRow: Row | null];
	"header-dragend": [newWidth: number, oldWidth: number, column: AsamTableColumnCtx<Row>, event: MouseEvent];
	"expand-change": [row: Row, expanded: boolean | Row[]];
	"scroll": [position: { scrollLeft: number; scrollTop: number; }];
	"page-change": [page: number];
	"page-size-change": [pageSize: number];
};

参数与事件说明

default

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

default 参数与事件数据

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

事件参数:(): unknown

append

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

append 参数与事件数据

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

事件参数:(): unknown

empty

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

empty 参数与事件数据

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

事件参数:(): unknown

toolbar

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

toolbar 参数与事件数据

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

事件参数:(props: { selection: Row[]; }): unknown

AsamTableSlots 公开类型视图
ts
import type { AsamTableSlots } from '@asam-ui/ui';

// AsamTableSlots
type PublicContract<Row extends object = object> = {
	"default"?: (() => unknown) | undefined;
	"append"?: (() => unknown) | undefined;
	"empty"?: (() => unknown) | undefined;
	"toolbar"?: ((props: { selection: Row[]; }) => unknown) | undefined;
};

完整保留 45 个基础顶层公开成员,并浅层解包可观察值。对象视图仅供只读观察,不作为稳定的私有状态操作接口。

参数与事件说明

sort

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

sort 参数与事件数据

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

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

context

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

context 参数与事件数据

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

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

    枚举:false / true

  • context.hoverState: (NonNullable<(AsamTableExpose<Row>)["context"]>)["hoverState"] — 上游声明
    • context.hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.hoverState.column: PublicMember<NonNullable<(NonNullable<(AsamTableExpose<Row>)["context"]>)["hoverState"]>, "column"> — 上游声明

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

    • context.hoverState.row: PublicMember<NonNullable<(NonNullable<(AsamTableExpose<Row>)["context"]>)["hoverState"]>, "row"> — 上游声明
  • context.renderExpanded: (NonNullable<(AsamTableExpose<Row>)["context"]>)["renderExpanded"] — 上游声明

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

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

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

  • context.layout: AsamTableExpose<Row>["layout"] — 上游声明
    • context.layout.observers: (NonNullable<(NonNullable<(AsamTableExpose<Row>)["context"]>)["layout"]>)["observers"] — 上游声明

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

    • context.layout.table: AsamTableExpose<Row>["context"] — 上游声明

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

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

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

    • context.layout.columns: AsamTableExpose<Row>["columns"] — 上游声明

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

    • 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: (NonNullable<(NonNullable<(AsamTableExpose<Row>)["context"]>)["layout"]>)["getFlattenColumns"] — 上游声明

      事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<(AsamTableExpose<Row>)["context"]>)["layout"]>)["getFlattenColumns"]>, (...args: never[]) => unknown>>

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

      事件参数:(): void

    • context.layout.headerDisplayNone: (elm: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

      事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

      事件参数:(): void

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

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

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

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

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

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

  • context.refs: AsamTableRefs — 上游声明
    • context.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • context.tableId: string — 上游声明
  • context.state: (NonNullable<(AsamTableExpose<Row>)["context"]>)["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: (NonNullable<(AsamTableExpose<Row>)["context"]>)["emit"] — 上游声明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    渲染副作用实例。

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

  • context.data: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

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

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

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

    • context.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

    • context.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

    • 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<(AsamTableExpose<Row>)["context"]>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

    • context.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

    • context.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

    • context.parent.refs: AsamTableV2Expose["$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: AsamTableV2Expose["$"] — 依赖声明

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

  • 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<(AsamTableExpose<Row>)["context"]>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

  • context.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

  • context.slots: (NonNullable<(AsamTableExpose<Row>)["context"]>)["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<(AsamTableExpose<Row>)["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<(AsamTableExpose<Row>)["layout"]>)["observers"] — 上游声明

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

  • layout.table: AsamTableExpose<Row>["context"] — 上游声明
    • layout.table.$ready: boolean — 上游声明

      枚举:false / true

    • layout.table.hoverState: (NonNullable<(NonNullable<(AsamTableExpose<Row>)["layout"]>)["table"]>)["hoverState"] — 上游声明
      • layout.table.hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.hoverState.column: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamTableExpose<Row>)["layout"]>)["table"]>)["hoverState"]>, "column"> — 上游声明

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

      • layout.table.hoverState.row: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamTableExpose<Row>)["layout"]>)["table"]>)["hoverState"]>, "row"> — 上游声明

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

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

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

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

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

    • layout.table.layout: AsamTableExpose<Row>["layout"] — 上游声明

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

    • layout.table.refs: AsamTableRefs — 上游声明
      • layout.table.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • layout.table.tableId: string — 上游声明
    • layout.table.state: (NonNullable<(NonNullable<(AsamTableExpose<Row>)["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: (NonNullable<(NonNullable<(AsamTableExpose<Row>)["layout"]>)["table"]>)["emit"] — 上游声明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      渲染副作用实例。

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

    • layout.table.data: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

    • layout.table.parent: AsamTableV2Expose["$"] | 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<(AsamTableExpose<Row>)["layout"]>)["table"]>)["parent"]>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • layout.table.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

      • layout.table.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

      • 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<(AsamTableExpose<Row>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

      • layout.table.parent.refs: AsamTableV2Expose["$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: AsamTableV2Expose["$"] — 依赖声明

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

    • 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<(AsamTableExpose<Row>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

    • layout.table.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

      枚举:false / true

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

      枚举:false / true

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

      枚举:false / true

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

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

  • layout.columns: AsamTableExpose<Row>["columns"] — 上游声明

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

  • 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: (NonNullable<(AsamTableExpose<Row>)["layout"]>)["getFlattenColumns"] — 上游声明

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<(AsamTableExpose<Row>)["layout"]>)["getFlattenColumns"]>, (...args: never[]) => unknown>>

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

    事件参数:(): void

  • layout.headerDisplayNone: (elm: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

    事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

    事件参数:(): void

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

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

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

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

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

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

store

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

store 参数与事件数据

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

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

columns

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

columns 参数与事件数据

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

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

handleMouseLeave

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

handleMouseLeave 参数与事件数据

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

事件参数:(): void

tableId

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

tableSize

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

tableSize 参数与事件数据

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

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

isHidden

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

isHidden 参数与事件数据

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

枚举:false / true

isEmpty

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

isEmpty 参数与事件数据

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

枚举:false / true

renderExpanded

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

renderExpanded 参数与事件数据

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

事件参数:(__0: Parameters<Extract<NonNullable<(AsamTableExpose<Row>)["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<(AsamTableExpose<Row>)["debouncedUpdateLayout"]>, (...args: never[]) => unknown>> extends [...infer Rest] ? Rest : never): void | undefined

setCurrentRow

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

setCurrentRow 参数与事件数据

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

事件参数:(row?: Parameters<Extract<NonNullable<(AsamTableExpose<Row>)["setCurrentRow"]>, (...args: never[]) => unknown>>[0]): void

getSelectionRows

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

getSelectionRows 参数与事件数据

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

事件参数:(): ReturnType<Extract<NonNullable<(AsamTableExpose<Row>)["getSelectionRows"]>, (...args: never[]) => unknown>>

getHalfSelectionRows

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

getHalfSelectionRows 参数与事件数据

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

事件参数:(): ReturnType<Extract<NonNullable<(AsamTableExpose<Row>)["getHalfSelectionRows"]>, (...args: never[]) => unknown>>

toggleRowSelection

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

toggleRowSelection 参数与事件数据

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

事件参数:(row: Parameters<Extract<NonNullable<(AsamTableExpose<Row>)["toggleRowSelection"]>, (...args: never[]) => unknown>>[0], selected?: boolean | undefined, ignoreSelectable?: boolean | undefined): void

clearSelection

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

clearSelection 参数与事件数据

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

事件参数:(): void

clearFilter

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

clearFilter 参数与事件数据

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

事件参数:(columnKeys?: string | string[] | undefined): void

toggleAllSelection

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

toggleAllSelection 参数与事件数据

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

事件参数:(): void

toggleRowExpansion

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

toggleRowExpansion 参数与事件数据

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

事件参数:(row: Parameters<Extract<NonNullable<(AsamTableExpose<Row>)["toggleRowExpansion"]>, (...args: never[]) => unknown>>[0], expanded?: boolean | undefined): void

clearSort

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

clearSort 参数与事件数据

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

事件参数:(): void

doLayout

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

doLayout 参数与事件数据

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

事件参数:(): void

updateKeyChildren

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

updateKeyChildren 参数与事件数据

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

事件参数:(key: string, data: Parameters<Extract<NonNullable<(AsamTableExpose<Row>)["updateKeyChildren"]>, (...args: never[]) => unknown>>[1]): void

t

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

t 参数与事件数据

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

事件参数:(path: Parameters<Extract<NonNullable<AsamTableExpose<Row>["t"]>, (...args: never[]) => unknown>>[0], option?: Parameters<Extract<NonNullable<AsamTableExpose<Row>["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 — 上游声明
scrollTo

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

scrollTo 参数与事件数据

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

事件参数:(options: number | ScrollToOptions, yCoord?: number | undefined): void

setScrollLeft

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

setScrollLeft 参数与事件数据

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

事件参数:(left?: number | undefined): void

setScrollTop

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

setScrollTop 参数与事件数据

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

事件参数:(top?: number | undefined): void

scrollBarRef

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

scrollBarRef 参数与事件数据

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

嵌套展开边界:复杂类型;完整类型见公开类型视图。

handleHeaderFooterMousewheel

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

handleHeaderFooterMousewheel 参数与事件数据

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

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

getSelection

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

getSelection 参数与事件数据

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

事件参数:(): Row[]

AsamTableExpose 公开类型视图
ts
import type { VNode, Ref, ReactiveEffect, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, RendererNode, RendererElement, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
import type { AsamTableExpose, AsamTableContext, AsamTableRefs, AsamTableColumnCtx, AsamTableV2Props, AsamTableNativeEmits, AsamTableSort, AsamTableV2Expose, AsamTableFilter, AsamTableOverflowTooltipOptions, AsamScrollbarDirection } from '@asam-ui/ui';

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

// AsamTableExpose
type PublicContract<Row extends object = object> = {
	readonly "sort": (prop: string, order: string) => void;
	readonly "context": (AsamTableExpose<Row>)["context"];
	readonly "tableLayout": "auto" | "fixed";
	readonly "allowDragLastColumn": boolean;
	readonly "ns": (AsamTableExpose<Row>)["ns"];
	readonly "layout": (AsamTableExpose<Row>)["layout"];
	readonly "store": (AsamTableExpose<Row>)["store"];
	readonly "columns": (AsamTableExpose<Row>)["columns"];
	readonly "handleMouseLeave": () => void;
	readonly "tableId": string;
	readonly "tableSize": "" | "large" | "default" | "small";
	readonly "isHidden": boolean;
	readonly "isEmpty": boolean;
	readonly "renderExpanded": (AsamTableExpose<Row>)["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": (AsamTableExpose<Row>)["debouncedUpdateLayout"];
	readonly "setCurrentRow": (AsamTableExpose<Row>)["setCurrentRow"];
	readonly "getSelectionRows": (AsamTableExpose<Row>)["getSelectionRows"];
	readonly "getHalfSelectionRows": (AsamTableExpose<Row>)["getHalfSelectionRows"];
	readonly "toggleRowSelection": (AsamTableExpose<Row>)["toggleRowSelection"];
	readonly "clearSelection": () => void;
	readonly "clearFilter": (columnKeys?: string[] | string) => void;
	readonly "toggleAllSelection": () => void;
	readonly "toggleRowExpansion": (AsamTableExpose<Row>)["toggleRowExpansion"];
	readonly "clearSort": () => void;
	readonly "doLayout": () => void;
	readonly "updateKeyChildren": (AsamTableExpose<Row>)["updateKeyChildren"];
	readonly "t": AsamTableExpose<Row>["t"];
	readonly "setDragVisible": (visible: boolean) => void;
	readonly "computedSumText": string;
	readonly "computedEmptyText": string;
	readonly "computedTooltipEffect": string | undefined;
	readonly "computedTooltipOptions": (AsamTableExpose<Row>)["computedTooltipOptions"];
	readonly "scrollbarViewStyle": { display: string; verticalAlign: string; };
	readonly "scrollbarStyle": { height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; };
	readonly "scrollTo": (options: ScrollToOptions | number, yCoord?: number) => void;
	readonly "setScrollLeft": (left?: number) => void;
	readonly "setScrollTop": (top?: number) => void;
	readonly "scrollBarRef": (AsamTableExpose<Row>)["scrollBarRef"];
	readonly "handleHeaderFooterMousewheel": (event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void;
	"getSelection": () => Row[];
};

参数与事件说明

sort

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

sort 参数与事件数据

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

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

context

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

context 参数与事件数据

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

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

    枚举:false / true

  • context.hoverState: (NonNullable<(AsamTableInstance<Row>)["context"]>)["hoverState"] — 上游声明
    • context.hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.hoverState.column: PublicMember<NonNullable<(NonNullable<(AsamTableInstance<Row>)["context"]>)["hoverState"]>, "column"> — 上游声明

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

    • context.hoverState.row: PublicMember<NonNullable<(NonNullable<(AsamTableInstance<Row>)["context"]>)["hoverState"]>, "row"> — 上游声明
  • context.renderExpanded: (NonNullable<(AsamTableInstance<Row>)["context"]>)["renderExpanded"] — 上游声明

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

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

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

  • context.layout: AsamTableInstance<Row>["layout"] — 上游声明
    • context.layout.observers: (NonNullable<(NonNullable<(AsamTableInstance<Row>)["context"]>)["layout"]>)["observers"] — 上游声明

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

    • context.layout.table: AsamTableInstance<Row>["context"] — 上游声明

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

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

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

    • context.layout.columns: AsamTableInstance<Row>["columns"] — 上游声明

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

    • 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: (NonNullable<(NonNullable<(AsamTableInstance<Row>)["context"]>)["layout"]>)["getFlattenColumns"] — 上游声明

      事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<(AsamTableInstance<Row>)["context"]>)["layout"]>)["getFlattenColumns"]>, (...args: never[]) => unknown>>

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

      事件参数:(): void

    • context.layout.headerDisplayNone: (elm: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

      事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

      事件参数:(): void

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

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

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

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

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

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

  • context.refs: AsamTableRefs — 上游声明
    • context.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • context.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • context.tableId: string — 上游声明
  • context.state: (NonNullable<(AsamTableInstance<Row>)["context"]>)["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: (NonNullable<(AsamTableInstance<Row>)["context"]>)["emit"] — 上游声明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    渲染副作用实例。

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

  • context.data: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

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

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

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

    • context.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

    • context.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

    • 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<(AsamTableInstance<Row>)["context"]>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

    • context.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

    • context.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

    • context.parent.refs: AsamTableV2Expose["$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: AsamTableV2Expose["$"] — 依赖声明

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

  • 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<(AsamTableInstance<Row>)["context"]>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

  • context.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

  • context.slots: (NonNullable<(AsamTableInstance<Row>)["context"]>)["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<(AsamTableInstance<Row>)["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<(AsamTableInstance<Row>)["layout"]>)["observers"] — 上游声明

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

  • layout.table: AsamTableInstance<Row>["context"] — 上游声明
    • layout.table.$ready: boolean — 上游声明

      枚举:false / true

    • layout.table.hoverState: (NonNullable<(NonNullable<(AsamTableInstance<Row>)["layout"]>)["table"]>)["hoverState"] — 上游声明
      • layout.table.hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.hoverState.column: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamTableInstance<Row>)["layout"]>)["table"]>)["hoverState"]>, "column"> — 上游声明

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

      • layout.table.hoverState.row: PublicMember<NonNullable<(NonNullable<(NonNullable<(AsamTableInstance<Row>)["layout"]>)["table"]>)["hoverState"]>, "row"> — 上游声明

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

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

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

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

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

    • layout.table.layout: AsamTableInstance<Row>["layout"] — 上游声明

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

    • layout.table.refs: AsamTableRefs — 上游声明
      • layout.table.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • layout.table.tableId: string — 上游声明
    • layout.table.state: (NonNullable<(NonNullable<(AsamTableInstance<Row>)["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: (NonNullable<(NonNullable<(AsamTableInstance<Row>)["layout"]>)["table"]>)["emit"] — 上游声明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      渲染副作用实例。

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

    • layout.table.data: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

    • layout.table.parent: AsamTableV2Expose["$"] | 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<(AsamTableInstance<Row>)["layout"]>)["table"]>)["parent"]>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • layout.table.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

      • layout.table.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

      • 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<(AsamTableInstance<Row>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

      • layout.table.parent.refs: AsamTableV2Expose["$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: AsamTableV2Expose["$"] — 依赖声明

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

    • 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<(AsamTableInstance<Row>)["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: AsamTableV2Expose["$refs"] — 依赖声明

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

    • layout.table.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

      枚举:false / true

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

      枚举:false / true

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

      枚举:false / true

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

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

  • layout.columns: AsamTableInstance<Row>["columns"] — 上游声明

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

  • 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: (NonNullable<(AsamTableInstance<Row>)["layout"]>)["getFlattenColumns"] — 上游声明

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<(AsamTableInstance<Row>)["layout"]>)["getFlattenColumns"]>, (...args: never[]) => unknown>>

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

    事件参数:(): void

  • layout.headerDisplayNone: (elm: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

    事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

    事件参数:(): void

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

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

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

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

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

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

store

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

store 参数与事件数据

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

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

columns

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

columns 参数与事件数据

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

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

handleMouseLeave

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

handleMouseLeave 参数与事件数据

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

事件参数:(): void

tableId

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

tableSize

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

tableSize 参数与事件数据

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

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

isHidden

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

isHidden 参数与事件数据

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

枚举:false / true

isEmpty

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

isEmpty 参数与事件数据

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

枚举:false / true

renderExpanded

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

renderExpanded 参数与事件数据

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

事件参数:(__0: Parameters<Extract<NonNullable<(AsamTableInstance<Row>)["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<(AsamTableInstance<Row>)["debouncedUpdateLayout"]>, (...args: never[]) => unknown>> extends [...infer Rest] ? Rest : never): void | undefined

setCurrentRow

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

setCurrentRow 参数与事件数据

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

事件参数:(row?: Parameters<Extract<NonNullable<(AsamTableInstance<Row>)["setCurrentRow"]>, (...args: never[]) => unknown>>[0]): void

getSelectionRows

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

getSelectionRows 参数与事件数据

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

事件参数:(): ReturnType<Extract<NonNullable<(AsamTableInstance<Row>)["getSelectionRows"]>, (...args: never[]) => unknown>>

getHalfSelectionRows

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

getHalfSelectionRows 参数与事件数据

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

事件参数:(): ReturnType<Extract<NonNullable<(AsamTableInstance<Row>)["getHalfSelectionRows"]>, (...args: never[]) => unknown>>

toggleRowSelection

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

toggleRowSelection 参数与事件数据

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

事件参数:(row: Parameters<Extract<NonNullable<(AsamTableInstance<Row>)["toggleRowSelection"]>, (...args: never[]) => unknown>>[0], selected?: boolean | undefined, ignoreSelectable?: boolean | undefined): void

clearSelection

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

clearSelection 参数与事件数据

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

事件参数:(): void

clearFilter

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

clearFilter 参数与事件数据

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

事件参数:(columnKeys?: string | string[] | undefined): void

toggleAllSelection

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

toggleAllSelection 参数与事件数据

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

事件参数:(): void

toggleRowExpansion

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

toggleRowExpansion 参数与事件数据

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

事件参数:(row: Parameters<Extract<NonNullable<(AsamTableInstance<Row>)["toggleRowExpansion"]>, (...args: never[]) => unknown>>[0], expanded?: boolean | undefined): void

clearSort

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

clearSort 参数与事件数据

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

事件参数:(): void

doLayout

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

doLayout 参数与事件数据

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

事件参数:(): void

updateKeyChildren

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

updateKeyChildren 参数与事件数据

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

事件参数:(key: string, data: Parameters<Extract<NonNullable<(AsamTableInstance<Row>)["updateKeyChildren"]>, (...args: never[]) => unknown>>[1]): void

t

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

t 参数与事件数据

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

事件参数:(path: Parameters<Extract<NonNullable<AsamTableInstance<Row>["t"]>, (...args: never[]) => unknown>>[0], option?: Parameters<Extract<NonNullable<AsamTableInstance<Row>["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 — 上游声明
scrollTo

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

scrollTo 参数与事件数据

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

事件参数:(options: number | ScrollToOptions, yCoord?: number | undefined): void

setScrollLeft

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

setScrollLeft 参数与事件数据

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

事件参数:(left?: number | undefined): void

setScrollTop

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

setScrollTop 参数与事件数据

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

事件参数:(top?: number | undefined): void

scrollBarRef

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

scrollBarRef 参数与事件数据

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

嵌套展开边界:复杂类型;完整类型见公开类型视图。

handleHeaderFooterMousewheel

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

handleHeaderFooterMousewheel 参数与事件数据

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

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

getSelection

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

getSelection 参数与事件数据

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

事件参数:(): Row[]

AsamTableInstance 公开类型视图
ts
import type { VNode, Ref, ReactiveEffect, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, RendererNode, RendererElement, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
import type { AsamTableInstance, AsamTableContext, AsamTableRefs, AsamTableColumnCtx, AsamTableV2Props, AsamTableNativeEmits, AsamTableSort, AsamTableV2Expose, AsamTableFilter, AsamTableOverflowTooltipOptions, AsamScrollbarDirection } from '@asam-ui/ui';

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

// AsamTableInstance
type PublicContract<Row extends object = object> = {
	readonly "sort": (prop: string, order: string) => void;
	readonly "context": (AsamTableInstance<Row>)["context"];
	readonly "tableLayout": "auto" | "fixed";
	readonly "allowDragLastColumn": boolean;
	readonly "ns": (AsamTableInstance<Row>)["ns"];
	readonly "layout": (AsamTableInstance<Row>)["layout"];
	readonly "store": (AsamTableInstance<Row>)["store"];
	readonly "columns": (AsamTableInstance<Row>)["columns"];
	readonly "handleMouseLeave": () => void;
	readonly "tableId": string;
	readonly "tableSize": "" | "large" | "default" | "small";
	readonly "isHidden": boolean;
	readonly "isEmpty": boolean;
	readonly "renderExpanded": (AsamTableInstance<Row>)["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": (AsamTableInstance<Row>)["debouncedUpdateLayout"];
	readonly "setCurrentRow": (AsamTableInstance<Row>)["setCurrentRow"];
	readonly "getSelectionRows": (AsamTableInstance<Row>)["getSelectionRows"];
	readonly "getHalfSelectionRows": (AsamTableInstance<Row>)["getHalfSelectionRows"];
	readonly "toggleRowSelection": (AsamTableInstance<Row>)["toggleRowSelection"];
	readonly "clearSelection": () => void;
	readonly "clearFilter": (columnKeys?: string[] | string) => void;
	readonly "toggleAllSelection": () => void;
	readonly "toggleRowExpansion": (AsamTableInstance<Row>)["toggleRowExpansion"];
	readonly "clearSort": () => void;
	readonly "doLayout": () => void;
	readonly "updateKeyChildren": (AsamTableInstance<Row>)["updateKeyChildren"];
	readonly "t": AsamTableInstance<Row>["t"];
	readonly "setDragVisible": (visible: boolean) => void;
	readonly "computedSumText": string;
	readonly "computedEmptyText": string;
	readonly "computedTooltipEffect": string | undefined;
	readonly "computedTooltipOptions": (AsamTableInstance<Row>)["computedTooltipOptions"];
	readonly "scrollbarViewStyle": { display: string; verticalAlign: string; };
	readonly "scrollbarStyle": { height: string; maxHeight?: undefined; } | { maxHeight: string; height?: undefined; } | { height?: undefined; maxHeight?: undefined; };
	readonly "scrollTo": (options: ScrollToOptions | number, yCoord?: number) => void;
	readonly "setScrollLeft": (left?: number) => void;
	readonly "setScrollTop": (top?: number) => void;
	readonly "scrollBarRef": (AsamTableInstance<Row>)["scrollBarRef"];
	readonly "handleHeaderFooterMousewheel": (event: WheelEvent, delta: { pixelX: number; pixelY: number; }) => void;
	"getSelection": () => Row[];
};

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

AsamTableCellCls 公开类型视图
ts
import type { AsamTableCellCls } from '@asam-ui/ui';

// AsamTableCellCls
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = AsamTableCellCls<T>;

此辅助类型包含大型基础声明;完整契约见公开类型视图。

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

AsamTableCellStyle 公开类型视图
ts
import type { AsamTableCellStyle } from '@asam-ui/ui';

// AsamTableCellStyle
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = AsamTableCellStyle<T>;

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

AsamTableColumnCls 公开类型视图
ts
import type { AsamTableColumnCls } from '@asam-ui/ui';

// AsamTableColumnCls
type PublicContract<T> = AsamTableColumnCls<T>;

此辅助类型包含大型基础声明;完整契约见公开类型视图。

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

AsamTableColumnStyle 公开类型视图
ts
import type { AsamTableColumnStyle } from '@asam-ui/ui';

// AsamTableColumnStyle
type PublicContract<T> = AsamTableColumnStyle<T>;

参数与事件说明

column

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

column 参数与事件数据

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

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

values

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

values 参数与事件数据

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

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

silent

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

AsamTableFilter 公开类型视图
ts
import type { AsamTableFilter, AsamTableColumnCtx, AsamTableV2Props } from '@asam-ui/ui';

// AsamTableFilter
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = {
	"column": AsamTableColumnCtx<T>;
	"values": string[];
	"silent": any;
};

参数与事件说明

store

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

store 参数与事件数据

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

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

_self

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

_self 参数与事件数据

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

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

    枚举:false / true

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

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

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

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

    • _self.hoverState.row: T — 上游声明
  • _self.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

  • _self.store: AsamTableRenderRowData<T>["store"] — 上游声明

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

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

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

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

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

    • _self.layout.store: AsamTableRenderRowData<T>["store"] — 上游声明

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

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

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

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

      枚举:false / true

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

      枚举:false / true

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      事件参数:(): boolean

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

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

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

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

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

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

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

      事件参数:(): void

    • _self.layout.headerDisplayNone: (elm: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

      事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

      事件参数:(): void

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

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

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

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

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

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

  • _self.refs: AsamTableRefs — 上游声明
    • _self.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • _self.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

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

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

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

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

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

      事件参数:(): void

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

      事件参数:(): void

  • _self.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: "sort-change", data: { column: AsamTableColumnCtx<T>; prop: string | null; order: AsamTableSort["order"] | null; }): 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

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

    渲染副作用实例。

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

  • _self.data: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

  • _self.parent: AsamTableV2Expose["$"] | null — 依赖声明
    • _self.parent.uid: number — 依赖声明
    • _self.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

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

    • _self.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

    • _self.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

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

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

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

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

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

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

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

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

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

      渲染副作用实例。

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

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

      强制更新渲染副作用。

      事件参数:(): void

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

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

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

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

    • _self.parent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • _self.parent.exposed: Record<string, any> | null — 依赖声明
    • _self.parent.exposeProxy: Record<string, any> | null — 依赖声明
    • _self.parent.data: AsamTableV2Expose["$refs"] — 依赖声明

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

    • _self.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

    • _self.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

    • _self.parent.refs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

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

      枚举:false / true

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

      枚举:false / true

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

      枚举:false / true

  • _self.root: AsamTableV2Expose["$"] — 依赖声明

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

  • _self.appContext: AppContext — 依赖声明

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

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

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

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

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

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

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

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

    强制更新渲染副作用。

    事件参数:(): void

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

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

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

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

  • _self.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
  • _self.exposed: Record<string, any> | null — 依赖声明
  • _self.exposeProxy: Record<string, any> | null — 依赖声明
  • _self.props: AsamTableV2Expose["$refs"] — 依赖声明

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

  • _self.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

  • _self.isMounted: boolean — 依赖声明

    枚举:false / true

  • _self.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • _self.isDeactivated: boolean — 依赖声明

    枚举:false / true

column

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

column 参数与事件数据

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

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

row

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

$index

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

cellIndex

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

treeNode

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

treeNode 参数与事件数据

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

  • treeNode.expanded: boolean | undefined — 上游声明

    枚举:false / true

  • treeNode.loading: boolean | undefined — 上游声明

    枚举:false / true

  • treeNode.noLazyChildren: boolean | undefined — 上游声明

    枚举:false / true

  • treeNode.indent: number | undefined — 上游声明
  • treeNode.level: number | undefined — 上游声明
  • treeNode.display: boolean | undefined — 上游声明

    枚举:false / true

expanded

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

expanded 参数与事件数据

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

枚举:false / true

AsamTableRenderRowData 公开类型视图
ts
import type { VNode, Ref, ReactiveEffect, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, RendererNode, RendererElement, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
import type { AsamTableRenderRowData, AsamTableContext, AsamTableV2Expose, AsamTableRefs, AsamTableColumnCtx, AsamTableV2Props, AsamTableV2HeaderCellSlotProps, AsamTableNativeEmits, AsamTableSort, AsamTableTreeNode } from '@asam-ui/ui';

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

// AsamTableRenderRowData
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = {
	"store": (AsamTableRenderRowData<T>)["store"];
	"_self": AsamTableContext<T>;
	"column": AsamTableColumnCtx<T>;
	"row": T;
	"$index": number;
	"cellIndex": number;
	"treeNode"?: AsamTableTreeNode | undefined;
	"expanded": boolean;
};

参数与事件说明

prop

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

order

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

order 参数与事件数据

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

枚举:"ascending" / "descending"

init

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

silent

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

AsamTableSort 公开类型视图
ts
import type { AsamTableSort, AsamTableV2HeaderCellSlotProps, AsamTableV2Props } from '@asam-ui/ui';

// AsamTableSort
type PublicContract = {
	"prop": string;
	"order": AsamTableSort["order"];
	"init"?: any;
	"silent"?: any;
};
AsamTableSummaryMethod 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamTableSummaryMethod, AsamTableColumnCtx } from '@asam-ui/ui';

// AsamTableSummaryMethod
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = {
	(data: { columns: AsamTableColumnCtx<T>[]; data: T[]; }): (string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>)[];
};

参数与事件说明

$ready

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

$ready 参数与事件数据

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

枚举:false / true

hoverState

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

hoverState 参数与事件数据

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

  • hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

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

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

  • hoverState.row: T — 上游声明
renderExpanded

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

renderExpanded 参数与事件数据

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

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

store

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

store 参数与事件数据

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

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

layout

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

layout 参数与事件数据

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

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

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

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

      枚举:false / true

    • layout.table.hoverState: AsamTableContext<T>["hoverState"] — 上游声明
      • layout.table.hoverState.cell: AsamTableRefs["tableWrapper"] — 上游声明

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

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

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

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

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

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

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

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

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

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

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

    • layout.table.refs: AsamTableRefs — 上游声明
      • layout.table.refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

      • layout.table.refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

    • layout.table.tableId: string — 上游声明
    • layout.table.state: AsamTableContext<T>["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: "sort-change", data: { column: AsamTableColumnCtx<T>; prop: string | null; order: AsamTableSort["order"] | null; }): 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: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

    • layout.table.parent: AsamTableV2Expose["$"] | 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<(AsamTableContext<T>)["layout"]>)["table"]>)["parent"]>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • layout.table.parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

      • layout.table.parent.root: AsamTableV2Expose["$"] — 依赖声明

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

      • layout.table.parent.appContext: AsamTableContext<T>["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: AsamTableContext<T>["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: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

      • layout.table.parent.slots: AsamTableContext<T>["slots"] — 依赖声明

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

      • layout.table.parent.refs: AsamTableV2Expose["$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: AsamTableV2Expose["$"] — 依赖声明

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

    • layout.table.appContext: AsamTableContext<T>["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: AsamTableContext<T>["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: AsamTableV2Expose["$refs"] — 依赖声明

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

    • layout.table.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

    • layout.table.slots: AsamTableContext<T>["slots"] — 依赖声明

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

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

      枚举:false / true

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

      枚举:false / true

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

      枚举:false / true

  • layout.store: AsamTableContext<T>["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: AsamTableRefs["tableWrapper"]) => boolean — 上游声明

    事件参数:(elm: AsamTableRefs["tableWrapper"]): boolean

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

    事件参数:(): void

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

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

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

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

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

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

refs

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

refs 参数与事件数据

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

  • refs.tableWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.headerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.footerWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.fixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.rightFixedBodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.bodyWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

  • refs.appendWrapper: AsamTableRefs["tableWrapper"] — 上游声明

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

tableId

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

state

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

state 参数与事件数据

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

  • state.isGroup: Ref<boolean, boolean> — 上游声明

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

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

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

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

    事件参数:(): void

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

    事件参数:(): void

emit

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

emit 参数与事件数据

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

事件参数:(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: "sort-change", data: { column: AsamTableColumnCtx<T>; prop: string | null; order: AsamTableSort["order"] | null; }): 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

effect

必填:是;声明来源:依赖声明。

effect 参数与事件数据

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

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

data

必填:是;声明来源:依赖声明。

data 参数与事件数据

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

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

uid

必填:是;声明来源:依赖声明。

type

必填:是;声明来源:依赖声明。

type 参数与事件数据

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

事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any>>, (...args: never[]) => unknown>>[1]): any

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

parent

必填:是;声明来源:依赖声明。

parent 参数与事件数据

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

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

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

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

  • parent.parent: AsamTableV2Expose["$"] | null — 依赖声明

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

  • parent.root: AsamTableV2Expose["$"] — 依赖声明

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

  • parent.appContext: AsamTableContext<T>["appContext"] — 依赖声明

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

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

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

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

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

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

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

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

    渲染副作用实例。

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

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

    强制更新渲染副作用。

    事件参数:(): void

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

  • parent.job: AsamTableContext<T>["job"] — 依赖声明

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

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

  • parent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
  • parent.exposed: Record<string, any> | null — 依赖声明
  • parent.exposeProxy: Record<string, any> | null — 依赖声明
  • parent.data: AsamTableV2Expose["$refs"] — 依赖声明

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

  • parent.props: AsamTableV2Expose["$refs"] — 依赖声明

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

  • parent.attrs: AsamTableV2Expose["$refs"] — 依赖声明

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

  • parent.slots: AsamTableContext<T>["slots"] — 依赖声明

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

  • parent.refs: AsamTableV2Expose["$refs"] — 依赖声明

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

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

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

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

  • parent.isMounted: boolean — 依赖声明

    枚举:false / true

  • parent.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • parent.isDeactivated: boolean — 依赖声明

    枚举:false / true

root

必填:是;声明来源:依赖声明。

root 参数与事件数据

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

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

appContext

必填:是;声明来源:依赖声明。

appContext 参数与事件数据

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

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

vnode

必填:是;声明来源:依赖声明。

vnode 参数与事件数据

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

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

subTree

必填:是;声明来源:依赖声明。

subTree 参数与事件数据

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

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

update

必填:是;声明来源:依赖声明。

update 参数与事件数据

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

事件参数:(): void

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

job

必填:是;声明来源:依赖声明。

job 参数与事件数据

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

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

proxy

必填:是;声明来源:依赖声明。

exposed

必填:是;声明来源:依赖声明。

exposeProxy

必填:是;声明来源:依赖声明。

props

必填:是;声明来源:依赖声明。

props 参数与事件数据

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

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

attrs

必填:是;声明来源:依赖声明。

attrs 参数与事件数据

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

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

slots

必填:是;声明来源:依赖声明。

slots 参数与事件数据

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

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

isMounted

必填:是;声明来源:依赖声明。

isMounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

isUnmounted

必填:是;声明来源:依赖声明。

isUnmounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

isDeactivated

必填:是;声明来源:依赖声明。

isDeactivated 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

AsamTableContext 公开类型视图
ts
import type { VNode, Ref, ReactiveEffect, ConcreteComponent, ComputedOptions, MethodOptions, RendererNode, RendererElement, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
import type { AsamTableContext, AsamTableV2Expose, AsamTableRefs, AsamTableColumnCtx, AsamTableV2HeaderCellSlotProps, AsamTableNativeEmits, AsamTableSort, AsamTableV2Props } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamTableContext
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; } = any> = {
	"$ready": boolean;
	"hoverState"?: (AsamTableContext<T>)["hoverState"];
	"renderExpanded": (AsamTableContext<T>)["renderExpanded"];
	"store": (AsamTableContext<T>)["store"];
	"layout": (AsamTableContext<T>)["layout"];
	"refs": AsamTableRefs;
	"tableId": string;
	"state": AsamTableContext<T>["state"];
	"emit": AsamTableNativeEmits<T>;
	"effect": ReactiveEffect<any>;
	"data": AsamTableV2Expose["$refs"];
	"uid": number;
	"type": ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any>;
	"parent": AsamTableV2Expose["$"] | null;
	"root": AsamTableV2Expose["$"];
	"appContext": AsamTableContext<T>["appContext"];
	"vnode": VNode<RendererNode, RendererElement, { [key: string]: any; }>;
	"subTree": VNode<RendererNode, RendererElement, { [key: string]: any; }>;
	"update": () => void;
	"job": AsamTableContext<T>["job"];
	"proxy": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"exposed": Record<string, any> | null;
	"exposeProxy": Record<string, any> | null;
	"props": AsamTableV2Expose["$refs"];
	"attrs": AsamTableV2Expose["$refs"];
	"slots": AsamTableContext<T>["slots"];
	"isMounted": boolean;
	"isUnmounted": boolean;
	"isDeactivated": boolean;
};

参数与事件说明

id

必填:是;声明来源:上游声明。

realWidth

必填:是;声明来源:上游声明。

type

必填:是;声明来源:上游声明。

label

必填:是;声明来源:上游声明。

className

必填:是;声明来源:上游声明。

labelClassName

必填:是;声明来源:上游声明。

property

必填:是;声明来源:上游声明。

prop

必填:是;声明来源:上游声明。

width

必填:否;声明来源:上游声明。

minWidth

必填:是;声明来源:上游声明。

renderHeader

必填:是;声明来源:上游声明。

renderHeader 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: Parameters<Extract<NonNullable<(AsamTableColumnCtx<T>)["renderHeader"]>, (...args: never[]) => unknown>>[0]): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

sortable

必填:是;声明来源:上游声明。

sortable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

sortMethod

必填:是;声明来源:上游声明。

sortMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(a: T, b: T): number

sortBy

必填:是;声明来源:上游声明。

sortBy 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, index: number, array?: T[] | undefined): string

resizable

必填:是;声明来源:上游声明。

resizable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

columnKey

必填:是;声明来源:上游声明。

rawColumnKey

必填:是;声明来源:上游声明。

align

必填:是;声明来源:上游声明。

headerAlign

必填:是;声明来源:上游声明。

showOverflowTooltip

必填:否;声明来源:上游声明。

showOverflowTooltip 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

tooltipFormatter

必填:否;声明来源:上游声明。

tooltipFormatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: T; column: AsamTableColumnCtx<T>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

fixed

必填:是;声明来源:上游声明。

fixed 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

formatter

必填:是;声明来源:上游声明。

formatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, column: AsamTableColumnCtx<T>, cellValue: any, index: number): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

selectable

必填:是;声明来源:上游声明。

selectable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(row: T, index: number): boolean

reserveSelection

必填:是;声明来源:上游声明。

reserveSelection 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

filterMethod

必填:是;声明来源:上游声明。

filterMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: string, row: T, column: AsamTableColumnCtx<T>): void

filteredValue

必填:是;声明来源:上游声明。

filteredValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

filters

必填:是;声明来源:上游声明。

filterPlacement

必填:是;声明来源:上游声明。

filterMultiple

必填:是;声明来源:上游声明。

filterMultiple 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

filterClassName

必填:是;声明来源:上游声明。

index

必填:是;声明来源:上游声明。

index 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): number

sortOrders

必填:是;声明来源:上游声明。

sortOrders 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

renderCell

必填:是;声明来源:上游声明。

renderCell 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: any): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }> | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[]

colSpan

必填:是;声明来源:上游声明。

rowSpan

必填:是;声明来源:上游声明。

children

必填:否;声明来源:上游声明。

level

必填:是;声明来源:上游声明。

filterable

必填:是;声明来源:上游声明。

filterable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

事件参数:(value: string, row: T, column: AsamTableColumnCtx<T>): void

order

必填:是;声明来源:上游声明。

order 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"ascending" / "descending"

isColumnGroup

必填:是;声明来源:上游声明。

isColumnGroup 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

isSubColumn

必填:是;声明来源:上游声明。

isSubColumn 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

columns

必填:是;声明来源:上游声明。

columns 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

getColumnIndex

必填:是;声明来源:上游声明。

getColumnIndex 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): number

no

必填:是;声明来源:上游声明。

filterOpened

必填:否;声明来源:上游声明。

filterOpened 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

renderFilterIcon

必填:否;声明来源:上游声明。

renderFilterIcon 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: any): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

renderExpand

必填:否;声明来源:上游声明。

renderExpand 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: any): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

AsamTableColumnCtx 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamTableColumnCtx, AsamTableV2HeaderCellSlotProps, AsamTableV2Props, AsamTableV2Expose, AsamTableOverflowTooltipFormatter, AsamTableSort } from '@asam-ui/ui';

// AsamTableColumnCtx
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; } = { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = {
	"id": string;
	"realWidth": number | null;
	"type": string;
	"label": string;
	"className": string;
	"labelClassName": string;
	"property": string;
	"prop": string;
	"width"?: string | number | undefined;
	"minWidth": string | number;
	"renderHeader": (AsamTableColumnCtx<T>)["renderHeader"];
	"sortable": string | boolean;
	"sortMethod": (a: T, b: T) => number;
	"sortBy": string | string[] | ((row: T, index: number, array?: T[]) => string);
	"resizable": boolean;
	"columnKey": string;
	"rawColumnKey": string;
	"align": string;
	"headerAlign": string;
	"showOverflowTooltip"?: (AsamTableColumnCtx<T>)["showOverflowTooltip"];
	"tooltipFormatter"?: AsamTableOverflowTooltipFormatter<T> | undefined;
	"fixed": string | boolean;
	"formatter": (row: T, column: AsamTableColumnCtx<T>, cellValue: any, index: number) => VNode | string;
	"selectable": (row: T, index: number) => boolean;
	"reserveSelection": boolean;
	"filterMethod": (AsamTableColumnCtx<T>)["filterMethod"];
	"filteredValue": string[];
	"filters": AsamTableColumnCtx<T>["filters"];
	"filterPlacement": string;
	"filterMultiple": boolean;
	"filterClassName": string;
	"index": number | ((index: number) => number);
	"sortOrders": (AsamTableSort["order"] | null)[];
	"renderCell": (data: any) => VNode | VNode[];
	"colSpan": number;
	"rowSpan": number;
	"children"?: AsamTableColumnCtx<T>[] | undefined;
	"level": number;
	"filterable": (AsamTableColumnCtx<T>)["filterable"];
	"order": AsamTableSort["order"] | null;
	"isColumnGroup": boolean;
	"isSubColumn": boolean;
	"columns": AsamTableColumnCtx<T>[];
	"getColumnIndex": () => number;
	"no": number;
	"filterOpened"?: boolean | undefined;
	"renderFilterIcon"?: ((scope: any) => VNode) | undefined;
	"renderExpand"?: ((scope: any) => VNode) | undefined;
};

参数与事件说明

showOverflowTooltip

必填:否;声明来源:上游声明。

showOverflowTooltip 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:undefined(2.14.7;源码事实,未作为 ASAM 运行实测)

tooltipEffect

必填:否;声明来源:上游声明。

tooltipOptions

必填:否;声明来源:上游声明。

tooltipOptions 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

tooltipFormatter

必填:否;声明来源:上游声明。

tooltipFormatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: { row: any; column: AsamTableColumnCtx<any>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

AsamTableConfigContext 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamTableConfigContext, AsamTableV2Props, AsamTableOverflowTooltipFormatter, AsamTableColumnCtx } from '@asam-ui/ui';

// AsamTableConfigContext
type PublicContract = {
	"showOverflowTooltip"?: (AsamTableConfigContext)["showOverflowTooltip"];
	"tooltipEffect"?: string | undefined;
	"tooltipOptions"?: (AsamTableConfigContext)["tooltipOptions"];
	"tooltipFormatter"?: AsamTableOverflowTooltipFormatter<any> | undefined;
};

参数与事件说明

tableWrapper

必填:是;声明来源:上游声明。

tableWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

headerWrapper

必填:是;声明来源:上游声明。

headerWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

footerWrapper

必填:是;声明来源:上游声明。

footerWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

fixedBodyWrapper

必填:是;声明来源:上游声明。

fixedBodyWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

rightFixedBodyWrapper

必填:是;声明来源:上游声明。

rightFixedBodyWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

bodyWrapper

必填:是;声明来源:上游声明。

bodyWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

appendWrapper

必填:是;声明来源:上游声明。

appendWrapper 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

AsamTableRefs 公开类型视图
ts
import type { AsamTableRefs } from '@asam-ui/ui';

// AsamTableRefs
type PublicContract = {
	"tableWrapper": AsamTableRefs["tableWrapper"];
	"headerWrapper": AsamTableRefs["tableWrapper"];
	"footerWrapper": AsamTableRefs["tableWrapper"];
	"fixedBodyWrapper": AsamTableRefs["tableWrapper"];
	"rightFixedBodyWrapper": AsamTableRefs["tableWrapper"];
	"bodyWrapper": AsamTableRefs["tableWrapper"];
	"appendWrapper": AsamTableRefs["tableWrapper"];
	[key: string]: any;
};

参数与事件说明

row

必填:是;声明来源:上游声明。

column

必填:是;声明来源:上游声明。

column 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

cellValue

必填:是;声明来源:上游声明。

AsamTableTooltipData 公开类型视图
ts
import type { AsamTableTooltipData, AsamTableColumnCtx, AsamTableV2Props } from '@asam-ui/ui';

// AsamTableTooltipData
type PublicContract<T extends { [x: string]: any; [x: number]: any; [x: symbol]: any; }> = {
	"row": T;
	"column": AsamTableColumnCtx<T>;
	"cellValue": any;
};

参数与事件说明

expanded

必填:否;声明来源:上游声明。

expanded 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

loading

必填:否;声明来源:上游声明。

loading 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

noLazyChildren

必填:否;声明来源:上游声明。

noLazyChildren 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

indent

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:16(2.14.7;源码事实,未作为 ASAM 运行实测)

level

必填:否;声明来源:上游声明。

display

必填:否;声明来源:上游声明。

display 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

AsamTableTreeNode 公开类型视图
ts
import type { AsamTableTreeNode, AsamTableV2Props } from '@asam-ui/ui';

// AsamTableTreeNode
type PublicContract = {
	"expanded"?: boolean | undefined;
	"loading"?: boolean | undefined;
	"noLazyChildren"?: boolean | undefined;
	"indent"?: number | undefined;
	"level"?: number | undefined;
	"display"?: boolean | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭