Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 6.63 KB

GenerateAPI.md

File metadata and controls

101 lines (72 loc) · 6.63 KB

barcode\GenerateAPI

All URIs are relative to https://api.aspose.cloud/v4.0

Method HTTP request Description
Generate Get /barcode/generate/{barcodeType} Generate barcode using GET request with parameters in route and query string.
GenerateBody Post /barcode/generate-body Generate barcode using POST request with parameters in body in json or xml format.
GenerateMultipart Post /barcode/generate-multipart Generate barcode using POST request with parameters in multipart form.

Generate

*os.File Generate(ctx, barcodeType, data, optional) Generate barcode using GET request with parameters in route and query string.

Generate Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
barcodeType EncodeBarcodeType Type of barcode to generate.
data string String represents data to encode
optional *GenerateAPIGenerateOpts optional parameters nil if no parameters

Generate Optional Parameters

Optional parameters are passed through a pointer to a GenerateAPIGenerateOpts struct

Name Type Description Notes
DataType optional.Interface of EncodeDataType Type of data to encode. Default value: StringData.
ImageFormat optional.Interface of BarcodeImageFormat Barcode output image format. Default value: png
TextLocation optional.Interface of CodeLocation Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below.
ForegroundColor optional. Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. [default to "Black"]
BackgroundColor optional. Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. [default to "White"]
Units optional.Interface of GraphicsUnit Common Units for all measuring in query. Default units: pixel.
Resolution optional. Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
ImageHeight optional. Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
ImageWidth optional. Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
RotationAngle optional. 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.

Generate Return type

byte[]

[Back to API list] [Back to Model list] [Back to README]

GenerateBody

*os.File GenerateBody(ctx, generateParams) Generate barcode using POST request with parameters in body in json or xml format.

GenerateBody Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
generateParams GenerateParams Parameters of generation

GenerateBody Return type

byte[]

[Back to API list] [Back to Model list] [Back to README]

GenerateMultipart

*os.File GenerateMultipart(ctx, barcodeType, data, optional) Generate barcode using POST request with parameters in multipart form.

GenerateMultipart Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
barcodeType EncodeBarcodeType
data string String represents data to encode
optional *GenerateAPIGenerateMultipartOpts optional parameters nil if no parameters

GenerateMultipart Optional Parameters

Optional parameters are passed through a pointer to a GenerateAPIGenerateMultipartOpts struct

Name Type Description Notes
DataType optional.Interface of EncodeDataType
ImageFormat optional.Interface of BarcodeImageFormat
TextLocation optional.Interface of CodeLocation
ForegroundColor optional. Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. [default to "Black"]
BackgroundColor optional. Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. [default to "White"]
Units optional.Interface of GraphicsUnit
Resolution optional. Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
ImageHeight optional. Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
ImageWidth optional. Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
RotationAngle optional. 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.

GenerateMultipart Return type

byte[]

[Back to API list] [Back to Model list] [Back to README]