java.lang.Object
- net.webpdf.wsclient.openapi.OperationWatermarkPosition

```
public class OperationWatermarkPosition
extends Object
```
Used to set the position of the watermark in the PDF document.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationWatermarkPosition.MetricsEnum`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
`static class`	`OperationWatermarkPosition.PositionEnum`	Uses one of multiple preset positions in order to position the watermark on the page

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ASPECT_RATIO`
`static String`	`JSON_PROPERTY_HEIGHT`
`static String`	`JSON_PROPERTY_METRICS`
`static String`	`JSON_PROPERTY_POSITION`
`static String`	`JSON_PROPERTY_WIDTH`
`static String`	`JSON_PROPERTY_X`
`static String`	`JSON_PROPERTY_Y`

Constructor Summary

Constructors
Constructor Description

OperationWatermarkPosition()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationWatermarkPosition`	`aspectRatio(Boolean aspectRatio)`
`boolean`	`equals(Object o)`
`@Nullable Boolean`	`getAspectRatio()`	Forces the aspect ratio to be maintained when a watermark is scaled if \"width\" and \"height\" are specified.
`@Nullable Integer`	`getHeight()`	Forces the specified height for the watermark if the values are not equal 0.
`@Nullable OperationWatermarkPosition.MetricsEnum`	`getMetrics()`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
`@Nullable OperationWatermarkPosition.PositionEnum`	`getPosition()`	Uses one of multiple preset positions in order to position the watermark on the page
`@Nullable Integer`	`getWidth()`	Forces the specified width for the watermark if the values are not equal 0.
`@Nullable Integer`	`getX()`	Used to define the X-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to \"custom
`@Nullable Integer`	`getY()`	Used to define the Y-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to \"custom
`int`	`hashCode()`
`OperationWatermarkPosition`	`height(Integer height)`
`OperationWatermarkPosition`	`metrics(OperationWatermarkPosition.MetricsEnum metrics)`
`OperationWatermarkPosition`	`position(OperationWatermarkPosition.PositionEnum position)`
`void`	`setAspectRatio(Boolean aspectRatio)`
`void`	`setHeight(Integer height)`
`void`	`setMetrics(OperationWatermarkPosition.MetricsEnum metrics)`
`void`	`setPosition(OperationWatermarkPosition.PositionEnum position)`
`void`	`setWidth(Integer width)`
`void`	`setX(Integer x)`
`void`	`setY(Integer y)`
`String`	`toString()`
`OperationWatermarkPosition`	`width(Integer width)`
`OperationWatermarkPosition`	`x(Integer x)`
`OperationWatermarkPosition`	`y(Integer y)`

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

- Field Detail
  - JSON_PROPERTY_ASPECT_RATIO
```
public static final String JSON_PROPERTY_ASPECT_RATIO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEIGHT
```
public static final String JSON_PROPERTY_HEIGHT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METRICS
```
public static final String JSON_PROPERTY_METRICS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POSITION
```
public static final String JSON_PROPERTY_POSITION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WIDTH
```
public static final String JSON_PROPERTY_WIDTH
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_X
```
public static final String JSON_PROPERTY_X
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_Y
```
public static final String JSON_PROPERTY_Y
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationWatermarkPosition
```
public OperationWatermarkPosition()
```
- Method Detail
  - aspectRatio
```
public OperationWatermarkPosition aspectRatio(Boolean aspectRatio)
```
  - getAspectRatio
```
@Nullable
public @Nullable Boolean getAspectRatio()
```
    Forces the aspect ratio to be maintained when a watermark is scaled if \"width\" and \"height\" are specified.
    
    Returns:
    
    aspectRatio
  - setAspectRatio
```
public void setAspectRatio(Boolean aspectRatio)
```
  - height
```
public OperationWatermarkPosition height(Integer height)
```
  - getHeight
```
@Nullable
public @Nullable Integer getHeight()
```
    Forces the specified height for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to \"aspectRatio\" as well) minimum: 0
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(Integer height)
```
  - metrics
```
public OperationWatermarkPosition metrics(OperationWatermarkPosition.MetricsEnum metrics)
```
  - getMetrics
```
@Nullable
public @Nullable OperationWatermarkPosition.MetricsEnum getMetrics()
```
    Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
    
    Returns:
    
    metrics
  - setMetrics
```
public void setMetrics(OperationWatermarkPosition.MetricsEnum metrics)
```
  - position
```
public OperationWatermarkPosition position(OperationWatermarkPosition.PositionEnum position)
```
  - getPosition
```
@Nullable
public @Nullable OperationWatermarkPosition.PositionEnum getPosition()
```
    Uses one of multiple preset positions in order to position the watermark on the page. * custom = Disable the use of a preset position. * top\\_left = Positions the watermark in the upper left corner. * top\\_center = Positions the watermark in the centre at the top margin. * top\\_right = Positions the watermark in the top right corner. * center\\_left = Positions the watermark at the centre of the page, to the left. * center\\_center = Positions the watermark at the centre of the page. * center\\_right = Positions the watermark at the centre of the page, to the right. * bottom\\_left = Positions the watermark in the bottom left corner. * bottom\\_center = Positions the watermark in the centre at the bottom margin. * bottom\\_right = Positions the watermark in the bottom right corner.
    
    Returns:
    
    position
  - setPosition
```
public void setPosition(OperationWatermarkPosition.PositionEnum position)
```
  - width
```
public OperationWatermarkPosition width(Integer width)
```
  - getWidth
```
@Nullable
public @Nullable Integer getWidth()
```
    Forces the specified width for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to \"aspectRatio\" as well) minimum: 0
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(Integer width)
```
  - x
```
public OperationWatermarkPosition x(Integer x)
```
  - getX
```
@Nullable
public @Nullable Integer getX()
```
    Used to define the X-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to \"custom.\". If \"position is set to a different value, these arguments will be interpreted as \"offsets\" from the selected position. This specification applies for both the text and image output. minimum: 0
    
    Returns:
    
    x
  - setX
```
public void setX(Integer x)
```
  - y
```
public OperationWatermarkPosition y(Integer y)
```
  - getY
```
@Nullable
public @Nullable Integer getY()
```
    Used to define the Y-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to \"custom.\". If \"position is set to a different value, these arguments will be interpreted as \"offsets\" from the selected position. This specification applies for both the text and image output. minimum: 0
    
    Returns:
    
    y
  - setY
```
public void setY(Integer y)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OperationWatermarkPosition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ASPECT_RATIO

JSON_PROPERTY_HEIGHT

JSON_PROPERTY_METRICS

JSON_PROPERTY_POSITION

JSON_PROPERTY_WIDTH

JSON_PROPERTY_X

JSON_PROPERTY_Y

Constructor Detail

OperationWatermarkPosition

Method Detail

aspectRatio

getAspectRatio

setAspectRatio

height

getHeight

setHeight

metrics

getMetrics

setMetrics

position

getPosition

setPosition

width

getWidth

setWidth

x

getX

setX

y

getY

setY

equals

hashCode

toString