IImageHelperRequest interface

Package:

@microsoft/sp-image-helper

Interface for constructing a request to create an optimized image url from a file on SharePoint.

Properties

cacheBuster	guid generated for image to use as param to avoid caching from api on adv edited images
height	Optional height of the image requested
sourceUrl	The url to the item to be retrieved as an image. This can be an absolute url or a relative url.
width	Width of the image requested.

Property Details

cacheBuster

guid generated for image to use as param to avoid caching from api on adv edited images

cacheBuster?: string;

Property Value

string

height

Optional height of the image requested

height?: number;

Property Value

number

Remarks

By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint.

sourceUrl

The url to the item to be retrieved as an image. This can be an absolute url or a relative url.

sourceUrl: string;

Property Value

string

width

Width of the image requested.

width: number;

Property Value

number

Remarks

When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.