Skip to content

Commit 96aa1f3

Browse files
Denis-AverinDenis-Averin
committed
Update documentation
1 parent dd536c0 commit 96aa1f3

File tree

8 files changed

+57
-54
lines changed

8 files changed

+57
-54
lines changed

‎docs/BarcodeApi.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Method | HTTP request | Description
1515

1616
## getBarcodeGenerate
1717

18-
> File getBarcodeGenerate(type, text, twoDDisplayText, textLocation, textAlignment, textColor, fontSizeMode, noWrap, resolution, resolutionX, resolutionY, dimensionX, textSpace, units, sizeMode, barHeight, imageHeight, imageWidth, rotationAngle, backColor, barColor, borderColor, borderWidth, borderDashStyle, borderVisible, enableChecksum, enableEscape, filledBars, alwaysShowChecksum, wideNarrowRatio, validateText, supplementData, supplementSpace, barWidthReduction, useAntiAlias, format)
18+
> File getBarcodeGenerate(type, text, twoDDisplayText, textLocation, textAlignment, textColor, noWrap, resolution, resolutionX, resolutionY, dimensionX, textSpace, units, sizeMode, barHeight, imageHeight, imageWidth, rotationAngle, backColor, barColor, borderColor, borderWidth, borderDashStyle, borderVisible, enableChecksum, enableEscape, filledBars, alwaysShowChecksum, wideNarrowRatio, validateText, supplementData, supplementSpace, barWidthReduction, useAntiAlias, format)
1919
2020
Generate barcode.
2121

@@ -61,8 +61,7 @@ Name | Type | Description | Notes
6161
**twoDDisplayText** | **String**| Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional]
6262
**textLocation** | **String**| Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] [enum: Below, Above, None]
6363
**textAlignment** | **String**| Text alignment. | [optional] [enum: Left, Center, Right]
64-
**textColor** | **String**| Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
65-
**fontSizeMode** | **String**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional] [enum: Auto, Manual]
64+
**textColor** | **String**| Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
6665
**noWrap** | **Boolean**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
6766
**resolution** | **Double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
6867
**resolutionX** | **Double**| DEPRECATED: Use 'Resolution' instead. | [optional]
@@ -75,9 +74,9 @@ Name | Type | Description | Notes
7574
**imageHeight** | **Double**| Height of the barcode image in given units. Default units: pixel. | [optional]
7675
**imageWidth** | **Double**| Width of the barcode image in given units. Default units: pixel. | [optional]
7776
**rotationAngle** | **Double**| BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional]
78-
**backColor** | **String**| Background color of the barcode image. Default value: Color.White. | [optional]
79-
**barColor** | **String**| Bars color. Default value: Color.Black. | [optional]
80-
**borderColor** | **String**| Border color. Default value: Color.Black. | [optional]
77+
**backColor** | **String**| Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
78+
**barColor** | **String**| Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
79+
**borderColor** | **String**| Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
8180
**borderWidth** | **Double**| Border width. Default value: 0. Ignored if Visible is set to false. | [optional]
8281
**borderDashStyle** | **String**| Border dash style. Default value: BorderDashStyle.Solid. | [optional] [enum: Solid, Dash, Dot, DashDot, DashDotDot]
8382
**borderVisible** | **Boolean**| Border visibility. If false than parameter Width is always ignored (0). Default value: false. | [optional]
@@ -318,7 +317,7 @@ Name | Type | Description | Notes
318317

319318
## putBarcodeGenerateFile
320319

321-
> ResultImageInfo putBarcodeGenerateFile(name, type, text, twoDDisplayText, textLocation, textAlignment, textColor, fontSizeMode, noWrap, resolution, resolutionX, resolutionY, dimensionX, textSpace, units, sizeMode, barHeight, imageHeight, imageWidth, rotationAngle, backColor, barColor, borderColor, borderWidth, borderDashStyle, borderVisible, enableChecksum, enableEscape, filledBars, alwaysShowChecksum, wideNarrowRatio, validateText, supplementData, supplementSpace, barWidthReduction, useAntiAlias, storage, folder, format)
320+
> ResultImageInfo putBarcodeGenerateFile(name, type, text, twoDDisplayText, textLocation, textAlignment, textColor, noWrap, resolution, resolutionX, resolutionY, dimensionX, textSpace, units, sizeMode, barHeight, imageHeight, imageWidth, rotationAngle, backColor, barColor, borderColor, borderWidth, borderDashStyle, borderVisible, enableChecksum, enableEscape, filledBars, alwaysShowChecksum, wideNarrowRatio, validateText, supplementData, supplementSpace, barWidthReduction, useAntiAlias, storage, folder, format)
322321
323322
Generate barcode and save on server (from query params or from file with json or xml content)
324323

@@ -366,8 +365,7 @@ Name | Type | Description | Notes
366365
**twoDDisplayText** | **String**| Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional]
367366
**textLocation** | **String**| Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] [enum: Below, Above, None]
368367
**textAlignment** | **String**| Text alignment. | [optional] [enum: Left, Center, Right]
369-
**textColor** | **String**| Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
370-
**fontSizeMode** | **String**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional] [enum: Auto, Manual]
368+
**textColor** | **String**| Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
371369
**noWrap** | **Boolean**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
372370
**resolution** | **Double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
373371
**resolutionX** | **Double**| DEPRECATED: Use 'Resolution' instead. | [optional]
@@ -380,9 +378,9 @@ Name | Type | Description | Notes
380378
**imageHeight** | **Double**| Height of the barcode image in given units. Default units: pixel. | [optional]
381379
**imageWidth** | **Double**| Width of the barcode image in given units. Default units: pixel. | [optional]
382380
**rotationAngle** | **Double**| BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional]
383-
**backColor** | **String**| Background color of the barcode image. Default value: Color.White. | [optional]
384-
**barColor** | **String**| Bars color. Default value: Color.Black. | [optional]
385-
**borderColor** | **String**| Border color. Default value: Color.Black. | [optional]
381+
**backColor** | **String**| Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
382+
**barColor** | **String**| Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
383+
**borderColor** | **String**| Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
386384
**borderWidth** | **Double**| Border width. Default value: 0. Ignored if Visible is set to false. | [optional]
387385
**borderDashStyle** | **String**| Border dash style. Default value: BorderDashStyle.Solid. | [optional] [enum: Solid, Dash, Dot, DashDot, DashDotDot]
388386
**borderVisible** | **Boolean**| Border visibility. If false than parameter Width is always ignored (0). Default value: false. | [optional]

‎docs/CaptionParams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**text** | **String** | Caption text. | [optional]
88
**alignment** | [**TextAlignment**](TextAlignment.md) | Text alignment. | [optional]
9-
**color** | **String** | Text color. | [optional]
9+
**color** | **String** | Text color. Default value: black Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
1010
**visible** | **Boolean** | Is caption visible. | [optional]
1111
**font** | [**FontParams**](FontParams.md) | Font. | [optional]
1212
**padding** | [**Padding**](Padding.md) | Padding. | [optional]

‎docs/GeneratorParams.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**twoDDisplayText** | **String** | Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional]
1010
**textLocation** | [**CodeLocation**](CodeLocation.md) | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional]
1111
**textAlignment** | [**TextAlignment**](TextAlignment.md) | Text alignment. | [optional]
12-
**textColor** | **String** | Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
12+
**textColor** | **String** | Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
1313
**font** | [**FontParams**](FontParams.md) | Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto. | [optional]
1414
**fontSizeMode** | [**FontMode**](FontMode.md) | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
1515
**noWrap** | **Boolean** | Specify word wraps (line breaks) within text. Default value: false. | [optional]
@@ -27,9 +27,9 @@ Name | Type | Description | Notes
2727
**padding** | [**Padding**](Padding.md) | Barcode paddings. Default value: 5pt 5pt 5pt 5pt. | [optional]
2828
**captionAbove** | [**CaptionParams**](CaptionParams.md) | Additional caption above barcode. | [optional]
2929
**captionBelow** | [**CaptionParams**](CaptionParams.md) | Additional caption below barcode. | [optional]
30-
**backColor** | **String** | Background color of the barcode image. Default value: Color.White. | [optional]
31-
**barColor** | **String** | Bars color. Default value: Color.Black. | [optional]
32-
**borderColor** | **String** | Border color. Default value: Color.Black. | [optional]
30+
**backColor** | **String** | Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
31+
**barColor** | **String** | Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
32+
**borderColor** | **String** | Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional]
3333
**borderWidth** | **Double** | Border width. Default value: 0. Ignored if Visible is set to false. | [optional]
3434
**borderDashStyle** | [**BorderDashStyle**](BorderDashStyle.md) | Border dash style. Default value: BorderDashStyle.Solid. | [optional]
3535
**borderVisible** | **Boolean** | Border visibility. If false than parameter Width is always ignored (0). Default value: false. | [optional]
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
5858
**postal** | [**PostalParams**](PostalParams.md) | Postal params. | [optional]
5959
**QR** | [**QrParams**](QrParams.md) | QR params. | [optional]
6060
**patchCode** | [**PatchCodeParams**](PatchCodeParams.md) | PatchCode params. | [optional]
61-
**code128** | [**Code128Params**](Code128Params.md) | Code128 params. | [optional]
61+
**code128** | [**Code128Params**](Code128Params.md) | Code128 parameters | [optional]
6262
**hanXin** | [**HanXinParams**](HanXinParams.md) | HanXin params. | [optional]
6363

6464

‎src/main/java/com/aspose/barcode/cloud/api/BarcodeApi.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,6 @@ protected com.squareup.okhttp.Call getBarcodeGenerateCall(
100100
queryParams.addAll(apiClient.parameterToPair("TextColor", request.textColor));
101101
}
102102

103-
if (request.fontSizeMode != null) {
104-
queryParams.addAll(apiClient.parameterToPair("FontSizeMode", request.fontSizeMode));
105-
}
106-
107103
if (request.noWrap != null) {
108104
queryParams.addAll(apiClient.parameterToPair("NoWrap", request.noWrap));
109105
}
@@ -1300,10 +1296,6 @@ protected com.squareup.okhttp.Call putBarcodeGenerateFileCall(
13001296
queryParams.addAll(apiClient.parameterToPair("TextColor", request.textColor));
13011297
}
13021298

1303-
if (request.fontSizeMode != null) {
1304-
queryParams.addAll(apiClient.parameterToPair("FontSizeMode", request.fontSizeMode));
1305-
}
1306-
13071299
if (request.noWrap != null) {
13081300
queryParams.addAll(apiClient.parameterToPair("NoWrap", request.noWrap));
13091301
}

‎src/main/java/com/aspose/barcode/cloud/model/CaptionParams.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ public void setAlignment(TextAlignment alignment) {
6060
}
6161

6262
/**
63-
* Text color.
63+
* Text color. Default value: black Use named colors like: red, green, blue Or HTML colors like:
64+
* #FF0000, #00FF00, #0000FF
6465
*
6566
* @return color
6667
*/

‎src/main/java/com/aspose/barcode/cloud/model/GeneratorParams.java

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,8 @@ public void setTextAlignment(TextAlignment textAlignment) {
251251
}
252252

253253
/**
254-
* Specify the displaying CodeText's Color. Default value: Color.Black.
254+
* Specify the displaying CodeText's Color. Default value: black. Use named colors like:
255+
* red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
255256
*
256257
* @return textColor
257258
*/
@@ -514,7 +515,8 @@ public void setCaptionBelow(CaptionParams captionBelow) {
514515
}
515516

516517
/**
517-
* Background color of the barcode image. Default value: Color.White.
518+
* Background color of the barcode image. Default value: white. Use named colors like: red,
519+
* green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
518520
*
519521
* @return backColor
520522
*/
@@ -528,7 +530,8 @@ public void setBackColor(String backColor) {
528530
}
529531

530532
/**
531-
* Bars color. Default value: Color.Black.
533+
* Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors
534+
* like: #FF0000, #00FF00, #0000FF
532535
*
533536
* @return barColor
534537
*/
@@ -542,7 +545,8 @@ public void setBarColor(String barColor) {
542545
}
543546

544547
/**
545-
* Border color. Default value: Color.Black.
548+
* Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors
549+
* like: #FF0000, #00FF00, #0000FF
546550
*
547551
* @return borderColor
548552
*/
@@ -965,7 +969,7 @@ public void setPatchCode(PatchCodeParams patchCode) {
965969
}
966970

967971
/**
968-
* Code128 params.
972+
* Code128 parameters
969973
*
970974
* @return code128
971975
*/

‎src/main/java/com/aspose/barcode/cloud/requests/GetBarcodeGenerateRequest.java

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,11 @@ public class GetBarcodeGenerateRequest {
4848
/** Text alignment.. */
4949
public String textAlignment;
5050

51-
/** Specify the displaying CodeText's Color. Default value: Color.Black.. */
52-
public String textColor;
53-
5451
/**
55-
* Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated
56-
* automatically based on xDimension value. It is recommended to use FontSizeMode.Auto
57-
* especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value:
58-
* FontSizeMode.Auto..
52+
* Specify the displaying CodeText's Color. Default value: black. Use named colors like: red,
53+
* green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF.
5954
*/
60-
public String fontSizeMode;
55+
public String textColor;
6156

6257
/** Specify word wraps (line breaks) within text. Default value: false.. */
6358
public Boolean noWrap;
@@ -108,13 +103,22 @@ public class GetBarcodeGenerateRequest {
108103
*/
109104
public Double rotationAngle;
110105

111-
/** Background color of the barcode image. Default value: Color.White.. */
106+
/**
107+
* Background color of the barcode image. Default value: white. Use named colors like: red,
108+
* green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF.
109+
*/
112110
public String backColor;
113111

114-
/** Bars color. Default value: Color.Black.. */
112+
/**
113+
* Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors
114+
* like: #FF0000, #00FF00, #0000FF.
115+
*/
115116
public String barColor;
116117

117-
/** Border color. Default value: Color.Black.. */
118+
/**
119+
* Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors
120+
* like: #FF0000, #00FF00, #0000FF.
121+
*/
118122
public String borderColor;
119123

120124
/** Border width. Default value: 0. Ignored if Visible is set to false.. */

‎src/main/java/com/aspose/barcode/cloud/requests/PutBarcodeGenerateFileRequest.java

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,11 @@ public class PutBarcodeGenerateFileRequest {
5151
/** Text alignment.. */
5252
public String textAlignment;
5353

54-
/** Specify the displaying CodeText's Color. Default value: Color.Black.. */
55-
public String textColor;
56-
5754
/**
58-
* Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated
59-
* automatically based on xDimension value. It is recommended to use FontSizeMode.Auto
60-
* especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value:
61-
* FontSizeMode.Auto..
55+
* Specify the displaying CodeText's Color. Default value: black. Use named colors like: red,
56+
* green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF.
6257
*/
63-
public String fontSizeMode;
58+
public String textColor;
6459

6560
/** Specify word wraps (line breaks) within text. Default value: false.. */
6661
public Boolean noWrap;
@@ -111,13 +106,22 @@ public class PutBarcodeGenerateFileRequest {
111106
*/
112107
public Double rotationAngle;
113108

114-
/** Background color of the barcode image. Default value: Color.White.. */
109+
/**
110+
* Background color of the barcode image. Default value: white. Use named colors like: red,
111+
* green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF.
112+
*/
115113
public String backColor;
116114

117-
/** Bars color. Default value: Color.Black.. */
115+
/**
116+
* Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors
117+
* like: #FF0000, #00FF00, #0000FF.
118+
*/
118119
public String barColor;
119120

120-
/** Border color. Default value: Color.Black.. */
121+
/**
122+
* Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors
123+
* like: #FF0000, #00FF00, #0000FF.
124+
*/
121125
public String borderColor;
122126

123127
/** Border width. Default value: 0. Ignored if Visible is set to false.. */

0 commit comments

Comments
 (0)