useViewMeta

useViewMeta

▸ useViewMeta(viewId): IViewMeta

Beta API`, 未来有可能变更。

获取视图的 metadata 属性。 传入一个 viewId, 当 viewId 非法或者不存在时，返回 undefined。 当 metadata 属性变化的时候会触发重新渲染。

参数

Name	Type	Description
viewId	string | undefined	需要获取 metadata 属性的视图ID

返回值

IViewMeta

示例

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

// 显示当前视图名称
function ViewName() {
  const activeViewId = useActiveViewId();
  const viewMeta = useViewMeta(activeViewId);
  return <p>当前视图名称：{viewMeta?.name}</p>;
}

▸ useViewMeta(datasheet, viewId): IViewMeta

支持获取对应表格视图的 metadata 属性。

参数

Name	Type	Description
datasheet	Datasheet | undefined	Datasheet 实例，通过 useDatasheet 获取
viewId	string | undefined	需要获取 metadata 属性的视图ID

返回值

IViewMeta

示例

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

// 显示对应 datasheetId(dstXXXXXXXX) 表的当前视图名称
function ViewName() {
  const datasheet = useDatasheet('dstXXXXXXXX');
  const viewMeta = useViewMeta(datasheet, 'viwXXXXXXX');
  return <p>当前视图名称：{viewMeta?.name}</p>;
}