sp webpart base.iwebpartdata

Home > @microsoft/sp-webpart-base > IWebPartData

IWebPartData interface

This structure represents the serialized state of a web part.

Signature:

interface IWebPartData 

Remarks

When the serialize() API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize.

Properties

Property	Type	Description
dataVersion	string	Web part data version
description?	string	(Optional) Web part description
dynamicDataPaths?	{ [path: string]: string; }	(BETA) (Optional) Paths for the dynamic data.
dynamicDataValues?	{ [path: string]: any; }	(BETA) (Optional) Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part.
id	string	Universally unique web part Type id.
instanceId	string	Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries.
properties?	any	(Optional) Web part specific properties. The individual web part owns the definition of these properties.
serverProcessedContent?	ISerializedServerProcessedData	(Optional) The collections of data that can be processed by server side services like search index and link fixup
title	string	Web part title