ImageTransformDto (Imageserver Client Module 6.1.0.RELEASE API)

java.lang.Object
- com.foreach.imageserver.dto.ImageTransformDto

```
public class ImageTransformDto
extends Object
```
Represents a single transformation that can be done on an image. A transform can be written to and converted from a single line string which can easily be used in URLs. A transform string has the form of PARAM_VALUE,PARAM_VALUE
The following parameters are supported:
- scene: setScene(Integer)
- w: setWidth(Integer)
- h: setHeight(Integer)
- ar: setAspectRatio(AspectRatio)
- maxw: setMaxWidth(Integer)
- maxh: setMaxHeight(Integer)
- dpi: setDpi(Integer)
- cx: set crop x coordinate
- cy: set crop y coordinate
- cw: set crop width
- ch: set crop height
- csw: set the assumed width of the source image for the crop coordinates
- csh: set the assumed height of the source image for the crop coordinates
- cbw: set the width of the box that contained the source image for the crop coordinates
- cbh: set the height of the box that contained the source image for the crop coordinates
- color: setColorSpace(ColorSpaceDto)
- bg: setBackgroundColor(ColorDto)
- alpha: setAlphaColor(ColorDto)
- q: setQuality(Integer)
- o: output type of the transform result, extension of supported ImageTypeDto, see setOutputType(ImageTypeDto)
Since:

5.0.0

Author:

Arne Vandamme

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImageTransformDto.ImageTransformDtoBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImageTransformDto.ImageTransformDtoBuilder`

Constructor Summary

Constructors
Constructor and Description

ImageTransformDto()

Constructors
Constructor and Description
`ImageTransformDto()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImageTransformDto.ImageTransformDtoBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`static ImageTransformDto`	`from(@NonNull String transformString)` Parse a string into the transform it represents.
`ColorDto`	`getAlphaColor()` Color specification of a color that should be made transparent.
`AspectRatio`	`getAspectRatio()` The aspect ratio that the resulting image should have.
`ColorDto`	`getBackgroundColor()` Color specification for the background of the image.
`ColorSpaceDto`	`getColorSpace()` Color space for the resulting image, can for example be used to convert to grayscale.
`CropDto`	`getCrop()` Contains the settings for the crop that should be taken from the original image.
`Integer`	`getDpi()` DPI that should be used for processing the image (and in the resulting output image).
`Integer`	`getHeight()` The height in pixels of the resulting image.
`Integer`	`getMaxHeight()` Maximum height of the resulting image.
`Integer`	`getMaxWidth()` Maximum width of the resulting image.
`ImageTypeDto`	`getOutputType()` The output type for this transform.
`Integer`	`getQuality()` Quality for the created image, relevant for lossy image formats like JPEG.
`Integer`	`getScene()` The specific scene of the source image that should be transformed.
`Integer`	`getWidth()` The width in pixels of the resulting image.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`void`	`setAlphaColor(ColorDto alphaColor)` Color specification of a color that should be made transparent.
`void`	`setAspectRatio(AspectRatio aspectRatio)` The aspect ratio that the resulting image should have.
`void`	`setBackgroundColor(ColorDto backgroundColor)` Color specification for the background of the image.
`void`	`setColorSpace(ColorSpaceDto colorSpace)` Color space for the resulting image, can for example be used to convert to grayscale.
`void`	`setCrop(CropDto crop)` Contains the settings for the crop that should be taken from the original image.
`void`	`setDpi(Integer dpi)` DPI that should be used for processing the image (and in the resulting output image).
`void`	`setHeight(Integer height)` The height in pixels of the resulting image.
`void`	`setMaxHeight(Integer maxHeight)` Maximum height of the resulting image.
`void`	`setMaxWidth(Integer maxWidth)` Maximum width of the resulting image.
`void`	`setOutputType(ImageTypeDto outputType)` The output type for this transform.
`void`	`setQuality(Integer quality)` Quality for the created image, relevant for lossy image formats like JPEG.
`void`	`setScene(Integer scene)` The specific scene of the source image that should be transformed.
`void`	`setWidth(Integer width)` The width in pixels of the resulting image.
`ImageTransformDto.ImageTransformDtoBuilder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImageTransformDto
```
public ImageTransformDto()
```
- Method Detail
  - from
```
public static ImageTransformDto from(@NonNull
                                     @NonNull String transformString)
```
    Parse a string into the transform it represents.
    
    Parameters:
    
    transformString - version
    
    Returns:
    
    transform
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isEmpty
```
public boolean isEmpty()
```
  - builder
```
public static ImageTransformDto.ImageTransformDtoBuilder builder()
```
  - toBuilder
```
public ImageTransformDto.ImageTransformDtoBuilder toBuilder()
```
  - getScene
```
public Integer getScene()
```
    The specific scene of the source image that should be transformed. Only relevant for multi-scene formats like PDF where a scene corresponds to a page in the PDF. If not specified, the output type will determine if either the entire original image or a specific scene will be used. 0-based.
  - getWidth
```
public Integer getWidth()
```
    The width in pixels of the resulting image. If both width and height are not specified, the original image width will be assumed. If height is specified but width is not, a width will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if width is not specified.
  - getHeight
```
public Integer getHeight()
```
    The height in pixels of the resulting image. If both width and height are not specified, the original image height will be assumed. If width is specified but height is not, a height will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if height is not specified.
  - getMaxWidth
```
public Integer getMaxWidth()
```
    Maximum width of the resulting image. Regardless of width, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
  - getMaxHeight
```
public Integer getMaxHeight()
```
    Maximum height of the resulting image. Regardless of height, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
  - getAspectRatio
```
public AspectRatio getAspectRatio()
```
    The aspect ratio that the resulting image should have. If both width and height are specified, this parameter will be ignored. If either width or height is specified, the aspect ratio will be used to calculate the other dimension accordingly. If neither width and height is specified, the actual width and height will be calculated by looking at the original image dimensions and using them to get the largest possible values matching the requested aspect ratio.
  - getDpi
```
public Integer getDpi()
```
    DPI that should be used for processing the image (and in the resulting output image). A higher DPI will result in larger output files but with much more detail. Equivalent of ImageModificationDto.getDensity() which will most likely be deprecated in the future.
  - getCrop
```
public CropDto getCrop()
```
    Contains the settings for the crop that should be taken from the original image. If not specified, no cropping will be applied and the entire original image will be used as the base.
  - getQuality
```
public Integer getQuality()
```
    Quality for the created image, relevant for lossy image formats like JPEG. Should be percentage represented as a value between 1 and 100. If not specified, the default quality configured on the application will be used.
  - getBackgroundColor
```
public ColorDto getBackgroundColor()
```
    Color specification for the background of the image. Any alpha channel will be changed to this color. If you want to replace an existing color instead, you can combine with setAlphaColor(ColorDto).
  - getAlphaColor
```
public ColorDto getAlphaColor()
```
    Color specification of a color that should be made transparent. Only hex value without the leading # is supported.
  - getColorSpace
```
public ColorSpaceDto getColorSpace()
```
    Color space for the resulting image, can for example be used to convert to grayscale.
  - getOutputType
```
public ImageTypeDto getOutputType()
```
    The output type for this transform.
  - setScene
```
public void setScene(Integer scene)
```
    The specific scene of the source image that should be transformed. Only relevant for multi-scene formats like PDF where a scene corresponds to a page in the PDF. If not specified, the output type will determine if either the entire original image or a specific scene will be used. 0-based.
  - setWidth
```
public void setWidth(Integer width)
```
    The width in pixels of the resulting image. If both width and height are not specified, the original image width will be assumed. If height is specified but width is not, a width will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if width is not specified.
  - setHeight
```
public void setHeight(Integer height)
```
    The height in pixels of the resulting image. If both width and height are not specified, the original image height will be assumed. If width is specified but height is not, a height will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if height is not specified.
  - setMaxWidth
```
public void setMaxWidth(Integer maxWidth)
```
    Maximum width of the resulting image. Regardless of width, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
  - setMaxHeight
```
public void setMaxHeight(Integer maxHeight)
```
    Maximum height of the resulting image. Regardless of height, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
  - setAspectRatio
```
public void setAspectRatio(AspectRatio aspectRatio)
```
    The aspect ratio that the resulting image should have. If both width and height are specified, this parameter will be ignored. If either width or height is specified, the aspect ratio will be used to calculate the other dimension accordingly. If neither width and height is specified, the actual width and height will be calculated by looking at the original image dimensions and using them to get the largest possible values matching the requested aspect ratio.
  - setDpi
```
public void setDpi(Integer dpi)
```
    DPI that should be used for processing the image (and in the resulting output image). A higher DPI will result in larger output files but with much more detail. Equivalent of ImageModificationDto.getDensity() which will most likely be deprecated in the future.
  - setCrop
```
public void setCrop(CropDto crop)
```
    Contains the settings for the crop that should be taken from the original image. If not specified, no cropping will be applied and the entire original image will be used as the base.
  - setQuality
```
public void setQuality(Integer quality)
```
    Quality for the created image, relevant for lossy image formats like JPEG. Should be percentage represented as a value between 1 and 100. If not specified, the default quality configured on the application will be used.
  - setBackgroundColor
```
public void setBackgroundColor(ColorDto backgroundColor)
```
    Color specification for the background of the image. Any alpha channel will be changed to this color. If you want to replace an existing color instead, you can combine with setAlphaColor(ColorDto).
  - setAlphaColor
```
public void setAlphaColor(ColorDto alphaColor)
```
    Color specification of a color that should be made transparent. Only hex value without the leading # is supported.
  - setColorSpace
```
public void setColorSpace(ColorSpaceDto colorSpace)
```
    Color space for the resulting image, can for example be used to convert to grayscale.
  - setOutputType
```
public void setOutputType(ImageTypeDto outputType)
```
    The output type for this transform.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ImageTransformDto

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageTransformDto

Method Detail

from

toString

isEmpty

builder

toBuilder

getScene

getWidth

getHeight

getMaxWidth

getMaxHeight

getAspectRatio

getDpi

getCrop

getQuality

getBackgroundColor

getAlphaColor

getColorSpace

getOutputType

setScene

setWidth

setHeight

setMaxWidth

setMaxHeight

setAspectRatio

setDpi

setCrop

setQuality

setBackgroundColor

setAlphaColor

setColorSpace

setOutputType

equals

canEqual

hashCode