Set-PnPClientSideWebPart

Set Client-Side Web Part properties

Syntax

Set-PnPClientSideWebPart
   -Page <ClientSidePagePipeBind>
                           -Identity <ClientSideWebPartPipeBind>
                           [-Title <String>]
                           [-PropertiesJson <String>]
                           [-Web <WebPipeBind>]
                           [-Connection <SPOnlineConnection>]

Description

Sets specific client side web part properties. Notice that the title parameter will only set the -internal- title of web part. The title which is shown in the UI will, if possible, have to be set using the PropertiesJson parameter. Use Get-PnPClientSideComponent to retrieve the instance id and properties of a web part.

Examples

------------------EXAMPLE 1------------------

Set-PnPClientSideWebPart -Page Home -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -PropertiesJson $myproperties

Sets the properties of the client side web part given in the $myproperties variable.

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

The identity of the web part. This can be the web part instance id or the title of a web part

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:ClientSideWebPartPipeBind
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-Page

The name of the page

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:ClientSidePagePipeBind
Position:0
Accept pipeline input:True
Accept wildcard characters:False
-PropertiesJson

Sets the properties as a JSON string.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:String
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-Title

Sets the internal title of the web part. Notice that this will NOT set a visible title.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:String
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False