Skip to main content

Interface: ImageWidgetImage

Represents an image in the image library.

This interface provides information about an image that has been uploaded to the library and can be applied to image upload widgets.

Properties​

fileName​

fileName: string

Original filename of the uploaded image. Useful for displaying to users and for identification purposes.

height?​

optional height: number

Original height of the image in pixels. Used for scaling and quality calculations.

imageId​

imageId: string

Unique identifier for this image.

isConvertedFile?​

optional isConvertedFile: boolean

If true, this image was converted from a vector file format. Vector files (like SVG) are automatically converted to raster formats for use as textures.

isLoading​

isLoading: boolean

If true, the image is currently in a loading state. Used to display loading indicators in the UI while the image is being processed.

s3Path?​

optional s3Path: string

Relative path to the image in storage. This path can be used to construct the full URL for displaying the image.

validate?​

optional validate: boolean

Validation flag (deprecated).

Deprecated​

width?​

optional width: number

Original width of the image in pixels. Used for scaling and quality calculations.