This repository has been archived by the owner on Oct 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
sp webpart base.iwebpartpropertymetadata
John Nguyen edited this page Apr 22, 2021
·
3 revisions
Home > @microsoft/sp-webpart-base > IWebPartPropertyMetadata
This is the structure used for map values in IWebPartPropertiesMetadata
Signature:
export interface IWebPartPropertyMetadata
Property | Type | Description |
---|---|---|
dynamicPropertyType? | 'boolean' | 'number' | 'string' | 'array' | 'object' | (Optional) If specified, indicates that the property is a dynamic property and the type of the dynamic property. |
isHtmlString? | boolean | (Optional) Indicates whether the property should be serialized as HTML. |
isImageSource? | boolean | (Optional) Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. |
isLink? | boolean | (Optional) Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. |
isSearchablePlainText? | boolean | (Optional) Indicates if the property contains plain text that should be search-indexed by SharePoint. |
shouldNotPersist? | boolean | (Optional) Indicates if the framework should persist the property on the server. |