跳到主要内容

useFields

获取当前视图所有的字段(列)信息。 当字段属性/列顺序发生变化的时候,会触发重新渲染。

如果没有传入 viewId 会返回空数组。

参数

NameTypeDescription
viewIdstring | undefined视图ID
query?IFieldQuery可选参数,指定查询哪些 fieldId 数据

返回值

Field[]

示例

import { useFields, useActiveViewId } from '@apitable/widget-sdk';

// 展示全部字段名称
function FieldNames() {
const viewId = useActiveViewId();
const fields = useFields(viewId);
return (<div>
{fields.map(field => <p key={field.id}>{field.name}</p>)}
</div>);
}

useFields(datasheet, viewId, query?): Field[]

支持加载对应表格数据 Fields

参数

NameTypeDescription
datasheetDatasheet | undefinedDatasheet 实例,通过 useDatasheet 获取
viewIdstring | undefined视图ID
query?IFieldQuery可选参数,指定查询哪些 fieldId 数据

返回值

Field[]

示例

import { useFields, useDatasheet } from '@apitable/widget-sdk';

// 展示对应 datasheetId(dstXXXXXXXX) 表的全部字段名称
function FieldNames() {
const datasheet = useDatasheet('dstXXXXXXXX');
const fields = useFields(datasheet, 'vieXXXXXXX');
return (<div>
{fields.map(field => <p key={field.id}>{field.name}</p>)}
</div>);
}