sp image helper.imagehelper.converttoimageurl

Home > @microsoft/sp-image-helper > ImageHelper > convertToImageUrl

ImageHelper.convertToImageUrl() method

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Convert a url to a file or page on SharePoint into an optimized image url.

Signature:

static convertToImageUrl(request: IImageHelperRequest): string;

Parameters

Parameter	Type	Description
request	IImageHelperRequest	IImageHelperRequest for the bundled parameters.

Returns:

string

A full url string for the image of the file. If no optimized url can be created (i.e. an external url or an unsupported file type), the original sourceUrl is returned.

Remarks

• If width and height are provided, then the resulting image will be scaled to the minimum of the width or height. - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization.