Retrieving the image its focal point of a SharePoint Modern page

December 19, 2019

On SharePoint modern pages, you can set the focal point of the header image. Having this kind of control is excellent for creating compelling pages.

Header image with focal point
Header image with focal point

What if you also want to make use of the same focal point in your roll-ups? Luckily this is also possible, and it depends a bit on how you retrieve the data.

Where to retrieve this information?

The header image information is available as a field property on the page named LayoutWebpartsContent. This field contains an HTML string with some JSON parsed string, which provides all properties of how the header needs to render.

LayoutWebpartsContent data
LayoutWebpartsContent data

To get this information, you can use a REST API call and specify to retrieve the LayoutWebpartsContent field information. You can use the following API call: /_api/web/lists/GetByTitle('Site Pages')/GetItemById(4)?$select=LayoutWebpartsContent;

Verify the returned JSON data
Verify the returned JSON data

As mentioned, the data you get back is an HTML encoded string with a JSON control data attribute. This data needs some parsing to get the actual values.

Parsing the HTML control data

As the data is an HTML encoded string, this needs some decoding first to get the JSON value. We are looking for the translateX and translateY properties that are available in the JSON object. You can use these values to apply as the background positioning x and y CSS properties to get the same focus point. The decoding of the JSON object looks as follows:

The contents of the JSON string look like this:

The good news is that you can also retrieve this information via search. To extract the data via search, all you need to do is pass the LayoutWebpartsContentOWSHTML managed property to the SelectProperties parameter.

Happy coding!

Comments

comments powered by Disqus