Package net.webpdf.wsclient.openapi
Class OperationSvg
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationSvg
-
public class OperationSvg extends Object
Defines a target SVG image format.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationSvg.GraphicsStateModeEnumSelects the SVG syntax used for formatting graphics statesstatic classOperationSvg.MetricsEnumUnit 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 = Inchesstatic classOperationSvg.PathDrawModeEnumSelects the SVG syntax used for formatting paths
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_DECIMAL_PRECISIONstatic StringJSON_PROPERTY_DPIstatic StringJSON_PROPERTY_GRAPHICS_STATE_MODEstatic StringJSON_PROPERTY_HEIGHTstatic StringJSON_PROPERTY_METRICSstatic StringJSON_PROPERTY_PATH_DRAW_MODEstatic StringJSON_PROPERTY_WIDTH
-
Constructor Summary
Constructors Constructor Description OperationSvg()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationSvgdecimalPrecision(Integer decimalPrecision)OperationSvgdpi(Integer dpi)booleanequals(Object o)@Nullable IntegergetDecimalPrecision()Selects the number of decimal places for numeric values of the resulting SVG.@Nullable IntegergetDpi()This parameter is used to define the image's DPI resolution.@Nullable OperationSvg.GraphicsStateModeEnumgetGraphicsStateMode()Selects the SVG syntax used for formatting graphics states@Nullable IntegergetHeight()Used to limit the maximum height of the exported image. 0 = No restriction minimum: 0@Nullable OperationSvg.MetricsEnumgetMetrics()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 OperationSvg.PathDrawModeEnumgetPathDrawMode()Selects the SVG syntax used for formatting paths@Nullable IntegergetWidth()Used to limit the maximum width of the exported image. 0 = No restriction minimum: 0OperationSvggraphicsStateMode(OperationSvg.GraphicsStateModeEnum graphicsStateMode)inthashCode()OperationSvgheight(Integer height)OperationSvgmetrics(OperationSvg.MetricsEnum metrics)OperationSvgpathDrawMode(OperationSvg.PathDrawModeEnum pathDrawMode)voidsetDecimalPrecision(Integer decimalPrecision)voidsetDpi(Integer dpi)voidsetGraphicsStateMode(OperationSvg.GraphicsStateModeEnum graphicsStateMode)voidsetHeight(Integer height)voidsetMetrics(OperationSvg.MetricsEnum metrics)voidsetPathDrawMode(OperationSvg.PathDrawModeEnum pathDrawMode)voidsetWidth(Integer width)StringtoString()OperationSvgwidth(Integer width)
-
-
-
Field Detail
-
JSON_PROPERTY_DECIMAL_PRECISION
public static final String JSON_PROPERTY_DECIMAL_PRECISION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DPI
public static final String JSON_PROPERTY_DPI
- See Also:
- Constant Field Values
-
JSON_PROPERTY_GRAPHICS_STATE_MODE
public static final String JSON_PROPERTY_GRAPHICS_STATE_MODE
- 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_PATH_DRAW_MODE
public static final String JSON_PROPERTY_PATH_DRAW_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WIDTH
public static final String JSON_PROPERTY_WIDTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
decimalPrecision
public OperationSvg decimalPrecision(Integer decimalPrecision)
-
getDecimalPrecision
@Nullable public @Nullable Integer getDecimalPrecision()
Selects the number of decimal places for numeric values of the resulting SVG. **Important:** The number of decimal places directly influences the size of the resulting file. However: Higher values will result in a better SVG quality. minimum: 0 maximum: 10- Returns:
- decimalPrecision
-
setDecimalPrecision
public void setDecimalPrecision(Integer decimalPrecision)
-
dpi
public OperationSvg dpi(Integer dpi)
-
getDpi
@Nullable public @Nullable Integer getDpi()
This parameter is used to define the image's DPI resolution. The larger the value, the larger the image's x, y resolution. In addition, the larger the DPI resolution, the larger the size of the image file. minimum: 0 maximum: 9600- Returns:
- dpi
-
setDpi
public void setDpi(Integer dpi)
-
graphicsStateMode
public OperationSvg graphicsStateMode(OperationSvg.GraphicsStateModeEnum graphicsStateMode)
-
getGraphicsStateMode
@Nullable public @Nullable OperationSvg.GraphicsStateModeEnum getGraphicsStateMode()
Selects the SVG syntax used for formatting graphics states. * verbose = Writes verbose graphics states and groups and always prefers direct path definitions. * centralize = Writes compact graphics states and groups and centralizes formatting instructions, also utilizes the \"use\" syntax to prepare and reference indirect paths. (May not be readable by some SVG viewers.)- Returns:
- graphicsStateMode
-
setGraphicsStateMode
public void setGraphicsStateMode(OperationSvg.GraphicsStateModeEnum graphicsStateMode)
-
height
public OperationSvg height(Integer height)
-
getHeight
@Nullable public @Nullable Integer getHeight()
Used to limit the maximum height of the exported image. 0 = No restriction minimum: 0- Returns:
- height
-
setHeight
public void setHeight(Integer height)
-
metrics
public OperationSvg metrics(OperationSvg.MetricsEnum metrics)
-
getMetrics
@Nullable public @Nullable OperationSvg.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(OperationSvg.MetricsEnum metrics)
-
pathDrawMode
public OperationSvg pathDrawMode(OperationSvg.PathDrawModeEnum pathDrawMode)
-
getPathDrawMode
@Nullable public @Nullable OperationSvg.PathDrawModeEnum getPathDrawMode()
Selects the SVG syntax used for formatting paths. * verbose = Writes verbose paths, containing a human readable complete and simple syntax. * compress = Compresses path draw instructions, by applying the EBNF (Extended Backus Naur Form).- Returns:
- pathDrawMode
-
setPathDrawMode
public void setPathDrawMode(OperationSvg.PathDrawModeEnum pathDrawMode)
-
width
public OperationSvg width(Integer width)
-
getWidth
@Nullable public @Nullable Integer getWidth()
Used to limit the maximum width of the exported image. 0 = No restriction minimum: 0- Returns:
- width
-
setWidth
public void setWidth(Integer width)
-
-