Interface ImageSet

Hierarchy

ImageSet

Index

Methods

Methods

getDescription

getDescription(): undefined | string

Returns undefined | string
The image set description.

getDisplayName

getDisplayName(): string

Returns string
The image set display name.

getFileName

getFileName(): string

Returns string
The image set file name.

getId

getId(): string

Returns string
The image set id.

getLocale

getLocale(): undefined | string

Returns undefined | string
The image set locale.

getName

getName(): string

Returns string
The image name.

getOriginal

getOriginal(): undefined | Image

Returns undefined | Image
The original image.

getThumbnail

getThumbnail(): undefined | Image

Returns undefined | Image
The thumbnail.

getVariant

getVariant(variant: string): undefined | Image

Parameters
- variant: string
  
  The variant name.
Returns undefined | Image
The image variant, or undefined if it doesn't exist.

getVariants

getVariants(variants?: string[]): Record<string, Image>

Parameters
- Optional variants: string[]
  
  Optional array of variant names to retrieve. If not provided, returns all variants.
Returns Record<string, Image>
A map of variant names to Image objects.