StorageImageFile

Класс-обёртка для удобной работы с идентификаторами-хешами файлов изображений, загруженных в медиа-хранилище.

Экземплярами класса StorageImageFile представлены runtime-значения полей heap-таблиц, объявленных через Heap.ImageFile и Heap.File (только для файлов изображений). Также может быть использован для удобной работы с загруженными файлами изображений вне контекста хипа.

Применение/сигнатура

import { StorageImageFile } from '@app/storage'
const file = new StorageImageFile(hash)

Свойства и методы

Все свойства базового класса StorageFile (только type всегда возвращает image) + ...

getThumbnailUrl(width?: number, height?: number): string

• Возвращает абсолютный URL миниатюры изображения с учётом заданных размеров.

  • Если оба размера не заданы, то используется оригинальный размер изображения.
  • Если задан один из размеров, второй подбирается автоматически в соответствии с оригинальной пропорцией.
  • Если заданы оба размера, то миниатюра обрезается в соответствие с правилом "cover" - изображение обрезается с обоих сторон либо по вертикали либо по горизонтали в зависимости от пропорций.

• width: number | undefined
  ширина требуемой миниатюры в пикселях

• height: number | undefined
  высота требуемой миниатюры в пикселях

getThumbnailSrc(width?: number, height?: number): { url, width?, height? }

• Возвращает объект с абсолютным URL и размерами миниатюры изображения в формате, принимаемым свойством src блока image с учётом заданных размеров.

• Если оба размера не заданы, то используется оригинальный размер изображения.

• Если задан один из размеров, второй подбирается автоматически в соответствии с оригинальной пропорцией.

• Если заданы оба размера, то миниатюра обрезается в соответствие с правилом "cover" - изображение обрезается с обоих сторон либо по вертикали либо по горизонтали в зависимости от пропорций.

• width: number | undefined
  ширина требуемой миниатюры в пикселях

• height: number | undefined
  высота требуемой миниатюры в пикселях

width: number
"Строгая" ширина изображения в пикселях, определяется из свойства hash. Если по какой-либо причине ширина не может быть определена, то при обращении будет брошено соответствующее исключение.

widthMaybe: number | undefined
"Нестрогая" ширина изображения в пикселях, определяется из свойства hash. Возвращает undefined, если по какой-либо причине ширина не может быть определена.

height: number
"Строгая" высота изображения в пикселях, определяется из свойства hash. Если по какой-либо причине высота не может быть определена, то при обращении будет брошено соответствующее исключение.

heightMaybe: number | undefined
"Нестрогая" высота изображения в пикселях, определяется из свойства hash. Возвращает undefined, если по какой-либо причине высота не может быть определена.

sizes: { width: number, height: number }
"Строгие" размеры изображения в пикселях, определяются из свойства hash. Если по какой-либо причине размеры не могут быть определены, то при обращении будет брошено соответствующее исключение.

sizesMaybe: { width: number, height: number } | undefined
"Нестрогие" размеры изображения в пикселях, определяются из свойства hash. Возвращает undefined, если по какой-либо причине размеры не могут быть определены.