ThumbnailProps Interface

Describes a thumbnail image for an IModel or ViewDefinition.

see IModelDb.Views.getThumbnail or IModelConnection.Views.getThumbnail to obtain a thumbnail for a view.

see IModelDb.Views.saveThumbnail or IModelConnection.Views.saveThumbnail to save a thumbnail for a view.

Extends

Properties

Name Type Description
image Uint8Array The image encoded as specified by ThumbnailFormatProps.format.  

Inherited properties

Name Type Inherited from Description
format "jpeg" | "png" ThumbnailFormatProps Encoding of the image
height number ThumbnailFormatProps Y size of image, in pixels.
width number ThumbnailFormatProps X size of the image, in pixels.

Defined in

Last Updated: 12 June, 2024