IWebPartPropertiesMetadata interface

Paquete:

@microsoft/sp-webpart-base

Esta estructura se usa para definir metadatos para las propiedades del elemento web como un mapa de cadena para IWebPartPropertyMetadata

Comentarios

La clave debe ser una ruta de acceso JSON a la propiedad en las propiedades del elemento web. La ruta de acceso JSON admite los operadores siguientes:

• Punto . para seleccionar miembros de objeto, por ejemplo person.name

• Corchetes [] para seleccionar elementos de matriz, por ejemplo person.photoURLs[0]

• Asterisco entre corchetes [*] para el carácter comodín de elementos de matriz, por ejemplo person.websites[*].

Puede realizar combinaciones de estos operadores, por ejemplo, person.websites[*].url

Nota importante: Solo se admite un carácter comodín por ruta de acceso.

Ejemplo: supongamos que tenemos un elemento web con propiedades que tienen el esquema siguiente:

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

Podemos definir los metadatos de las propiedades deseadas como se indica a continuación:

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

Esto hará que los servidores de SharePoint conozcan el contenido de las propiedades y ejecuten servicios como la indexación de búsqueda, la corrección de vínculos, etc. en los datos. En caso de que estos servicios necesiten actualizar cualquiera de los valores, por ejemplo, la corrección de vínculos, el contenedor de propiedades del elemento web se actualiza automáticamente.