Edit

Share via

IThumbnailImage interface

  • Reference
Package:
@microsoft/sp-property-pane

Note

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.

Options related to image thumbnail.

Properties

altText

Alt text for the image.
backupImageUrl

Optional backup image URL if the original image URL fails to load.
imageFit

How the image should fit.
imageUrl

URL pointing to the image.
type

Image type.

Property Details

altText

Note

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.

Alt text for the image.

altText: string;

Property Value

string

backupImageUrl

Note

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.

Optional backup image URL if the original image URL fails to load.

backupImageUrl: string | undefined;

Property Value

string | undefined

imageFit

Note

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.

How the image should fit.

imageFit: ImageFit | undefined;

Property Value

ImageFit | undefined

imageUrl

Note

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.

URL pointing to the image.

imageUrl: string;

Property Value

string

type

Note

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.

Image type.

type: typeof ThumbnailType.Image;

Property Value

typeof @microsoft/sp-property-pane!~__type#Image:member