Interface Image

The Image interface represents an image that is passed to sips as argument. It can be obtained through Configuration.images.

interface Image {
    aspectRatio: number;
    name: string;
    properties: Readonly<ImageProperties>;
    size: Size;
    getProperty<T extends keyof ImageProperties>(name: T): ImageProperties[T];
    scaledSizeWithLongestEdge(longestEdge: number): Size;
    setProperty<T extends keyof ImageProperties>(
        name: T,
        value: ImageProperties[T],
    ): void;
    sizeToFitLongestEdge(longestEdge: number): Size;
}

Index

Properties

aspectRatio name properties size

Methods

getProperty scaledSizeWithLongestEdge setProperty sizeToFitLongestEdge

Properties

`Readonly`aspectRatio

aspectRatio: number

Aspect ratio of image.

`Readonly`name

name: string

Name of image.

`Readonly`properties

properties: Readonly<ImageProperties>

Image properties.

`Readonly`size

size: Size

Size of image (pixels).

Methods

getProperty

getProperty<T extends keyof ImageProperties>(name: T): ImageProperties[T]
Return the image property for name, if any.
Type Parameters
- T extends keyof ImageProperties
Parameters
- name: T
  Name of the image property.
Returns ImageProperties[T]
- Value of the property associated with name.

scaledSizeWithLongestEdge

scaledSizeWithLongestEdge(longestEdge: number): Size
Return the rectangle size whose longer side equals to the specified length. Maintains aspect ratio.
Parameters
- longestEdge: number
  Pixel size of the longest edge.
Returns Size
- Calculated size that fits the square whose size has the specified length.

setProperty

setProperty<T extends keyof ImageProperties>(
name: T,
value: ImageProperties[T],
): void
Set the image property for name to value.
Type Parameters
- T extends keyof ImageProperties
Parameters
- name: T
  Name of the image property.
- value: ImageProperties[T]
  Value of the property associated with name.
Returns void

sizeToFitLongestEdge

sizeToFitLongestEdge(longestEdge: number): Size
Return the size that will contain the image with the longest edge set to length. Maintains aspect ratio.
Parameters
- longestEdge: number
  Pisel size of the longest edge.
Returns Size
- Calculated size that fits the square whose size has the specified length.