IWebPartPropertiesMetadata interface

  • 参考
包:
@microsoft/sp-webpart-base

此结构用于将 Web 部件属性的元数据定义为字符串映射到 IWebPartPropertyMetadata

注解

密钥应该是 Web 部件属性中 属性的 JSON 路径。 JSON 路径支持以下运算符：

  • 用于选择对象成员的点 . ，例如 person.name

  • []用于选择数组项的括号，例如person.photoURLs[0]

  • 数组元素通配符的括号星号 [*] ，例如 person.websites[*]。

可以组合这些运算符，例如 person.websites[*].url

重要说明：每个路径仅支持一个通配符。

示例：假设我们有一个 Web 部件，其属性具有以下架构：

{
  title: string;
  person: {
    name: string;
    bio: string;
    photoURLs: string[];
    websites: { title: string; url: string; }[]
  }
}

我们可以定义所需属性的元数据，如下所示：

{
 'person.bio': { isRichContent: true },
 'person.photoURLs[*]': { isImageSource: true },
 'person.websites[*].url': { isLink: true }
}

这将让 SharePoint 服务器知道你的属性的内容，并在数据上运行搜索索引、链接修复等服务。 如果任何值需要由这些服务（如链接修正）进行更新，则 Web 部件属性包将自动更新。