IWebPartPropertiesMetadata interface

Pacote:

@microsoft/sp-webpart-base

Essa estrutura é usada para definir metadados para propriedades da Web Part como um mapa de cadeia de caracteres para IWebPartPropertyMetadata

Comentários

A chave deve ser um caminho JSON para a propriedade em propriedades da Web Part. O caminho JSON dá suporte aos seguintes operadores:

• . Ponto para selecionar membros do objeto, por exemploperson.name

• Colchetes [] para selecionar itens de matriz, por exemplo person.photoURLs[0]

• Asterisco [*] entre colchetes para elementos de matriz curinga, por exemplo person.websites[*].

Você pode fazer combinações desses operadores, por exemplo person.websites[*].url

Observação importante: há suporte para apenas um curinga por caminho.

Exemplo: vamos supor que temos uma Web Part com propriedades que têm o seguinte esquema:

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

Podemos definir os metadados para as propriedades desejadas como a seguir:

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

Isso fará com que os servidores do SharePoint conscienciam o conteúdo de suas propriedades e executem serviços como indexação de pesquisa, correção de link etc nos dados. Caso algum dos valores precise ser atualizado por esses serviços, por exemplo, correção de link, o saco de propriedades da Web Part será atualizado automaticamente.